Source Generator实战
前言
最近刷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 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;}// 找到namespacevar namespaceDeclarationSyntax =classDeclarationSyntax.FirstAncestorOrSelf<BaseNamespaceDeclarationSyntax>();if (classList.Contains(classDeclarationSyntax.Identifier.ValueText)){continue;}// 找到fieldvar fieldDeclarationList = classDeclarationSyntax.Members.OfType<FieldDeclarationSyntax>().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。
Source Generator实战相关推荐
- .NET 6 中的 Logging Source Generator
.NET 6 中的 Logging Source Generator Intro Logging source generator 是 .NET 6 引入的一个新功能,借助 Source Genera ...
- Source Generator 单元测试
Source Generator 单元测试 Intro Source Generator 是 .NET 5.0 以后引入的一个在编译期间动态生成代码的一个机制,介绍可以参考 C# 强大的新特性 Sou ...
- 使用 Source Generator 自动生成 WEB API
使用 Source Generator 自动生成 WEB API Intro 上次我们介绍了使用 Source Generator 的应用,有小伙伴留言说想要自动生成一套 ABP 相关的东西,我对 A ...
- 使用 Source Generator 代替 T4 动态生成代码
使用 Source Generator 代替 T4 动态生成代码 Intro 在 Source Generator 出现之前有一些重复性的代码,我会使用 T4 去生成,这样就可以一定程度上避免复制粘贴 ...
- C# 强大的新特性 Source Generator
C# 强大的新特性 Source Generator Intro 微软在 .NET 5 中引入了 Source Generator 的新特性,利用 Source Generator 我们可以在应用编译 ...
- Source Generator:C# 9 将迎来编译时元编程
源码生成器(Source Generator)是 C#编译器的一个新特性,开发者可以使用编译器生成的元数据检查用户代码,并生成附加的源文件,与程序的其他部分一起编译. 受 F#类型提供程序的启发,C# ...
- javaweb项目Error:Android Source Generator: [example] Android SDK is not specified
javaweb项目混入android@java javaweb项目Error:Android Source Generator: [example] Android SDK is not specif ...
- Error:Android Source Generator: [sdk] Android SDK is not specified.
有时候使用intellij idea 带入android 项目,运行提示Error:Android Source Generator: [sdk] Android SDK is not specifi ...
- Mybatis generator实战:自动生成POJO类完整解决方案
目录 1.背景:Mybatis generator根据数据库表自动生成POJO类完整解决方案 2.解决方案:mybatis generator 1.3.6 已经有了这个功能, 2.1.增加了一个新的属 ...
- ERROR: Android Source Generator: [project] AndroidManifest.xml file not found
you must open Project Structure modified something. example: Project Structure > Facets ,you can ...
最新文章
- php imagecopy 用法,php使用imagecopymerge()函数创建半透明水印
- PHP简单封装MysqlHelper类
- 在tomcat中用jndi配置数据源启动java web程序
- FFmpeg(五) 重采样相关函数理解
- 会python可以从事什么工作-Python入门后,想要从事自由职业可以做哪方面工作?...
- go与Java微服务对比_微服务架构对比-Go语言中文社区
- 微信AI从识物到通用图像搜索的探索揭秘
- 银行的相关计算机知识,银行计算机基础知识试题及答案正式版.doc
- java面向对象程序设计(jdk1.6)第三版 目录页数_Java面向对象程序设计/普通高等教育计算机规划教材简介,目录书摘...
- 梦想中的网络安全和内部协作
- 计算机dos通讯,PC双机通信DOS
- Greenplum 行存、列存,堆表、AO表的原理和选择
- Linux系统下的RZSZ(文件传输工具)
- DataGrid相邻行有相同内容时对指定列合并和C#可以实现DLL库的动态调用
- mdx词典包_不会用医学词典?停姐手把手教你啊(内附海量医学词典词库资源下载)...
- 使用layUI弹出输入框并收集输入框信息
- Python基础 Zero to Hero面向对象编程(一)
- 基于51单片机的烟雾温度火灾报警器 LCD1602显示proteus仿真
- 【附源码】Java计算机毕业设计校园博客系统(程序+LW+部署)
- ARM裸机开发篇3:ARM汇编语言程序设计
热门文章
- 解决WebStorme点击谷歌浏览器图标无反应问题
- 谷歌浏览器崩溃解决方法
- 形容计算机技术发展的词,形容技术发展的成语是什么_四字词语 - 成梦词典
- 软件测试-黑盒测试:正交实验设计法
- cad缩放_CAD中的AL是什么指令? 怎么操作哦
- 微醺时代的白酒新锐:政策“理想”与现实“骨感”的夹缝进击
- 微信公众号网页跳转及获取用户信息的接口设计
- python画美女代码_3分钟画字符画跟女神表白,利用python字符串、列表方法
- 学术论文参考文献格式
- 用Python寻找最优投资组合