如何使用Golang的gopls触发代码生成？

如何使用Golang的gopls触发代码生成？ 这更像是一个功能请求。我想知道目前是否有任何方法，或者是否有计划允许我们接入 gopls 来生成代码。

如果能在文件更改时触发 //go:generate 那就太棒了。

1 回复

更多关于如何使用Golang的gopls触发代码生成？的实战系列教程也可以访问 https://www.itying.com/category-94-b0.html


目前，gopls 本身并不直接支持触发或执行 //go:generate 指令。//go:generate 是由 Go 工具链中的 go generate 命令处理的，它独立于编辑器或语言服务器。

不过，你可以通过以下方式在开发流程中集成代码生成：

1. 手动运行 go generate

在项目根目录或特定包目录下执行：

go generate ./...

这会递归处理所有 //go:generate 指令。

2. 通过构建工具集成

例如，在 Makefile 中添加：

generate:
    go generate ./...

然后运行 make generate。

3. 利用编辑器/IDE 功能

许多编辑器允许配置自定义命令。以 VS Code 为例，可以在 .vscode/tasks.json 中添加：

{
    "version": "2.0.0",
    "tasks": [
        {
            "label": "go generate",
            "type": "shell",
            "command": "go generate ./...",
            "group": {
                "kind": "build",
                "isDefault": false
            },
            "presentation": {
                "reveal": "always"
            }
        }
    ]
}

然后通过命令面板运行该任务。

4. 文件监视与自动触发

可以使用文件监视工具（如 entr、nodemon）在文件更改时自动触发：

# 使用 entr 监视 .go 文件
find . -name '*.go' | entr -r go generate ./...

5. 通过 gopls 的代码操作（Code Actions）

虽然 gopls 不直接支持生成代码，但你可以通过实现自定义的代码操作来间接触发。这需要编写 gopls 插件或扩展，目前属于较高级的用法。

示例：通过 LSP 客户端发送自定义请求（概念性代码）：

// 注意：这需要客户端和服务端的共同支持
conn.Notify(context.Background(), "workspace/executeCommand", map[string]interface{}{
    "command": "generate",
    "arguments": []string{"./..."},
})

当前限制

  • gopls 主要专注于代码分析、补全、导航等语言服务功能。
  • 代码生成通常被视为构建过程的一部分，而非编辑器实时功能。

替代方案

如果你希望在保存文件时自动生成代码，可以考虑使用编辑器插件或钩子。例如，在 VS Code 中安装 Run on Save 扩展，并配置：

{
    "emeraldwalk.runonsave": {
        "commands": [
            {
                "match": "\\.go$",
                "cmd": "cd ${workspaceRoot} && go generate ./..."
            }
        ]
    }
}

虽然 gopls 没有内置的代码生成触发功能，但通过上述方法可以在开发环境中实现类似的自动化效果。

回到顶部