学生成绩管理系统网站建设,做招聘网站的背景图片,股权融资,十堰网站网站建设前言最近刷B站的时候浏览到了老杨的关于Source Generator的简介视频。其实当初.Net 6刚发布时候看到过微软介绍这个东西#xff0c;但并没有在意。因为粗看觉得这东西限制蛮多的#xff0c;毕竟C#是强类型语言#xff0c;有些动态的东西不好操作#xff0c;而且又有Fody、N… 前言最近刷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; }}
}我们按最简单的实现来考虑那么只需要在语法树中找到field找到字段的class、namespace生成代码第一步首先我们来看第一步。第一步需要找到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 ListAttributeSyntax AttributeSyntaxList { get; } new ListAttributeSyntax();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 Liststring();foreach (var attributeSyntax in attributeSyntaxList){// 找到class并且判断一下是否有parital字段var classDeclarationSyntax attributeSyntax.FirstAncestorOrSelfClassDeclarationSyntax();if (classDeclarationSyntax null ||!classDeclarationSyntax.Modifiers.Any(m m.IsKind(SyntaxKind.PartialKeyword))){continue;}// 找到namespacevar namespaceDeclarationSyntax classDeclarationSyntax.FirstAncestorOrSelfBaseNamespaceDeclarationSyntax();if (classList.Contains(classDeclarationSyntax.Identifier.ValueText)){continue;}// 找到fieldvar fieldDeclarationList classDeclarationSyntax.Members.OfTypeFieldDeclarationSyntax().ToList();if (fieldDeclarationList.Count 0){continue;}// 其他代码...}
}第三步第三步就是简单粗暴的根据第二步中拿到的信息拼一下字符串。当然其实拼字符串是很不好的行为最好是用模板去实现其次就算是拼字符串也理应用StringBuilder但这里只是做一个Demo无所谓了public void Execute(GeneratorExecutionContext context)
{...// 上面是第二步的代码// 拼源代码字符串var source $// Auto-generated codenamespace {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未来可以做的事情有很多比如ORM实体映射如果数据库是Code First那么其实还好。但如果说是Db First主流的ORM库都是通过命令去生成Model的但命令通常我记不住因为用的频率并不高。如果后期加字段要么我重新生成一次我又得去找这个命令。要么我手动去C#代码中加这个字段我能保证自己可以写正确但是团队其他成员呢结合Emit IL技术上面其实说了Emit是无法在Design-Time中使用的但如果我们使用Source Generator创建一些空的方法然后用IL去改写应该可以解决这个问题依赖注入目前而言我们在Asp.net Core中创建了服务那么我们需要AddSingleton等方法添加进去这个其实很痛苦因为首先会显得代码很长其次这个操作很无聊且容易遗漏。现在主流的框架都是通过Assembly扫描的方式去动态注册避免手动去添加服务。但如果通过Source Generator扫码这些类就可以在编译时添加进DI容器对象映射Java里面有个库叫做MapStruct原理是用maven插件生成静态的java代码然后按字段赋值。C#里面我好像没有看到这种方法目前我用过的Automapper和Tinymapper都是先去做Bind然后再使用。插个题外话Tinymapper以前的版本是不需要Bind直接用的但后来就要了似乎是为了解决多线程的问题Bind其实很痛苦我很讨厌写这种样板代码以至于我根本就不想用这类Mapper直接Json Copy。