[C#]SourceGenerator实战: 对任意对象使用await吧!!!
[C#]SourceGenerator实战: 对任意对象使用await吧!!!
前言
本文记录一次简单的 SourceGenerator
实战,最终实现可以在代码中 await
任意类型对象,仅供娱乐,请勿在生产环境中使用!!!
关键技术:
SourceGenerator
- 在编译时动态生成代码的技术。官方文档:源生成器
- 关于
IncrementalGenerator
的基本使用可以参考 dotnet 用 SourceGenerator 源代码生成技术实现中文编程语言 SourceGenerator
除了提供附加文件进行代码生成,还有丰富的语法树、类型等分析APISourceGenerator
只能拓展
代码,不能替换
代码
Await anything
- C#中的
async/await
最终由编译器编译为状态机,其核心逻辑在于await
对象需要实现符合要求的GetAwaiter
方法,这个方法可以是拓展方法
- 参见官方博客 await anything;
- C#中的
那么要实现对任何对象的 await
我们的思路大概如下:
- 找到所有的
await
语法 - 检查
await
的对象是否有GetAwaiter
方法 - 为没有
GetAwaiter
方法的对象生成GetAwaiter
拓展方法
得益于 SourceGenerator
丰富的分析API,我们可以很容易的办到这件事
实现源生成器
GetAwaiter拓展方法模板
我们先来实现一个可以让 TargetType
支持 await
的拓展方法类模板:
using System.Runtime.CompilerServices;
namespace System.Threading.Tasks
{
public static class GetAwaiterExtension_TargetTypeName
{
public static TaskAwaiterFor_TargetTypeName GetAwaiter(this TargetType value)
{
return new TaskAwaiterFor_TargetTypeName(value);
}
public readonly struct TaskAwaiterFor_TargetTypeName : ICriticalNotifyCompletion, INotifyCompletion
{
private readonly TargetType _value;
public bool IsCompleted { get; } = true;
public TaskAwaiterFor_TargetTypeName(TargetType value)
{
_value = value;
}
public TargetType GetResult()
{
return _value;
}
public void OnCompleted(Action continuation)
{
continuation();
}
public void UnsafeOnCompleted(Action continuation)
{
continuation();
}
}
}
}
- 将类型放在命名空间
System.Threading.Tasks
下,可以在使用的时候不需要额外的命名空间引用; - 由于我们已经有了需要返回的结果值,所以
Awaiter
的IsCompleted
始终为true
,GetResult
直接返回结果即可;
分析所有 await
语法,并筛选出需要为其生成 GetAwaiter
方法的类型
- 先建立一个
IncrementalGenerator
[Generator(LanguageNames.CSharp)]
public class GetAwaiterIncrementalGenerator : IIncrementalGenerator
{
public void Initialize(IncrementalGeneratorInitializationContext context)
{
}
}
- 在
Initialize
方法中筛选目标类型/// 使用语法提供器筛选出所有的 `await` 语法,并获取其类型
var symbolProvider = context.SyntaxProvider.CreateSyntaxProvider((node, _) => node is AwaitExpressionSyntax //直接判断节点是否为 `AwaitExpressionSyntax` 即可筛选出所有 await 表达式
, TransformAwaitExpressionSyntax) //从 await 表达式中解析出其尚不支持 await 的对象类型符号
.Where(m => m is not null) //筛选掉无效的项
.WithComparer(SymbolEqualityComparer.Default); //使用默认的符号比较器进行比较
- 直接使用表达式语法不太方便处理,我们实现表达式语法到类型符号的转换方法
TransformAwaitExpressionSyntax
private static ITypeSymbol? TransformAwaitExpressionSyntax(GeneratorSyntaxContext generatorSyntaxContext, CancellationToken cancellationToken)
{
//经过筛选,到达此处的节点一定是 AwaitExpressionSyntax
var awaitExpressionSyntax = (AwaitExpressionSyntax)generatorSyntaxContext.Node; //如果 await 表达式语法的 await 对象仍然是 AwaitExpressionSyntax ,那么跳过此条记录
//类似 "await await await 1;" 我们直接忽略前两个 await 表达式
if (awaitExpressionSyntax.Expression is AwaitExpressionSyntax)
{
return null;
} //使用 `SemanticModel` 可以分析出更具体的符号信息,比如类型,方法等
//直接使用其提供的 `GetAwaitExpressionInfo` 可以从表达式语法获取 await 的详细信息
var awaitExpressionInfo = generatorSyntaxContext.SemanticModel.GetAwaitExpressionInfo(awaitExpressionSyntax); //判断分析结果中此表达式是否包含 `GetAwaiter` 方法,如果不包含,那么我们需要为其生成
if (awaitExpressionInfo.GetAwaiterMethod is null)
{
//`SemanticModel` 的 GetTypeInfo 方法可以获取一个表达式的类型符号信息
//返回 await 对象的类型符号
return generatorSyntaxContext.SemanticModel.GetTypeInfo(awaitExpressionSyntax.Expression).Type;
} return null;
}
为所有目标类型生成 GetAwaiter
拓展方法
由于只需要为相同类型生成一次 GetAwaiter
方法,所以我们需要将类型符号去重之后进行生成
- 直接将上面的
symbolProvider
传递给RegisterSourceOutput
方法的话,每次只会处理一个类型符号,我们无法去重 - 调用
symbolProvider
的Collect
方法,可以将前面步骤筛选出的所有类型符号作为一个集合进行处理
所以注册源码生成器可以这样写:
context.RegisterSourceOutput(symbolProvider.Collect(), //将筛选的结果作为整体传递
(ctx, input) =>
{
//遍历去重后的类型符号
foreach (var item in input.Distinct(SymbolEqualityComparer.Default))
{
//为每个去重后的类型生成 `GetAwaiter` 拓展方法
}
});
接下来使用之前写的拓展方法模板生成每个类型的 GetAwaiter
拓展方法即可:
//获取类型符号的完整访问类型名
var fullyClassName = item!.ToDisplayString(SymbolDisplayFormat.FullyQualifiedFormat);
//获取不包含无效符号的类名
var className = NormalizeClassName(fullyClassName);
//替换模板中的类型占位符为当前处理的目标类型
var code = templateCode.Replace("TargetTypeName", className)
.Replace("TargetType", fullyClassName);
//如果目标类型不是公开类型,那么拓展方法也应该不公开
if (item.DeclaredAccessibility != Accessibility.Public)
{
code = code.Replace("public static class", "internal static class");
}
//将生成的代码添加到编译中
ctx.AddSource($"GetAwaiterFor_{className}.g.cs", code);
//将类型名称中不能作为类名的符号替换为_
private static string NormalizeClassName(string value)
{
return value.Replace('.', '_')
.Replace('<', '_')
.Replace('>', '_')
.Replace(' ', '_')
.Replace(',', '_')
.Replace(':', '_');
}
到这里我们就实现了所有的功能点,新建项目并引用分析器就可以 await
任何对象了,效果大概如下:
- 代码 - AwaitAnyObject.zip
- 也可以直接安装 NuGet 包
AwaitAnyObject
进行游玩
[C#]SourceGenerator实战: 对任意对象使用await吧!!!的更多相关文章
- Progress.js – 为页面上的任意对象创建进度条效果
Progress.js 是一个 JavaScript 和 CSS3 的库,它帮助开发人员为网页上的每个对象创建和管理进度条效果.你可以设计自己的模板,进度条或者干脆定制. 您可以使用 Progress ...
- Js中找任意对象的原型方法及改造原型
Java中有运行时类型识别,js可以很方便的模仿这个特性,因为所有js对象都有一个属性constructor(构造器),表示这个对象的构造方法,原型与构造方法同名,所以可以通过这儿知道任意对象的原型名 ...
- (一一五)利用NSKeyedArchiver实现任意对象转为二进制
[应用背景] 在数据库中存储数据时,如果对象过于复杂,又不必要创建复杂的表,可以直接把整个对象转化为二进制存入数据库字段,然后取出后再还原即可. [实现方法] 在PHP中,使用序列化和反序列化可以实现 ...
- Java多线程6:Synchronized锁代码块(this和任意对象)
一.Synchronized(this)锁代码块 用关键字synchronized修饰方法在有些情况下是有弊端的,若是执行该方法所需的时间比较长,线程1执行该方法的时候,线程2就必须等待.这种情况下就 ...
- synchronized将任意对象作为对象监视器
多个线程调用同一个对象中的不同名称的synchronized同步方法或synchronized(this)同步代码块时,调用的效果就是按顺序执行,也就是同步的,阻塞的.这说明synchronized同 ...
- IOS-将任意对象存进数据库
model // // HMShop.h // 将任意对象存进数据库 // // Created by apple on 14/11/20. // Copyright (c) 2014年 heima. ...
- 直接获取任意对象的 $('.xx').css('x') 值都是0
<!-- 任意对象,直接获取他们的 x , y 都是为0: $('#xxx').css('x','y'); --> <!DOCTYPE html> <html lang= ...
- C# 将任意对象快速转换为Json
由于最近项目里面Model类特别多,而我需要编写所有数据交互的接口,传输的格式是json,以前都是通过循环List<T>中的对象向StringBuilder对象中Apped字符串生成jso ...
- 【WePY小程序框架实战四】-使用async&await异步请求数据
[WePY小程序框架实战一]-创建项目 [WePY小程序框架实战二]-页面结构 [WePY小程序框架实战三]-组件传值 async await 是对promise的近一步优化,既解决了promise链 ...
随机推荐
- java Suspicious regex expression "." in call to 'replaceAll()' 问题延展
因为要处理从身份证读取到的有效期时间,所以用到了replaceAll这个方法,类似如下代码: String s1 = s.replaceAll(".", "-" ...
- 下载markdown软件Obsidian(解决官网下载速度慢)
Typora要钱了,不想每次都点稍后再买. Obsidian也很好用,官网是:https://obsidian.md/ 但是不太好下载,直接下载速度只有10kb/s左右,总共60多MB: 扔给迅雷也没 ...
- [原创] RestartPC64-中文版v1.0.0.9
原来发布的RestartPC-中文版和英文版v1.0.0.5,在PE64下无效.所以重新编译了64位版的RestartPC64-中文版v1.0.0.9,可以在PE64下面.正常Win64系统下面重启关 ...
- Luogu3740 [HAOI2014]贴海报 (线段树)
倒着来 #include <iostream> #include <cstdio> #include <cstring> #include <algorith ...
- Java SE 9 新增特性
Java SE 9 新增特性 作者:Grey 原文地址: Java SE 9 新增特性 源码 源仓库: Github:java_new_features 镜像仓库: GitCode:java_new_ ...
- linux之间上传下载--SCP
1.远程拷贝文件 [root@rhel8-client01 yum.repos.d]# scp root@192.168.72.149:/etc/yum.repos.d/* . (.表示拷贝到当前文件 ...
- 四连测总结(XYX)
目录 成绩 总结 事后... 成绩 telephonewire monkey 总分 0 56 56 cowjog guard path temperature 总分 0 40 0 68 108 cba ...
- PHP极简短连接
可用于短连接开发 随便找个PHP空间存放即可 点击查看代码 <html> <head> <meta charset="utf-8"/> < ...
- 使用『jQuery』『原生js』制作一个选项卡盒子 —— { }
效果 HTML 部分 <body> <div id="main-box"> <div id="left-nav"></ ...
- 从 Hadoop 到云原生, 大数据平台如何做存算分离
Hadoop 的诞生改变了企业对数据的存储.处理和分析的过程,加速了大数据的发展,受到广泛的应用,给整个行业带来了变革意义的改变:随着云计算时代的到来, 存算分离的架构受到青睐,企业开开始对 Hado ...