Source Generator实战

Posted 2022-04-20 dotNET跨平台

前言

最近刷B站的时候浏览到了老杨的关于Source Generator的简介视频。其实当初.Net 6刚发布时候看到过微软介绍这个东西，但并没有在意。因为粗看觉得这东西限制蛮多的，毕竟C#是强类型语言，有些动态的东西不好操作，而且又有Fody、Natasha这些操作IL的库。

最近写前端比较多，看到这个和这个，都是自动引入相关包，极大的提高了我开发前端的舒适度。又联想到隔壁Java的有Lombok，用起来都很香。搜了一下也没看到C#有相关的东西，于是决定自己动手开发一个，提高C#开发体验。

实现一个Source Generator

这里不对Source Generator做基本的使用介绍，直接实操。如果需要了解相关信息，建议直接看官方文档或者去搜索相关文章。

首先我们看一下效果，假如我的代码是

namespace SourceGenerator.Demo

    public partial class UserClass
    
        [Property]
        private string _test;
    

那么，最终生成的应该是

// Auto-generated code
namespace SourceGenerator.Demo

    public partial class UserClass
    
        public string Test  get => _test; set => _test = value; 
    

我们按最简单的实现来考虑，那么只需要

1. 在语法树中找到field

2. 找到字段的class、namespace

3. 生成代码

第一步

首先我们来看第一步。第一步需要找到field，这个我们借助Attribute的特性，能够很快的找到，在SourceGenerator中只需要判断一下Attribute的名字即可
定义一个SyntaxReciver，然后在SourceGenerator中注册一下

// file: PropertyAttribute.cs
using System;

namespace SourceGenerator.Common

    [AttributeUsage(AttributeTargets.Field)]
    public class PropertyAttribute : Attribute
    
        public const string Name = "Property";
    

// file: AutoPropertyReceiver.cs
public class AutoPropertyReceiver : ISyntaxReceiver

    public List<AttributeSyntax> AttributeSyntaxList  get;  = new List<AttributeSyntax>();

    public void OnVisitSyntaxNode(SyntaxNode syntaxNode)
    
        if (syntaxNode is AttributeSyntax cds && cds.Name is IdentifierNameSyntax identifierName &&
            (
                identifierName.Identifier.ValueText == PropertyAttribute.Name ||
                identifierName.Identifier.ValueText == nameof(PropertyAttribute))
           )
        
            AttributeSyntaxList.Add(cds);
        
    


// file: AutoPropertyGenerator.cs
[Generator]
public class AutoPropertyGenerator : ISourceGenerator

    public void Initialize(GeneratorInitializationContext context)
    
        context.RegisterForSyntaxNotifications(() => new AutoPropertyReceiver());
    

    // other code
    ...

第二步

第二步就是SyntaxTree的查找，熟悉SyncaxTree的话比较容易完成

public void Execute(GeneratorExecutionContext context)

    var syntaxReceiver = (AutoPropertyReceiver)context.SyntaxReceiver;
    var attributeSyntaxList = syntaxReceiver.AttributeSyntaxList;

    if (attributeSyntaxList.Count == 0)
    
        return;
    

    // 保存一下类名，因为一个类中可能有有多个字段生成，这里去掉重复
    var classList = new List<string>();
    foreach (var attributeSyntax in attributeSyntaxList)
    
        // 找到class，并且判断一下是否有parital字段
        var classDeclarationSyntax = attributeSyntax.FirstAncestorOrSelf<ClassDeclarationSyntax>();
        if (classDeclarationSyntax == null ||
            !classDeclarationSyntax.Modifiers.Any(m => m.IsKind(SyntaxKind.PartialKeyword)))
        
            continue;
        

        // 找到namespace
        var namespaceDeclarationSyntax =
            classDeclarationSyntax.FirstAncestorOrSelf<BaseNamespaceDeclarationSyntax>();

        if (classList.Contains(classDeclarationSyntax.Identifier.ValueText))
        
            continue;
        

        // 找到field
        var fieldDeclarationList = classDeclarationSyntax.Members.OfType<FieldDeclarationSyntax>().ToList();
        if (fieldDeclarationList.Count == 0)
        
            continue;
        
        // 其他代码
        ...
    

第三步

第三步就是简单粗暴的根据第二步中拿到的信息，拼一下字符串。

当然其实拼字符串是很不好的行为，最好是用模板去实现，其次就算是拼字符串也理应用StringBuilder，但这里只是做一个Demo，无所谓了

public void Execute(GeneratorExecutionContext context)

        ...
        // 上面是第二步的代码
        // 拼源代码字符串
        var source = $@"// Auto-generated code

namespace namespaceDeclarationSyntax.Name.ToString()

public partial class classDeclarationSyntax.Identifier
";
        var propertyStr = "";
        foreach (var fieldDeclaration in fieldDeclarationList)
        
            var variableDeclaratorSyntax = fieldDeclaration.Declaration.Variables.FirstOrDefault();

            var fieldName = variableDeclaratorSyntax.Identifier.ValueText;
            var propertyName = GetCamelCase(fieldName);

            propertyStr += $@"
public string propertyName  get => fieldName; set => fieldName = value; ";
        

        source += propertyStr;
        source += @"


";
        // 添加到源代码，这样IDE才能感知
        context.AddSource($"classDeclarationSyntax.Identifier.g.cs", source);
        // 保存一下类名，避免重复生成
        classList.Add(classDeclarationSyntax.Identifier.ValueText);
    

使用

写一个测试类

using SourceGenerator.Common;

namespace SourceGenerator.Demo;

public partial class UserClass

    [Property] private string _test = "test";

    [Property] private string _test2;

然后重启IDE，可以看到效果，并且直接调用属性是不报错的

结尾

这里仅演示了最基本的Source Generator的功能，限于篇幅也无法深入讲解，上面的代码可以在这里：https://github.com/Weilence/SourceGenerator/查看，目前最新的代码还实现了字段生成构造函数，appsettings.json生成AppSettings常量字段类。

如果你只是想使用，可以直接nuget安装SourceGenerator.Library。

以下为个人观点

Source Generator在我看来最大的价值在于提供开发时的体验。至于性能，可以用Fody等库Emit IL代码，功能更强大更完善，且没有分部类的限制。但此类IL库最大的问题在Design-Time时无法拿到生成后的代码，导致需要用一些奇奇怪怪的方法去用生成代码。

Source Generator未来可以做的事情有很多，比如

1. ORM实体映射
   如果数据库是Code First，那么其实还好。但如果说是Db First，主流的ORM库都是通过命令去生成Model的，但命令通常我记不住，因为用的频率并不高。
   如果后期加字段，要么我重新生成一次，我又得去找这个命令。要么我手动去C#代码中加这个字段，我能保证自己可以写正确，但是团队其他成员呢？

2. 结合Emit IL技术
   上面其实说了Emit是无法在Design-Time中使用的，但如果我们使用Source Generator创建一些空的方法，然后用IL去改写，应该可以解决这个问题

3. 依赖注入
   目前而言我们在Asp.net Core中创建了服务，那么我们需要AddSingleton等方法添加进去，这个其实很痛苦，因为首先会显得代码很长，其次这个操作很无聊且容易遗漏。
   现在主流的框架都是通过Assembly扫描的方式去动态注册，避免手动去添加服务。但如果通过Source Generator扫码这些类，就可以在编译时添加进DI容器

4. 对象映射
   Java里面有个库叫做MapStruct，原理是用maven插件生成静态的java代码，然后按字段赋值。C#里面我好像没有看到这种方法，目前我用过的Automapper和Tinymapper都是先去做Bind，然后再使用。（插个题外话，Tinymapper以前的版本是不需要Bind，直接用的，但后来就要了，似乎是为了解决多线程的问题）
   Bind其实很痛苦，我很讨厌写这种样板代码，以至于我根本就不想用这类Mapper，直接Json Copy。