TypeGen 开源项目教程

TypeGen 开源项目教程

项目介绍

TypeGen 是一个用于将 C# 类转换为 TypeScript 类的开源工具。它支持生成单个 TypeScript 文件，每个文件对应一个 C# 类。TypeGen 提供了丰富的功能，包括生成 TypeScript 类、接口和枚举，支持集合、泛型类型和继承，以及可自定义的命名约定转换。

项目快速启动

安装 TypeGen

首先，通过 NuGet 安装 TypeGen：

dotnet add package TypeGen --version 5.0.1

配置 TypeGen

在你的项目中创建一个生成规范文件（例如 MyGenerationSpec.cs）：

public class MyGenerationSpec : GenerationSpec
{
    public MyGenerationSpec()
    {
        AddClass<ProductDto>();
    }
}

然后，在项目根目录下创建一个 tgconfig.json 文件：

{
    "generationSpecs": ["MyGenerationSpec"]
}

生成 TypeScript 文件

构建你的项目，然后在 Package Manager Console 中运行以下命令：

TypeGen generate

或者在系统控制台中运行：

dotnet typegen generate

完成后，你会在项目根目录下看到生成的 TypeScript 文件（例如 product-dto.ts）。

应用案例和最佳实践

使用属性导出

你可以使用属性来标记要导出的 C# 类：

[ExportTsClass]
public class ProductDto
{
    public decimal Price { get; set; }
    public string[] Tags { get; set; }
}

使用生成规范文件

你也可以使用生成规范文件来指定要导出的类：

public class MyGenerationSpec : GenerationSpec
{
    public MyGenerationSpec()
    {
        AddClass<ProductDto>();
    }
}

最佳实践

• 确保你的 C# 类和 TypeScript 类之间的命名约定一致。
• 使用生成规范文件来管理复杂的导出需求。
• 定期更新 TypeGen 以获取最新的功能和修复。

典型生态项目

TypeGen 通常与其他 .NET 和 TypeScript 项目一起使用，例如：

• ASP.NET Core：用于后端服务。
• Angular：用于前端开发。
• Entity Framework Core：用于数据访问。

这些项目与 TypeGen 结合使用，可以实现从后端到前端的无缝数据类型转换，提高开发效率和代码一致性。