Golang递归执行go generate并支持正则过滤的插件

在Go语言中，go generate是一个强大的代码生成工具，但默认情况下它不支持递归执行和正则过滤。下面我将介绍如何实现一个支持这些功能的插件。

基本实现思路

1. 递归遍历目录结构
2. 在每个目录中查找go generate指令
3. 根据正则表达式过滤需要处理的文件
4. 执行匹配文件的生成命令

示例代码

package main

import (
	"fmt"
	"io/fs"
	"os"
	"os/exec"
	"path/filepath"
	"regexp"
)

func main() {
	// 获取当前工作目录
	root, err := os.Getwd()
	if err != nil {
		fmt.Printf("获取当前目录失败: %v\n", err)
		os.Exit(1)
	}

	// 定义正则表达式过滤条件
	pattern := `.*\.go$` // 默认匹配所有.go文件
	if len(os.Args) > 1 {
		pattern = os.Args[1]
	}

	// 编译正则表达式
	re, err := regexp.Compile(pattern)
	if err != nil {
		fmt.Printf("无效的正则表达式: %v\n", err)
		os.Exit(1)
	}

	// 递归处理目录
	err = filepath.WalkDir(root, func(path string, d fs.DirEntry, err error) error {
		if err != nil {
			return err
		}

		// 只处理.go文件
		if !d.IsDir() && re.MatchString(path) {
			processGoFile(path)
		}

		return nil
	})

	if err != nil {
		fmt.Printf("遍历目录失败: %v\n", err)
		os.Exit(1)
	}
}

func processGoFile(filePath string) {
	// 读取文件内容
	content, err := os.ReadFile(filePath)
	if err != nil {
		fmt.Printf("读取文件 %s 失败: %v\n", filePath, err)
		return
	}

	// 查找go:generate指令
	generateRe := regexp.MustCompile(`//go:generate (.+)`)
	matches := generateRe.FindAllStringSubmatch(string(content), -1)

	if len(matches) == 0 {
		return
	}

	// 获取文件所在目录
	dir := filepath.Dir(filePath)

	// 执行每个generate命令
	for _, match := range matches {
		if len(match) < 2 {
			continue
		}

		cmdStr := match[1]
		fmt.Printf("在 %s 中执行: %s\n", dir, cmdStr)

		// 创建命令
		cmd := exec.Command("sh", "-c", cmdStr)
		cmd.Dir = dir
		cmd.Stdout = os.Stdout
		cmd.Stderr = os.Stderr

		// 执行命令
		if err := cmd.Run(); err != nil {
			fmt.Printf("执行命令失败: %v\n", err)
		}
	}
}

使用方法

1. 将上述代码保存为generate.go
2. 编译：go build generate.go
3. 运行：
   • 递归处理所有.go文件：./generate
   • 只处理匹配特定模式的文件：./generate ".*_gen\.go$"

高级用法

1. 集成到项目中的Makefile

.PHONY: generate
generate:
	go build -o bin/generate ./tools/generate
	./bin/generate ".*_gen\.go$"

2. 支持自定义命令

可以修改代码，支持更多参数：

// 修改main函数开头
if len(os.Args) > 2 {
    fmt.Println("用法: generate [正则表达式] [命令]")
    os.Exit(1)
}

var customCmd string
if len(os.Args) > 2 {
    customCmd = os.Args[2]
}

// 修改processGoFile函数
if customCmd != "" {
    cmdStr = customCmd
}

3. 并行执行

对于大型项目，可以并行执行生成命令：

func processGoFile(filePath string, wg *sync.WaitGroup) {
    defer wg.Done()
    // ...原有代码...
}

// 在main函数中
var wg sync.WaitGroup
err = filepath.WalkDir(root, func(path string, d fs.DirEntry, err error) error {
    // ...
    if !d.IsDir() && re.MatchString(path) {
        wg.Add(1)
        go processGoFile(path, &wg)
    }
    // ...
})
wg.Wait()

注意事项

1. 确保所有生成命令是幂等的，避免重复生成导致问题
2. 大型项目中使用并行执行时要注意资源消耗
3. 考虑添加-dry-run标志来预览将要执行的命令
4. 处理符号链接时要小心，避免无限循环

这个工具可以大大简化大型项目中代码生成的管理，特别是当项目结构复杂、有多个需要生成的代码文件时。