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; }}
}

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

  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;}// 找到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,可以看到效果,并且直接调用属性是不报错的
2ab066371e1e3aadfc205b10bb88463f.png
9038ac3ffad508f59286a529050f61cf.png

结尾

这里仅演示了最基本的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。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/289030.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

python图片解析库_python用来获得图片exif信息的库实例分析

本文实例讲述了python用来获得图片exif信息的库用法。分享给大家供大家参考。具体分析如下&#xff1a; exif-py是一个纯python实现的获取图片元数据的python库&#xff0c;官方下载地址&#xff1a; http://exif-py.svn.sourceforge.net/viewvc/exif-py/source/EXIF.py?revis…

Linux Swap分区设定

因为准备在linux上面安装Oracle数据库&#xff0c;据说swap分区小于4G容易失败&#xff0c;天啦噜的我连swap分区是啥都不是非常清楚&#xff0c; 大概有个印象吧&#xff0c;但先搞大了再说。 测试证明Ubuntu14默认的swap分区是和初期设定的内存大小一样一样的。 最初因为手速…

java servlet https_javaweb项目对https的配置01

1.准备证书生成a.进入到jdk下的bin目录(如果配置了Java的环境&#xff0c;可以直接在cmd命令窗口中直接输入如下命令)keytool -v -genkey -alias tomcat -keyalg RSA -keystore d:/tomcat.keystore -validity 36500附&#xff1a;d:/tomcat.keystore是将生成的tomcat.keystore放…

OC开发_Storyboard——MapKit

一、Core Location 1、基本对象 propertys: coordinate, altitude, horizontal/verticalAccuracy, timestamp, speed, course property (readonly) CLLocationCoordinate2D coordinate; typedef { CLLocationDegrees latitude; // double型 纬度 CLLocationDegrees longitu…

【C语言简单说】二:第一个C语言程序详解(2)

如有错误请给与纠正… (_)? 不知道你在什麼 其实这一节可以跳过&#xff0c;不信你往下看… 上一个教程只说明了第一个C语言程序源码中的头文件&#xff1a; #include<stdio.h> #include<stdlib.h> 照例&#xff0c;我又把这一节说的源代码的内容给复制过来&a…

Effective C++学习笔记之copy构造函数和default函数和copy赋值函数(operator=)

1 、C一个空的类里面一般默认的函数 比如我们写 class A {}; 一般里面系统会给你哪些默认函数呢&#xff1f; class A { public:A(){} //default函数~A(){} //析构函数A(const A& a) {} //copy构造函数A& operator (const A& a) {} //copy assignment操…

python学习笔记 --- 随机数进阶

你真的懂随机数&#xff1f; Author : Jasper YangSchool : Bupt Q:为什么要写这篇文章&#xff1f;A:因为我发现在最近的科学计算中&#xff0c;常常遇到随机数&#xff0c;所有的随机数都是基于0,1随机&#xff0c;而这个0,1随机怎么实现呢&#xff1f;下面我会娓娓道来~ 这篇…

一套关于 内存对齐 的C#面试题,做错的人很多!

这是一套朋友公司的面试题&#xff0c;挺有意思分享一下。题目&#xff1a;判断下面的 Location1 和 Location2 的结构体大小各是多少&#xff1f;public struct Location1{public int X;public int Y;public long Z;}public struct Location2{public int X;public long Y;publ…

pythonweb服务器怎么让别人访问_Django配置让其他电脑访问网站

其实在Django 带有一个内建的轻量级 Web 服务器&#xff0c;可供站点开发过程中使用。我们提供这个服务器是为了让你快速开发站点&#xff0c;也就是说在准备发布产品之前&#xff0c;无需进行产品级 Web 服务器&#xff08;比如 Apache&#xff09;的配置工作。 但是实际开发中…

python3-day4(装饰器)

一.基本 第一波 #### def foo():print foofoo #表示是函数 foo() #表示执行foo函数#### 第二波 #### def foo():print foofoo lambda x: x 1foo() # 执行下面的lambda表达式&#xff0c;而不再是原来的foo函数&#xff0c;因为函数 foo 被重新定义了二.example #一个…

【C语言简单说】二:第一个C语言程序详解(3)

如有错误请给与纠正… 注&#xff1a;注意我们每一行代码后面的分号表示我们一句代码的结束&#xff0c;就像我们在写文字的时候的标点符号&#xff0c;一个句号表示一句话的结尾。 上一个教程只说明了第一个C语言程序源码中的main&#xff08;其实等于没说&#xff09;&…

【转载】关于测试人员的职业发展

近期由于项目组人手不够&#xff0c;需要招聘一些测试人员。本周及上周陆陆续续面试了十多个应征者&#xff0c;工作年限在2年~9年之间&#xff0c;但无一满意。期间&#xff0c;种种感叹&#xff0c;回想起去年面试六十余人仅有3人满足要求&#xff0c;如有鲠在喉&#xff0c;…

python之闭包

1 闭包概念 绑定了函数内部引用的所有变量&#xff0c;把它引用的东西都放在一个上下文中“包”了起来 2 闭包的Demo理解 需求:比如我们要实现2个函数,每个函数有个参数,然后现在需要实现这2个函数参数的相加功能 1) 不用闭包python普通实现 #!/usr/bin/env pythondef plus…

C#求一元二次方程的根经典案例程序

目 录 1. 界面设计 2. C#源程序 1. 界面设计 界面说明: 输入一元二次方程的二次项、一次项及常数项,这样的话对应的一元二次方程表达式就确定了,点击【计算】,即可计算出该一元二次方程的根。 2. C#源程序 using System; using System.Collections.Generic; using S…

pythonrequests说明_解决Python requests 报错方法集锦

python版本和ssl版本都会导致 requests在请求https网站时候会出一些错误&#xff0c;最好使用新版本。 1 Python2.6x use requests 一台老Centos机器上跑着古老的应用&#xff0c;加了一个新模块之后报错 报错 InsecurePlatformWarning: A true SSLContext object is not avail…

centos6,7的启动流程

CentOS 6 系统启动流程&#xff1a;POST --> BootSequence(BIOS) --> Bootloader --> kernel [-->ramfs] -->rootfs(ro) --> /sbin/init --> 设定默认运行级别 --> 系统初始化 --> 可以并行执行ctrlaltdel热键功能定义&#xff0c;系统服务的开启和…

微软是如何解决 PC 端程序多开问题的

前言在公众号上看到一篇文章《C#中解决PC端程序多开的问题》。该文作者是通过创建互斥锁Mutex实现的:bool mutexCreated; var mutex new Mutex(true, "MyApp", out mutexCreated); if (mutexCreated) {Application.Run(new Form1()); } else {MessageBox.Show("…

java中inputstream_java中InputStream String

Java 中获取输入流时&#xff0c;有时候须要将输入流转成String,以便获取当中的内容 &#xff0c;以下总结一下 InputStream 转成String 的方式方法1&#xff1a;public String convertStreamToString(InputStream is) {BufferedReader reader new BufferedReader(new InputSt…

【C语言简单说】三:整数变量和输出扩展(1)

唔&#xff01;经历之前眼瞎的教程之后&#xff0c;现在我继续的眼瞎着写接下来的章节… 注&#xff1a;注意我们每一行代码后面的分号表示我们一句代码的结束&#xff0c;就像我们在写文字的时候的标点符号&#xff0c;一个句号表示一句话的结尾。 注&#xff1a;我们printf…