Golang基于Go类型生成任意代码及类型转换器插件库Copygen的使用

Copygen是一个命令行和程序化的代码生成器，可以生成基于类型的自定义代码，包括类型到类型和字段到字段的代码，而无需向项目添加任何反射或依赖项。

什么是Copygen？

Copygen是一个基于类型的代码生成器，可以避免编写重复代码而浪费时间。它支持所有Go类型，包括basic、array、slice、map、chan、interface和func类型。

如何使用Copygen？

步骤1. 定义Go类型

在文件中定义Go类型。

./domain/domain.go

// Package domain包含业务逻辑模型。
package domain

// Account表示用户账户。
type Account struct {
	ID     int
	UserID string
	Name   string
	Other  string // 其他字段未使用。
}

./models/model.go

// Package models包含数据存储模型（如数据库）。
package models

// Account表示账户的数据模型。
type Account struct {
	ID       int
	Name     string
	Password string
	Email    string
}

// User表示用户的数据模型。
type User struct {
	UserID   int
	Name     string
	UserData string
}

步骤2. 配置设置文件

使用YML和GO文件设置Copygen。

setup.yml

# 定义代码生成的位置。
generated:
  setup: ./setup.go
  output: ../copygen.go

  # 定义用于生成文件的可选自定义模板（支持.go、.tmpl）。
  # template: ./generate.go

# 定义自定义选项（传递给生成器选项）以进行自定义。
custom:
  option: 可能性是无限的。

setup.go

/* 指定生成文件的包名。 */
package copygen

/* Copygen定义了生成的函数。 */
type Copygen interface {
  // custom 查看下表获取选项
  ModelsToDomain(*models.Account, *models.User) *domain.Account
}

步骤3. 使用命令行

安装命令行工具Copygen：

go install github.com/switchupcb/copygen@latest

运行可执行文件：

copygen -yml path/to/yml

输出示例

生成的copygen.go文件：

// Code generated by github.com/switchupcb/copygen
// DO NOT EDIT.

// Package copygen包含copygen生成代码的设置信息。
package copygen

import (
	c "strconv"

	"github.com/switchupcb/copygen/examples/main/domain"
	"github.com/switchupcb/copygen/examples/main/models"
)

// Itoa将整数转换为ASCII值。
func Itoa(i int) string {
	return c.Itoa(i)
}

// ModelsToDomain将*models.Account、*models.User复制到*domain.Account。
func ModelsToDomain(tA *domain.Account, fA *models.Account, fU *models.User) {
	// *domain.Account字段
	tA.ID = fA.ID
	tA.UserID = Itoa(fU.UserID)
	tA.Name = fA.Name
}

自定义选项

Copygen提供了多种选项来自定义代码生成：

转换和类型转换

使用convert function field选项控制类型或字段在匹配时的复制方式：

/* 使用正则表达式定义此转换器应用的函数和字段。 */
// convert .* models.User.UserID
// Itoa将整数转换为ASCII值。
func Itoa(i int) string {
	return c.Itoa(i)
}

使用场景

Copygen的默认目的是通过生成代码来映射对象，从而节省时间。典型使用场景包括：

• 在不同的模型类型（如domain和database）之间转换
• 生成业务逻辑仓库包
• 为API请求生成包装函数

许可证

Copygen使用AGPLv3许可证。生成的代码可以不受限制地使用（包括专有和商业用途），但对Copygen软件源代码的修改或以编程方式在大型工作中实现Copygen需要遵守AGPLv3许可证。

完整示例Demo

以下是一个完整的示例，展示如何使用Copygen生成类型转换代码：

1. 首先定义你的领域模型和数据模型（如上所示）
2. 创建setup.yml和setup.go配置文件
3. 运行Copygen生成代码
4. 使用生成的函数进行类型转换

// 使用生成的函数
func main() {
    // 创建模型实例
    modelAcc := &models.Account{ID: 1, Name: "John"}
    modelUser := &models.User{UserID: 123, Name: "Doe"}
    
    // 转换为领域模型
    domainAcc := ModelsToDomain(modelAcc, modelUser)
    
    fmt.Printf("转换结果: %+v\n", domainAcc)
}

这个示例展示了如何轻松地在不同模型之间转换数据，而无需手动编写重复的赋值代码。