golang从输入类型自动派生函数代码生成插件goderive的使用

goderive - Golang从输入类型自动派生函数代码生成插件

goderive是一个能够自动生成Golang函数的工具，它通过分析你的Go代码中未实现的函数，并根据输入参数类型自动生成这些函数的实现。

功能概述

goderive会扫描你的代码，寻找：

  1. 未实现（或之前已生成）的函数
  2. 具有特定前缀的函数（默认前缀是derive）

它会自动生成这些函数的实现，并保持它们与你的类型定义同步更新。

示例

以下是一个简单的Equal函数生成示例：

package main

type MyStruct struct {
    Int64     int64
    StringPtr *string
}

func (this *MyStruct) Equal(that *MyStruct) bool {
    return deriveEqual(this, that)
}

goderive会检测到deriveEqual函数未实现，然后在同包的derived.gen.go文件中生成以下代码：

func deriveEqual(this, that *MyStruct) bool {
    return (this == nil && that == nil) ||
        this != nil && that != nil &&
            this.Int64 == that.Int64 &&
            ((this.StringPtr == nil && that.StringPtr == nil) ||
        (this.StringPtr != nil && that.StringPtr != nil && *(this.StringPtr) == *(that.StringPtr)))
}

安装与使用

安装最新版本的goderive：

go install github.com/awalterschulze/goderive@latest

运行goderive（使用与go工具相同的路径语义）：

goderive ./...

支持的功能类型

递归函数

  • Equal - 生成相等比较函数
  • Compare - 生成比较函数
  • DeepCopy - 生成深拷贝函数
  • Clone - 生成克隆函数
  • GoString - 生成Go语法字符串表示
  • Hash - 生成哈希函数

集合操作

  • Keys - 获取map的键
  • Sort - 排序切片
  • Unique - 去重切片
  • Set - 将切片转为集合
  • Min/Max - 查找最小/最大值
  • Contains - 检查包含关系
  • Intersect/Union - 集合交集/并集

函数式操作

  • Fmap - 函数映射
  • Join - 连接操作
  • Flip - 翻转参数顺序
  • Curry/Uncurry - 柯里化/反柯里化
  • Compose - 函数组合
  • Mem - 记忆化
  • Traverse - 遍历操作

并发操作

  • Pipeline - 构建处理管道
  • Do - 并行执行
  • Dup - 通道复制

自定义与扩展

你可以通过以下方式自定义goderive：

  1. 修改函数前缀（默认是derive）
  2. 为不同类型创建不同的派生函数
  3. 启用autoname和dedup标志让goderive自动重命名函数
  4. 创建自己的代码生成器插件

完整示例

下面是一个更完整的示例，展示如何使用goderive生成多个类型的函数：

package main

type Person struct {
    Name string
    Age  int
}

type Point struct {
    X, Y float64
}

// 生成Person的相等比较函数
func (p *Person) Equal(other *Person) bool {
    return deriveEqualPerson(p, other)
}

// 生成Point的深拷贝函数
func (p *Point) Copy() *Point {
    newP := &Point{}
    deriveDeepCopyPoint(newP, p)
    return newP
}

// 生成Person的字符串表示
func (p *Person) String() string {
    return deriveGoStringPerson(p)
}

运行goderive后，它会生成所有需要的派生函数实现。

优势

使用goderive的主要优势：

  1. 减少样板代码编写
  2. 自动保持派生函数与类型定义同步
  3. 当类型变更时自动更新相关函数
  4. 支持多种常见操作的模式化实现

通过这种方式，你可以专注于业务逻辑，而让goderive处理那些重复性的函数实现。


更多关于golang从输入类型自动派生函数代码生成插件goderive的使用的实战教程也可以访问 https://www.itying.com/category-94-b0.html

1 回复

更多关于golang从输入类型自动派生函数代码生成插件goderive的使用的实战系列教程也可以访问 https://www.itying.com/category-94-b0.html


goderive - Go 自动代码生成插件使用指南

goderive 是一个强大的 Go 代码生成工具，它能够根据输入类型自动派生(derive)出各种常用函数实现，如 Equals、Compare、DeepCopy、String 等。下面我将详细介绍它的使用方法和示例。

安装 goderive

go install github.com/awalterschulze/goderive@latest

基本使用

1. 生成 Equals 方法

//go:generate goderive -autoname .

type Person struct {
    Name string
    Age  int
}

// 运行 go generate 后会生成以下函数:
// deriveEqualPerson(p1, p2 Person) bool

2. 生成 Compare 方法

//go:generate goderive -autoname .

type Product struct {
    ID    int
    Price float64
}

// 生成:
// deriveCompareProduct(p1, p2 Product) int
// 返回 -1/0/1 表示小于/等于/大于

常用功能示例

1. 自动生成 DeepCopy

//go:generate goderive -autoname .

type Node struct {
    Value int
    Next  *Node
}

// 生成:
// deriveDeepCopyNode(src *Node) *Node

2. 生成 String 方法

//go:generate goderive -autoname .

type Point struct {
    X, Y int
}

// 生成:
// deriveStringPoint(p Point) string

3. 生成 Hash 函数

//go:generate goderive -autoname .

type User struct {
    ID   int
    Name string
}

// 生成:
// deriveHashUser(u User) uint64

高级用法

1. 自定义生成函数名

//go:generate goderive -prefix=My .

type Book struct {
    Title  string
    Author string
}

// 生成:
// MyEqualBook(b1, b2 Book) bool
// MyCloneBook(b Book) Book

2. 选择性生成

//go:generate goderive -autoname -only=Equal,Clone .

type Config struct {
    Host string
    Port int
}

// 只生成 Equal 和 Clone 相关函数

实际项目集成示例

  1. 在项目中创建 derive.go 文件：
//go:generate goderive -autoname .

package main

type Employee struct {
    ID        int
    Name      string
    Department string
    Salary    float64
}

type Team struct {
    Lead     *Employee
    Members  []*Employee
    Projects []string
}
  1. 运行代码生成：
go generate ./...
  1. 使用生成的函数：
func main() {
    emp1 := &Employee{ID: 1, Name: "Alice", Department: "Engineering", Salary: 100000}
    emp2 := deriveDeepCopyEmployee(emp1)
    
    fmt.Println(deriveEqualEmployee(emp1, emp2)) // true
    
    emp2.Salary = 110000
    fmt.Println(deriveCompareEmployee(emp1, emp2)) // -1
    
    fmt.Println(deriveStringEmployee(emp1))
}

支持的派生函数列表

goderive 支持生成以下类型的函数：

  • Equal: 结构体相等比较
  • Compare: 结构体比较
  • DeepCopy: 深度拷贝
  • GoString: 生成 Go 语法字符串表示
  • String: 字符串表示
  • Hash: 哈希函数
  • Contains: 切片包含检查
  • Intersect: 切片交集
  • Union: 切片并集
  • Min/Max: 找最小/最大值
  • Sort: 排序
  • Unique: 去重

注意事项

  1. goderive 通过反射分析类型结构，确保导出的类型能被正确识别
  2. 生成的代码会放在 derive_*.go 文件中
  3. 对于复杂嵌套结构，可能需要递归生成
  4. 建议在 CI 流程中加入 go generate 步骤

goderive 可以显著减少模板代码的编写，提高开发效率，特别适合需要大量值类型比较、拷贝的场景。

回到顶部