SourceGeneratorTest

一个用于演示和测试各种 .NET 源代码生成器框架的示例项目。本项目展示了如何在现代 .NET 10 应用程序中使用多种源代码生成器来提高开发效率和代码质量。

🚀 项目特性

• Clean Architecture: 采用分层架构设计，包含 Core、Repositories、Services 和 API 层
• 源代码生成器集成: 集成多个主流的源代码生成器框架
• RESTful API: 提供测试用订单和产品管理 API
• 配置管理: 使用源代码生成器自动注册配置选项
• 日志记录: 集成 Serilog 进行结构化日志记录
• API 文档: 集成 Swagger/OpenAPI 文档
• 现代化测试: 使用 TUnit 测试框架进行全面的单元测试和集成测试

🔧 使用的源代码生成器框架

1. AutoCtor - 自动构造函数注入

自动生成构造函数和依赖注入代码，减少样板代码。

使用示例:

[AutoConstruct]publicpartialclassOrderService:IOrderService{privatereadonlyIOrderRepository_orderRepository;privatereadonlyILogger<OrderService>_logger;// 构造函数将自动生成}

2. Mapperly - 高性能对象映射

编译时生成高性能的对象映射代码，支持深拷贝。

使用示例:

[Mapper]publicpartialclassOrderMapper{[MapperIgnoreTarget(nameof(OrderEntity.OrderId))]publicpartialOrderEntityReqToEntity(CreateOrderReqreq);[MapProperty(nameof(OrderEntity.OrderType),nameof(OrderDto.OrderTypeDesc),Use=nameof(MapOrderType))]publicpartialOrderDtoEntityToDto(OrderEntityreq);}

3. NetEscapades.EnumGenerators - 枚举扩展方法

为枚举类型生成高性能的扩展方法。

使用示例:

[EnumExtensions]publicenumOrderType{[Description("未知")]Unknown=0,[Description("租车")]Rental=1,[Description("打车")]Taxi=2,}// 生成的扩展方法: OrderType.Rental.ToStringFast()

4. ServiceScan.SourceGenerator - 编译时服务注册

编译时扫描程序集并生成服务注册代码。

使用示例:

publicstaticpartialclassServicesExtensions{[GenerateServiceRegistrations(TypeNameFilter="*Service",AsImplementedInterfaces=true,Lifetime=ServiceLifetime.Scoped)]publicstaticpartialIServiceCollectionAddServices(thisIServiceCollectionservices);}

5. 自定义配置注册生成器

使用 ServiceScan.SourceGenerator 实现的自定义配置选项注册。

使用示例:

[Option(nameof(TestOptions))]publicclassTestOptions{publicstring?Name{get;set;}}// 自动注册: services.Configure<TestOptions>(configuration.GetSection("TestOptions"));

6. TUnit - 现代化测试框架

基于源代码生成器的现代 .NET 测试框架，提供高性能和类型安全的测试体验。

主要特性:

• 源代码生成: 编译时生成测试代码，提供更好的性能
• 完全异步支持: 原生支持异步测试方法
• 并行执行: 默认并行执行测试，提高测试速度
• 类型安全: 编译时类型检查，避免运行时错误
• 现代语法: 支持现代 C# 语法特性

使用示例:

[Test]publicasyncTaskCreateProduct_ShouldReturnValidGuid(){// Arrangevarrequest=newCreateProductReq{Name="Test Product",Price=99.99m,Category=ProductCategory.Electronics};// Actvarresult=await_productService.CreateProductAsync(request);// AssertawaitAssert.That(result).IsNotEqualTo(Guid.Empty);}[Test][Arguments("iPhone",999.99,ProductCategory.Electronics)][Arguments("Book",29.99,ProductCategory.Books)]publicasyncTaskCreateProduct_WithDifferentCategories_ShouldReturnCorrectDescription(stringname,decimalprice,ProductCategorycategory){// 参数化测试示例varrequest=newCreateProductReq{Name=name,Price=price,Category=category};varresult=await_productService.CreateProductAsync(request);awaitAssert.That(result).IsNotEqualTo(Guid.Empty);}[Test]publicasyncTaskGetProduct_WithNonExistentId_ShouldThrowException(){// 异常测试示例varnonExistentId=Guid.NewGuid();awaitAssert.That(()=>_productService.GetProductAsync(nonExistentId)).Throws<ArgumentNullException>();}

🔍 源代码生成器的优势

1. 编译时生成: 所有代码在编译时生成，运行时无反射开销
2. 类型安全: 生成的代码是强类型的，编译时检查错误
3. 性能优化: 避免了运行时反射和动态代码生成的性能损失
4. 代码可见: 生成的代码可以在 IDE 中查看和调试
5. 减少样板代码: 大幅减少重复的样板代码编写

📚 学习资源

源代码生成器

• .NET Source Generators 官方文档
• AutoCtor 使用指南
• Mapperly 映射器文档
• 枚举生成器文档
• ServiceScan.SourceGenerator 文档
• AutoDbSet 官方文档

测试框架

• TUnit 官方文档
• TUnit 快速开始指南

🤝 贡献

欢迎提交 Issue 和 Pull Request 来改进这个示例项目！