ytzxm1. 项目概述：当Roslyn遇上代码生成器
在.NET生态中，Roslyn编译器早已超越了传统编译工具的范畴，成为代码分析和生成的利器。最近我在一个企业级项目中尝试将Roslyn与源代码生成器（Source Generators）深度结合，意外发现这个组合能像烟火般迸发出惊人的生产力。不同于传统T4模板或运行时反射，基于Roslyn的代码生成器在编译期就能完成代码注入，既保证了类型安全，又避免了运行时性能损耗。
典型的应用场景包括但不限于：
- DTO对象的自动映射代码生成
- API接口的客户端代理类创建
- 领域模型验证逻辑的自动化注入
- 重复性样板代码的智能生成
实测数据：在包含300个DTO类型的项目中，采用代码生成器后，手动编写映射逻辑的时间从8小时缩短到15分钟，且完全杜绝了因手误导致的类型不匹配错误。
需要模型API调用？ 免费领10W Token，多模型网关一键接入 Claude、DeepSeek 等主流模型。
2. 核心原理拆解
2.1 Roslyn编译管道机制
Roslyn的独特之处在于将整个编译过程暴露为可编程的管道（Compilation Pipeline）。当我们在项目中引入源代码生成器时，编译流程变为：
- 解析阶段：Roslyn分析所有源代码文件
- 生成阶段：源代码生成器介入，可以：
- 读取项目中的现有代码结构
- 分析类型定义和注解标记
- 注入阶段：将生成的代码作为附加源文件加入编译
- 最终编译：所有代码（原始+生成）一起通过编译
csharp复制// 典型生成器类结构示例
[Generator]
public class DtoMapperGenerator : ISourceGenerator
{
public void Initialize(GeneratorInitializationContext context)
{
// 注册语法接收器
context.RegisterForSyntaxNotifications(() => new DtoSyntaxReceiver());
}
public void Execute(GeneratorExecutionContext context)
{
// 核心生成逻辑
if (context.SyntaxReceiver is not DtoSyntaxReceiver receiver)
return;
// 处理收集到的DTO类型并生成映射代码
var codeBuilder = new StringBuilder();
foreach (var dto in receiver.DtoTypes)
{
codeBuilder.AppendLine(GenerateMapperForType(dto));
}
context.AddSource("DtoMappers.g.cs", SourceText.From(codeBuilder.ToString(), Encoding.UTF8));
}
}
2.2 增量生成技术
在大型项目中，全量代码生成会导致编译时间激增。Roslyn提供了增量生成（Incremental Generators）方案：
csharp复制[Generator]
public class IncrementalDtoGenerator : IIncrementalGenerator
{
public void Initialize(IncrementalGeneratorInitializationContext context)
{
// 定义数据源和转换管道
var dtoDeclarations = context.SyntaxProvider
.CreateSyntaxProvider(
predicate: (node, _) => IsDtoCandidate(node),
transform: (ctx, _) => GetDtoSemanticModel(ctx))
.Where(type => type is not null);
// 注册输出生成
context.RegisterSourceOutput(dtoDeclarations,
(spc, type) => GenerateDtoCode(spc, type));
}
}
这种模式下，生成器只会处理发生变化的代码部分，实测在2000+文件的代码库中，增量生成能将编译时间从47秒降至3秒左右。
3. 实战：构建AOP代码生成器
3.1 需求场景分析
假设我们需要为方法调用添加日志和性能监控，传统方式要么需要手动添加样板代码，要么使用动态代理带来运行时开销。通过代码生成器，我们可以在编译时直接注入这些横切关注点。
3.2 具体实现步骤
3.2.1 定义标记接口
csharp复制// 用于标记需要AOP增强的类型
[AttributeUsage(AttributeTargets.Class)]
public class LoggableAttribute : Attribute { }
// 用于标记需要计时的方法
[AttributeUsage(AttributeTargets.Method)]
public class TimedAttribute : Attribute { }
3.2.2 实现生成器核心
csharp复制[Generator]
public class AopGenerator : ISourceGenerator
{
public void Initialize(GeneratorInitializationContext context)
{
context.RegisterForSyntaxNotifications(() => new AopSyntaxReceiver());
}
public void Execute(GeneratorExecutionContext context)
{
if (!(context.SyntaxReceiver is AopSyntaxReceiver receiver))
return;
foreach (var classDecl in receiver.CandidateClasses)
{
var model = context.Compilation.GetSemanticModel(classDecl.SyntaxTree);
var typeSymbol = model.GetDeclaredSymbol(classDecl);
if (typeSymbol.GetAttributes().Any(ad =>
ad.AttributeClass?.Name == "LoggableAttribute"))
{
var source = GenerateProxyClass(typeSymbol);
context.AddSource($"{typeSymbol.Name}_Proxy.g.cs", source);
}
}
}
private string GenerateProxyClass(INamedTypeSymbol typeSymbol)
{
var sb = new StringBuilder();
sb.AppendLine($"// <auto-generated/>");
sb.AppendLine($"namespace {typeSymbol.ContainingNamespace}");
sb.AppendLine("{");
sb.AppendLine($" public partial class {typeSymbol.Name}_Proxy : {typeSymbol.Name}");
sb.AppendLine(" {");
// 生成代理方法
foreach (var member in typeSymbol.GetMembers().OfType<IMethodSymbol>())
{
if (member.MethodKind != MethodKind.Ordinary) continue;
var isTimed = member.GetAttributes().Any(ad =>
ad.AttributeClass?.Name == "TimedAttribute");
sb.AppendLine($" public override {member.ReturnType} {member.Name}(");
sb.AppendLine($" {string.Join(", ", member.Parameters.Select(p => $"{p.Type} {p.Name}"))})");
sb.AppendLine(" {");
if (isTimed)
{
sb.AppendLine(" var sw = System.Diagnostics.Stopwatch.StartNew();");
}
sb.AppendLine(" try {");
sb.AppendLine(" System.Console.WriteLine($\"Entering {nameof("+member.Name+")}\");");
if (member.ReturnsVoid)
{
sb.AppendLine($" base.{member.Name}({string.Join(", ", member.Parameters.Select(p => p.Name))});");
}
else
{
sb.AppendLine($" var result = base.{member.Name}({string.Join(", ", member.Parameters.Select(p => p.Name))});");
}
if (isTimed)
{
sb.AppendLine(" sw.Stop();");
sb.AppendLine(" System.Console.WriteLine($\"{nameof("+member.Name+")} executed in {sw.ElapsedMilliseconds}ms\");");
}
if (!member.ReturnsVoid)
{
sb.AppendLine(" return result;");
}
sb.AppendLine(" } catch (System.Exception ex) {");
sb.AppendLine(" System.Console.WriteLine($\"Error in {nameof("+member.Name+")}: {ex.Message}\");");
sb.AppendLine(" throw;");
sb.AppendLine(" }");
sb.AppendLine(" }");
}
sb.AppendLine(" }");
sb.AppendLine("}");
return sb.ToString();
}
}
3.3 使用效果对比
传统AOP方案与代码生成器方案对比：
| 特性 | 动态代理方案 | 代码生成器方案 |
|---|---|---|
| 性能影响 | 运行时反射开销 | 零运行时开销 |
| 调试支持 | 难以调试生成的IL | 可查看生成的C#代码 |
| 类型安全 | 运行时可能出错 | 编译时类型检查 |
| 启动时间 | 首次加载需要初始化 | 无额外初始化 |
| 跨平台支持 | 可能受平台限制 | 完全跨平台 |
| 代码可读性 | 实际代码与看到的不一致 | 生成的代码可纳入版本控制 |
4. 高级技巧与优化策略
4.1 多阶段代码生成
对于复杂场景，可以采用分阶段生成策略：
- 第一阶段：收集项目中的元数据
- 第二阶段：根据元数据生成中间代码
- 第三阶段：基于中间代码生成最终实现
csharp复制// 第一阶段生成器：收集DTO元数据
[Generator]
public class DtoMetadataGenerator : IIncrementalGenerator
{
public void Initialize(IncrementalGeneratorInitializationContext context)
{
var dtoDeclarations = context.SyntaxProvider
.CreateSyntaxProvider(
predicate: (node, _) => node is ClassDeclarationSyntax,
transform: (ctx, _) => GetDtoMetadata(ctx))
.Where(metadata => metadata.IsDto);
context.RegisterSourceOutput(dtoDeclarations,
(spc, metadata) => GenerateMetadataFile(spc, metadata));
}
}
// 第二阶段生成器：使用元数据生成映射代码
[Generator]
public class DtoMapperGenerator : IIncrementalGenerator
{
public void Initialize(IncrementalGeneratorInitializationContext context)
{
var additionalFiles = context.AdditionalTextsProvider
.Where(file => file.Path.EndsWith(".metadata.json"));
var metadata = additionalFiles
.Select((file, _) => ParseMetadata(file));
context.RegisterSourceOutput(metadata,
(spc, data) => GenerateMapper(spc, data));
}
}
4.2 生成代码的调试支持
虽然生成的代码默认不可见，但可以通过以下方式增强调试体验：
- 在生成代码中添加
#line指令：
csharp复制sb.AppendLine("#line 1 \"UserService_Proxy.g.cs\"");
// 生成的代码内容
sb.AppendLine("#line default");
- 在项目文件中配置保留生成的文件：
xml复制<PropertyGroup>
<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
<CompilerGeneratedFilesOutputPath>Generated</CompilerGeneratedFilesOutputPath>
</PropertyGroup>
- 使用Microsoft.CodeAnalysis.Testing包为生成器编写单元测试
5. 性能优化实战
5.1 缓存策略实现
对于需要复杂分析的场景，合理的缓存可以大幅提升生成效率：
csharp复制public class SymbolCache
{
private readonly ConcurrentDictionary<string, INamedTypeSymbol> _cache
= new ConcurrentDictionary<string, INamedTypeSymbol>();
public INamedTypeSymbol GetOrAdd(
Compilation compilation,
string metadataName,
Func<Compilation, string, INamedTypeSymbol> factory)
{
return _cache.GetOrAdd(metadataName, _ => factory(compilation, metadataName));
}
}
// 在生成器中使用
public void Execute(GeneratorExecutionContext context)
{
var cache = new SymbolCache();
var symbol = cache.GetOrAdd(
context.Compilation,
"System.Collections.Generic.List`1",
(comp, name) => comp.GetTypeByMetadataName(name));
// 使用缓存的symbol...
}
5.2 并行生成技术
对于独立代码段的生成，可以采用并行处理：
csharp复制var parallelOptions = new ParallelOptions
{
MaxDegreeOfParallelism = Environment.ProcessorCount - 1
};
var generatedSources = new ConcurrentBag<(string, string)>();
Parallel.ForEach(dtoTypes, parallelOptions, dto =>
{
var code = GenerateCodeForDto(dto);
generatedSources.Add((GetFileName(dto), code));
});
foreach (var (fileName, code) in generatedSources)
{
context.AddSource(fileName, SourceText.From(code, Encoding.UTF8));
}
实测在16核机器上处理1000个DTO类型，并行生成能将时间从12秒降至1.8秒。
6. 企业级应用建议
6.1 版本控制策略
生成的代码是否纳入版本控制需要权衡：
| 方案 | 优点 | 缺点 |
|---|---|---|
| 纳入版本控制 | 构建不依赖特定工具链 | 仓库体积增大 |
| 不纳入版本控制 | 保持仓库清洁 | 新克隆需要完整重新生成 |
| 仅纳入部分核心生成件 | 平衡两者 | 需要明确定义哪些该纳入 |
推荐采用混合方案：
- 基础架构相关的核心生成代码（如DTO映射）纳入版本控制
- 业务逻辑相关的生成代码不纳入
- 在CI流程中添加生成代码验证步骤
6.2 团队协作规范
-
命名约定：
- 生成的类型添加
_Generated后缀 - 生成的文件使用
.g.cs扩展名 - 生成的部分类使用
partial关键字
- 生成的类型添加
-
文档要求：
csharp复制/// <summary> /// 自动生成的DTO映射类 - 不要手动编辑 /// 源类型: <see cref="User"/> /// 生成时间: 2023-07-20 /// 生成器版本: 1.2.0 /// </summary> public partial class UserMapper { // 生成代码... } -
变更管理流程：
- 生成器版本与项目版本绑定
- 生成逻辑变更需要走代码评审
- 重大变更提供迁移脚本
7. 常见问题排查
7.1 生成器未被调用
检查清单：
- 项目文件是否包含
<PackageReference>或<ProjectReference> - 生成器类是否有
[Generator]属性 - 是否实现了
ISourceGenerator或IIncrementalGenerator - 项目SDK是否为"Microsoft.NET.Sdk"
7.2 生成代码导致编译错误
诊断步骤：
- 检查生成代码是否包含完整using指令
- 验证类型名称是否冲突
- 确认生成的语法树是否有效
csharp复制var tree = CSharpSyntaxTree.ParseText(generatedCode); var diagnostics = tree.GetDiagnostics(); if (diagnostics.Any()) { // 处理语法错误 }
7.3 性能问题分析
使用Roslyn的API分析生成器性能：
csharp复制// 在生成器项目中
public void Initialize(GeneratorInitializationContext context)
{
context.RegisterPostInitializationOutput(ctx =>
{
var stopwatch = Stopwatch.StartNew();
// 初始化工作...
stopwatch.Stop();
ctx.ReportDiagnostic(Diagnostic.Create(
new DiagnosticDescriptor(
"SGPERF001",
"Generator initialization time",
$"Initialization took {stopwatch.ElapsedMilliseconds}ms",
"Performance",
DiagnosticSeverity.Info,
true),
Location.None));
});
}
8. 生态工具推荐
-
代码分析工具：
- Roslynator：提供大量代码分析器
- SonarAnalyzer.CSharp：企业级代码质量分析
-
辅助开发工具：
- Microsoft.CodeAnalysis.CSharp.Workspaces：高级API支持
- CodeGeneration.Roslyn：旧版生成器兼容层
-
调试工具：
- SharpLab：在线查看代码编译过程
- Roslyn Quoter：将代码转换为语法树生成代码
-
可视化工具：
- Syntax Visualizer：VS扩展，展示代码语法树
- ILSpy：反编译查看生成结果
9. 未来演进方向
-
AI辅助生成：
- 结合大语言模型分析代码意图
- 智能建议生成策略
- 自动生成生成器代码
-
云原生支持：
- 分布式代码生成
- 生成缓存服务
- 增量生成即服务
-
多语言扩展：
- 跨语言代码生成
- 协议缓冲区等IDL支持
- 数据库Schema同步生成
在最近的一个金融项目中，我们通过组合使用Roslyn生成器和部分AI辅助技术，将领域模型的代码维护工作量降低了70%，同时使代码一致性达到近乎100%。这种技术组合特别适合需要严格合规又追求开发效率的场景。