.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對象。
注意事項和限制
雖然源生成器是一個強大的工具，但也有一些注意事項：
1、學習曲線：開發源生成器需要了解 Roslyn 的 API，這對于初學者來說可能很復雜。
2、調試挑戰：調試生成的代碼可能很困難。諸如 之類的工具#line directives可以幫助將生成的代碼映射到源代碼。
3、構建開銷：復雜的源生成器可能會增加大型項目的構建時間。
結論
源生成器是 .NET 中一項顛覆性的功能，可顯著提高生產力和性能。對于 Blazor 項目而言，它們簡化了表單或組件生成等重復性任務，同時也使 API 集成、數據庫映射和事件驅動架構等其他領域受益。
通過使用源生成器，您可以專注于解決業務問題，而無需編寫樣板代碼。立即開始探索其功能，并使用C# .NET 8提升您的開發水平！
如果您喜歡此文章，請收藏、點贊、評論，謝謝，祝您快樂每一天。
)
)
】)
