Juxtapose 1.0.0-dev-027

Juxtapose

1. Intro

基于 SourceGenerator 的硬编码 .Net 多进程运行库。

2. Features

• 可以为类型、接口、静态类生成代理，无需手动编写RPC相关代码，即可进行多进程开发；
• 编译时生成所有代码，运行时无显式的反射调用和动态构造；
• 支持委托和CancellationToken类型的方法参数（其余类型未特殊处理，将会进行序列化，目前回调委托不支持嵌套和CancellationToken）；
• 支持Linux、Windows（其它未测试）；

注意事项

• 目前参数不支持定义为父类型，实际传递子类型，序列化时将会按照定义的类型进行序列化和反序列化，会导致具体类型丢失；
• 目前所有的参数都不应该在方法完成后进行保留，CancellationToken等在方法完成后会被释放；

3. Requirement

• .Net5.0+(其它版本没有尝试过)

4. 使用方法

4.1 引用包

<ItemGroup>
  <PackageReference Include="Juxtapose" Version="1.0.*-*" />
  <PackageReference Include="Juxtapose.SourceGenerator" Version="1.0.*-*" />
</ItemGroup>

4.2 建立上下文

4.2.1 创建上下文类型，并使用 [Illusion] 特性指定要生成的类型

[Illusion(typeof(Greeter), typeof(IGreeter), "Juxtapose.Test.GreeterAsIGreeterIllusion")]
public partial class GreeterJuxtaposeContext : JuxtaposeContext
{
}

示例代码将为Greeter生成IGreeter接口的代理类型Juxtapose.Test.GreeterAsIGreeterIllusion；

Note!!!

• 必须继承JuxtaposeContext；
• 必须标记partial关键字；

4.2.2 [Illusion] 的多种用法

• 直接为类型生成代理，如下示例生成 Juxtapose.Test.GreeterIllusion 类型，且不继承接口（静态类型相同用法）

[Illusion(typeof(Greeter))]

• 为类型生成代理，并继承指定接口，如下示例生成 Juxtapose.Test.GreeterAsIGreeterIllusion 类型且继承IGreeter接口

[Illusion(typeof(Greeter), typeof(IGreeter))]

• 生成类型，并指定类型名称，如下示例生成 Juxtapose.Test.HelloGreeter 类型

[Illusion(typeof(Greeter), generatedTypeName: "Juxtapose.Test.HelloGreeter")]

• 生成从IoC容器获取的接口代理类型，如下示例生成 Juxtapose.Test.IGreeterIllusionFromIoCContainer 类型（此时Context类需要实现IIoCContainerProvider接口，并提供有效的IServiceProvider）

[Illusion(typeof(IGreeterFromServiceProvider), generatedTypeName: "Juxtapose.Test.IGreeterIllusionFromIoCContainer", fromIoCContainer: true)]

4.3 添加入口点

在Main方法中添加入口点代码，并使用指定上下文

await JuxtaposeEntryPoint.TryAsEndpointAsync(args, GreeterJuxtaposeContext.SharedInstance);

到此已完成开发，创建类型Juxtapose.Test.GreeterAsIGreeterIllusion的对象，并调用其方法，其实际逻辑将在子进程中运行；

5. 调试子进程（Windows&&VisualStudio Only）

5.1 引用调试包

在Host项目文件中添加包引用

<ItemGroup Condition="'$(Configuration)' == 'Debug'">
  <PackageReference Include="Juxtapose.VsDebugger" Version="1.0.*-*" />
</ItemGroup>

建议和示例代码一样，添加条件引用，只在Debug环境下引用调试包

5.2 添加入口点

在Main方法中添加调试入口点代码

JuxtaposeDebuggerAttacher.TryAttachToParent(args);

在代码中打上断点，运行时将会正确命中断点（只在 VisualStudio2022 17.0.5 && Win11 21TH2 中进行了测试，理论上是通用）

6. 工作逻辑

SourceGenerator在编译时生成代理类型，封装通信消息。默认使用命名管道进行进程间通信，使用System.Text.Json进行消息的序列化与反序列化。

6.1 关键词列表

更多功能细节参见示例代码

示例列表