新闻中心

.NET中的C#源生成器(Source Generators)是什么?如何编写一个来减少模板代码?

2025-11-27
浏览次数:
返回列表
源生成器能减少重复代码,如自动实现INotifyPropertyChanged;通过创建实现ISourceGenerator的类,在编译时生成部分类代码,结合属性标记和语法树分析,为标记的类自动生成通知逻辑,提升开发效率。

.net中的c#源生成器(source generators)是什么?如何编写一个来减少模板代码?

C# 源生成器(Source Generators)是 .NET 5+ 引入的一项编译时功能,属于 Roslyn 编译器扩展的一部分。它允许你在编译过程中自动生成 C# 代码,从而减少重复的模板代码,比如属性通知、序列化逻辑、接口实现等。生成的代码在编译期间插入到项目中,对运行时性能没有影响,同时还能被调试器识别。

源生成器能解决什么问题?

很多开发场景下需要写大量结构相似的代码,例如:

  • INotifyPropertyChanged 接口实现用于 WPF 数据绑定
  • 为记录类型生成深拷贝或比较方法
  • 为枚举生成 JSON 序列化转换器
  • 根据接口自动生成代理类或工厂代码

这些都可以通过源生成器在编译时自动完成,开发者只需关注核心逻辑。

如何编写一个简单的源生成器?

下面以一个简化版的 INotifyPropertyChanged 自动生成为例,展示如何创建一个源生成器来减少模板代码。

Motiff妙多 Motiff妙多

Motiff妙多是一款AI驱动的界面设计工具,定位为“AI时代设计工具”

Motiff妙多 334 查看详情 Motiff妙多

步骤 1:创建源生成器项目
新建一个 .NET 类库项目,并修改 .csproj 文件,使其支持源生成器:

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
    <LangVersion>latest</LangVersion>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.0.1" PrivateAssets="all" />
    <PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.4" PrivateAssets="all" />
  </ItemGroup>
</Project>

步骤 2:实现源生成器
创建一个类并实现 ISourceGenerator 接口:

using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.Text;
using System.Collections.Generic;
using System.Linq;
using System.Text;

[Generator]
public class NotifyPropertyChangedGenerator : ISourceGenerator
{
    public void Initialize(GeneratorInitializationContext context) { }

    public void Execute(GeneratorExecutionContext context)
    {
        // 查找标记了特定属性的类
        var classes = context.Compilation.SyntaxTrees
            .SelectMany(tree => tree.GetRoot().DescendantNodes())
            .OfType<ClassDeclarationSyntax>()
            .Where(m => m.AttributeLists.SelectMany(a => a.Attributes)
                .Any(attr => attr.Name.ToString() == "NotifyPropertyChanged"));

        foreach (var cls in classes)
        {
            var namespaceName = GetNamespace(cls);
            var className = cls.Identifier.Text;
            var source = GenerateNotifyClass(namespaceName, className);
            context.AddSource($"{className}.g.cs", SourceText.From(source, Encoding.UTF8));
        }
    }

    private static string GetNamespace(ClassDeclarationSyntax classDecl)
    {
        SyntaxNode potentialNamespaceParent = classDecl.Parent;
        while (potentialNamespaceParent != null &&
               potentialNamespaceParent is not NamespaceDeclarationSyntax)
        {
            potentialNamespaceParent = potentialNamespaceParent.Parent;
        }

        return potentialNamespaceParent is NamespaceDeclarationSyntax ns ? ns.Name.ToString() : "Generated";
    }

    private static string GenerateNotifyClass(string ns, string className)
    {
        return $@"
namespace {ns}
{{
    partial class {className} : System.ComponentModel.INotifyPropertyChanged
    {{
        public event System.ComponentModel.PropertyChangedEventHandler PropertyChanged;

        protected virtual void OnPropertyChanged([System.Runtime.CompilerServices.CallerMemberName] string propertyName = null)
        {{
            PropertyChanged?.Invoke(this, new System.ComponentModel.PropertyChangedEventArgs(propertyName));
        }}

        // 示例:你可以进一步生成属性包装器
    }}
}}";
    }
}

步骤 3:在目标项目中使用
在另一个项目中引用这个源生成器(可打包为 NuGet 或项目引用),然后使用:

[NotifyPropertyChanged]
public partial class Person
{
    // 源生成器会自动让此类实现 INotifyPropertyChanged
    // 你可以在子类或手动部分类中调用 OnPropertyChanged
}

编译时,生成器会自动为 Person 类生成实现 INotifyPropertyChanged 的代码。

实用建议与注意事项

编写源生成器时注意以下几点:

  • 使用 partial class 是关键,这样生成的代码可以和用户写的代码合并
  • 避免生成过于复杂的逻辑,保持可读性和可调试性
  • 利用 Microsoft.CodeAnalysis.CSharp.Syntax 构建语法树更安全,但字符串拼接简单场景够用
  • 可通过 context.ReportDiagnostic 报告警告或错误
  • 调试源生成器可用 Debugger.Launch() 或集成测试项目

基本上就这些。源生成器不是魔法,但它能显著提升开发效率,尤其适合框架作者或需要大量样板代码的场景。

以上就是.NET中的C#源生成器(Source Generators)是什么?如何编写一个来减少模板代码?的详细内容,更多请关注其它相关文章!


# 操作指南  # 黄埔网站优化建设团队  # 我想做网站推广怎么做呢  # 十堰企业营销推广哪家好  # 网站优化实训体会与感悟  # 转运网站建设方案  # 高州网站建设设计公司  # 济南网站seo优化价格  # 建设网站程序下载  # 北滘陈村网站建设  # 自己这么做seo  # 还能  # 如何在  # 子类  # js  # 如何将  # 创建一个  # 如何使用  # 你可以  # 序列化  # 自动生成  # .net  # c#  # microsoft  # edge  # node  # json 


相关栏目: 【 科技资讯46185 】 【 网络学院92790


相关推荐: 照顾宝贝2小游戏点击立即在线玩  C++如何比较两个字符串_C++ string compare函数与操作符对比  深入理解Go语言中的指针类型:以*string为例  Composer的 archive 命令怎么用_快速打包你的PHP项目及其Composer依赖  小红书网页版入口链接分享 小红书官网直接进  windows10怎么查看本机ip_windows10命令提示符ipconfig使用  XML中包含HTML标签导致解析错误? 正确嵌入非XML数据的两种方法  如何在网页中实现特定地点的随机图片展示  TikTok评论显示延迟如何处理 TikTok评论刷新优化方法  Win10磁盘清理工具在哪 Win10打开并使用磁盘清理【教程】  机器学习中对数变换预测结果的反向还原  快手网页版在线登录 快手网页版官网入口快速访问  铁路12306改签能改到更早的车次吗_铁路12306改签提前车次规则  荣耀Play7T运行卡顿解决_荣耀Play7T性能优化  Golang如何优化CPU绑定任务分配策略_Golang CPU任务分配优化实践  Go语言HTML解析:利用Goquery精准获取指定元素内容  Yandex免登录官网入口_俄罗斯Yandex搜索引擎直达链接  Composer的 "conflict" 字段有什么用_如何声明不兼容的包以避免依赖冲突  Mac怎么查看崩溃日志_Mac控制台错误报告分析  qq游戏手机版下载安装_qq游戏移动端入口  必由学官方登录入口 必由学教师学生账号快速访问  sublime如何配置Python开发环境_将sublime打造成轻量级Python IDE  2025AO3夸克浏览器通道_AO3手机HTTPS安全入口分享  Animex动漫社网入口地址 Animex动漫社网正版在线入口  PowerPoint如何制作滚动字幕结尾彩蛋_PowerPoint路径动画实现平滑滚动字幕效果  抖音网页版快捷访问 抖音网页版网页版入口操作教程  sublime怎么覆盖插件的默认快捷键_sublime快捷键优先级与设置  J*aScript 字符串标签转换:使用正则表达式高效替换  打开就能玩的植物大战僵尸 植物大战僵尸网页版传送门  优化 Python 函数中的条件逻辑:解决 if-else 嵌套与参数选择问题  12306几点到几点不能订票? | 官方最新系统维护时间全解析  支付宝碰一碰设备是REDMI手机吗 博主拆机辟谣:处理器、内存都不一样  steam官方入口大全 steam账号注册及操作指南  神经网络二分类模型训练异常:高损失与完美验证准确率的排查与修正  iCloud登录入口网页版 苹果iCloud官网登录  如何优雅地解决Livewire文件上传难题?SpatieLivewireFilepond让一切变得简单  msn官网入口地址手机版 msn官方网站手机最新链接  谷歌浏览器一键优化方案_谷歌浏览器直达主页极速不卡版  Tabulator表格中精确实现日期时间排序的指南  一加 14R 快充无反应_一加 14R 充电优化  纯CSS与HTML网格布局的HTML精简策略:SVG与JS方案解析  Win10怎么制作U盘启动盘 Win10系统安装U盘制作教程【详解】  163邮箱登录密码 163邮箱忘记密码找回  AO3网页版合集入口 Archive of Our Own同人作品浏览指南  处理动态列数据:J*a ArrayList的正确初始化与字符累加教程  Safari自带网页翻译功能怎么用 无需插件轻松看懂外文网站【方法】  必由学官网首页入口 必由学教师网页版登录指南  Win11怎么查看显卡显存 Win11显示适配器属性及专用视频内存查询  在J*a中如何在J*a中使用异常机制记录错误日志_异常日志实践经验  三星ZFold5多任务卡顿_Samsung ZFold5流畅度提升 

搜索