当前位置：首页 > news >正文

使用 C# 源生成器（Source Generators）进行高效开发：增强 Blazor 及其他功能

news 来源：原创 2025/6/15 8:58:49

.NET 中源生成器的引入彻底改变了我们的开发方式，它消除了动态逻辑，并在编译时生成静态代码。这不仅提高了应用程序的性能，还提升了开发人员的生产力和代码质量。

如果您正在使用Blazor（WebAssembly 或服务器）或构建需要代码自动化的复杂项目，源生成器可能会带来巨大的改变。在本文中，我们将探讨源生成器的工作原理、优势以及在 Blazor 及其他环境中的实际用例。

什么是源生成器？

源生成器是 Roslyn 编译器的一部分，允许您在编译期间生成其他代码。它们会检查现有代码、元数据或外部资源（例如 JSON、XML），并生成 C# 代码，然后与您的应用程序一起编译。

例如，源生成器无需手动编写重复的组件或逻辑，而是自动执行此过程，确保一致性并节省开发时间。

为什么在 Blazor 中使用源生成器？

Blazor 是一个使用 C# 构建交互式 Web 应用程序的框架，它有几种可以从源生成器中受益匪浅的场景：

1.自动化重复代码

在 Blazor 中，表单或数据可视化等组件通常遵循重复的模式。源生成器可以根据数据模型自动创建此类组件，从而节省大量手动工作。

2. 性能改进

在 Blazor WebAssembly 中，任何运行时开销都会影响用户体验。通过在编译时生成静态代码，源生成器消除了对运行时反射或动态逻辑的需求，从而实现了更快、更高效的应用程序。

3. 提高开发人员的生产力

源生成器可以自动执行此过程，使开发人员能够专注于核心业务逻辑和应用程序设计，而无需花费数小时为每个模型创建类似的组件或映射。

4.确保代码一致性

通过自动化模式，源生成器确保所有生成的代码遵循相同的结构和标准，从而减少人为错误并使代码库更易于维护。

Blazor 之外的优势

虽然源生成器与 Blazor 项目完美匹配，但它们的应用范围还扩展到各种开发场景：

1.序列化和反序列化

System.Text.Json 或 Newtonsoft.Json 等框架可以使用源生成器来创建序列化器或自定义属性，从而消除手动配置开销。

2. API 客户端

源生成器可以基于 OpenAPI/Swagger 文件自动生成 API 客户端或模型，从而简化集成。

3.数据库集成

他们可以创建实体框架模型或 Dapper 映射，减少数据库操作的样板代码。

4.数据验证

源生成器可以根据属性为数据模型生成验证器，确保一致性并减少人工工作量。

5.事件驱动架构

在 CQRS 和事件源架构中，源生成器可以根据集中定义自动创建事件处理程序或映射。

实际示例：在 Blazor 中生成表单

让我们演示源生成器如何自动为 Blazor 应用程序创建表单。

数据模型

假设您有一个简单的数据模型：

public class Product
{
public string Name { get; set; }
public decimal Price { get; set; }
public int Stock { get; set; }
}

源生成器实现

源生成器可以根据此模型自动创建 Blazor 表单组件。

using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Text;
using System.Text;

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

public void Execute(GeneratorExecutionContext context)
{
// Example of a hardcoded model (you can retrieve this dynamically in a real scenario)
var modelName = "Product";
var properties = new[]
{
new { Name = "Name", Type = "string" },
new { Name = "Price", Type = "decimal" },
new { Name = "Stock", Type = "int" }
};

var builder = new StringBuilder();
builder.AppendLine("@inherits ComponentBase");
builder.AppendLine($"<h3>Edit {modelName}</h3>");
builder.AppendLine("<EditForm Model=\"@Model\">");

foreach (var property in properties)
{
builder.AppendLine($" <label>{property.Name}</label>");
builder.AppendLine($" <InputText @bind-Value=\"Model.{property.Name}\" />");
builder.AppendLine("<br />");
}

builder.AppendLine("</EditForm>");
builder.AppendLine("@code {");
builder.AppendLine($" private {modelName} Model {{ get; set; }} = new {modelName}();");
builder.AppendLine("}");

context.AddSource($"{modelName}Form.g.razor", SourceText.From(builder.ToString(), Encoding.UTF8));
}
}

生成的代码

生成的代码将如下所示：

@inherits ComponentBase
<h3>Edit Product</h3>
<EditForm Model="@Model">
<label>Name</label>
<InputText @bind-Value="Model.Name" />
<br />
<label>Price</label>
<InputText @bind-Value="Model.Price" />
<br />
<label>Stock</label>
<InputText @bind-Value="Model.Stock" />
<br />
</EditForm>
@code {
private Product Model { get; set; } = new Product();
}

该组件可直接在任何 Blazor 页面中使用来编辑Product对象。