AutoModeCodeGenerator.Analyzers 1.0.0.17

AutoModeCodeGenerator.Analyzers

基于 Roslyn 的 C# 增量源生成器，在编译期根据特性或 .entity.json 自动生成 Poco、Record、Inpc 等样式的实现类。

• NuGet：https://www.nuget.org/packages/AutoModeCodeGenerator.Analyzers
• 源码：https://github.com/mccj/AutoModeCodeGenerator
• 许可证：Apache License 2.0

安装

<PackageReference Include="AutoModeCodeGenerator.Analyzers" Version="1.0.0.18" PrivateAssets="all" />

PrivateAssets="all" 确保生成器仅参与编译，不传递到依赖项目的运行时引用。

可选：将生成代码输出到磁盘

便于在 IDE 中查看生成结果：

<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
<CompilerGeneratedFilesOutputPath>$(BaseIntermediateOutputPath)Generated</CompilerGeneratedFilesOutputPath>

快速开始（特性方式）

1. 在接口或类上添加 [AutoCodeClassModes]，指定唯一 Id 及生成选项。
2. 在需要导出的属性上添加 [AutoCodeProperty]，通过 Id / Ids 关联到对应的类模式。
3. 编译后，生成器输出 {命名空间}.{类型名}.g.cs。

#nullable enable

[AutoCodeGenerator.AutoCodeNullable(Type = AutoCodeGenerator.NullableEnum.Enable)]
[AutoCodeGenerator.AutoCodeClassModes(
    Id = "dto",
    Namespace = "MyApp.Models",
    Suffix = "Dto",
    ClassStyle = AutoCodeGenerator.ClassStyleEnum.Poco)]
public interface IUser
{
    [AutoCodeGenerator.AutoCodeProperty(Id = "dto")]
    string Name { get; set; }

    [AutoCodeGenerator.AutoCodeProperty(Id = "dto", IsNullable = true)]
    int Age { get; set; }
}

编译后生成类似：

namespace MyApp.Models
{
    public partial class IUserDto
    {
        public string Name { get; set; } = null!;
        public int? Age { get; set; }
    }
}

完整示例见仓库中的 TestModel.interface.cs。

核心概念

Id 关联机制

• AutoCodeClassModes(Id = "a1", ...) 定义一种生成模式。
• AutoCodeProperty(Id = "a1") 或 Ids = new[] { "a1", "a2" } 将属性绑定到一种或多种模式。
• 同一接口可配置多个 AutoCodeClassModes，一次定义生成多个不同命名空间/样式的类。

类样式（ClassStyle）

Inpc 需指定基类：

[AutoCodeClassModes(
    Id = "vm",
    ClassStyle = AutoCodeGenerator.ClassStyleEnum.Inpc,
    InheritType = typeof(AutoCodeGenerator.InpcPropertyBindableBaseAbstract))]

Record 会为每个属性生成构造函数参数，参数名为属性名首字母小写（单字符属性保持原样，如 X → @X）。

继承与接口成员

• 源类型继承的其他接口成员上的 AutoCodeProperty 也会参与生成。
• InheritAttribute = true 时，源属性上的非生成器 Attribute（如 [DisplayName]）会复制到生成类。

生成文件命名

特性参考

安装包后，生成器会自动注入 AutoCodeGenerator 命名空间下的特性定义，无需手动引用程序集。

AutoCodeClassModesAttribute

标注在接口或类上，可多次使用。

AutoCodePropertyAttribute

标注在属性上。

AutoCodeNullableAttribute

标注在接口或类上，控制生成文件的 #nullable 指令（不可多次使用）。

NullableEnum 取值：

CustomAttributeAttribute

按 Id 为类或属性批量附加 Attribute 字符串，可与 AutoCodeClassModes / AutoCodeProperty 配合使用。

AccessibilityEnum

诊断

从 entity.json 生成

将 JSON 文件标记为 AdditionalFiles，文件名以 .entity.json 结尾：

<AdditionalFiles Include="Models\Customer.entity.json" />

示例

{
  "$schema": "https://raw.githubusercontent.com/mccj/AutoModeCodeGenerator/main/src/AutoModeCodeGenerator.Analyzers/EntityFiles/entity.schema.json",
  "namespace": "MyApp.Entities",
  "className": "Customer",
  "classStyle": "Poco",
  "nullable": "enable",
  "summary": "Customer entity",
  "properties": [
    { "name": "Id", "type": "int", "summary": "主键" },
    { "name": "Name", "type": "string", "isNullable": true }
  ]
}

NuGet 包内附带 content/entity.schema.json。可将该文件复制到项目中，并在 JSON 里通过相对路径引用 $schema，以获得编辑器补全与校验。

完整示例见 TestModel.entity.json。

JSON 字段参考

字段完整定义见包内 content/entity.schema.json 或仓库 entity.schema.json。

验证与测试

仓库提供 AutoModeCodeGenerator.Tests 项目，通过 Roslyn GeneratorDriver 在内存中验证生成结果与诊断行为：

dotnet test src/AutoModeCodeGenerator.Tests/AutoModeCodeGenerator.Tests.csproj

主要测试类：