Go代码格式化该用gofmt还是goimports？

技术圈

发布于 2026-03-27 12:21:32

130

在Go语言开发中，你是否遇到过这样的困扰：代码中导入了未使用的包导致编译失败，或者忘记导入需要的包而不得不手动添加？这些看似琐碎的问题，实际上会消耗开发者大量时间。这篇文章要介绍的goimports工具，正是为了解决这些痛点而生。

goimports与gofmt的区别

很多Go开发者都熟悉gofmt，它是Go官方提供的代码格式化工具。那么goimports和gofmt有什么区别呢？

简单来说，goimports是gofmt的超集。gofmt负责格式化代码（缩进、括号位置等），会对同一个import块内的包按字母排序；而goimports在此基础上，还能自动管理import语句的增删、合并和分组。

两者的核心区别如下：

功能特性	gofmt	goimports
代码格式化	✓	✓
import块内按字母排序	✓	✓
按标准库/第三方库分组	✗	✓
合并多个import声明	✗	✓
自动添加缺失的import	✗	✓
自动删除未使用的import	✗	✓

举个例子，假设你的代码如下：

package main

import "os"
import "fmt"

func main() {
    fmt.Println("hello")
}

运行gofmt后，保持原样不变（gofmt不会合并独立的import声明）：

package main

import "os"
import "fmt"

func main() {
    fmt.Println("hello")
}

而运行goimports后，会合并import声明、按字母排序，并删除未使用的os包：

package main

import "fmt"

func main() {
    fmt.Println("hello")
}

再看一个分组排序的例子：

package main

import (
    "github.com/sirupsen/logrus"
    "fmt"
    "os"
)

func main() {
    fmt.Println("hello")
    logrus.Info("test")
    os.Exit(0)
}

gofmt只会按字母排序，不分组：

import (
    "fmt"
    "github.com/sirupsen/logrus"
    "os"
)

goimports会按标准库、第三方库分组，中间用空行分隔：

import (
    "fmt"
    "os"

    "github.com/sirupsen/logrus"
)

如果你的代码使用了某个包但忘记导入，goimports也会自动添加。这就是为什么推荐使用goimports替代gofmt的原因——它在gofmt的基础上做了更多，却不增加使用成本。

项目集成方案

安装goimports非常简单：

go install golang.org/x/tools/cmd/goimports@latest

基本使用方式：

goimports -w yourfile.go

参数-w表示直接修改文件。对于整个项目，可以结合find命令批量处理：

find . -name "*.go" -exec goimports -w {} \;

但手动执行命令并不是最佳实践，更好的方式是将其集成到开发流程中。

编辑器配置

让goimports在保存文件时自动运行，是最便捷的使用方式。

VS Code用户需要安装Go扩展，并在settings.json中配置：

{
    "[go]": {
        "editor.formatOnSave": true,
        "editor.defaultFormatter": "golang.org/x/tools/gopls"
    },
    "gopls": {
        "formatting.gofumpt": false
    }
}

注意：gopls默认使用gofmt格式化。要启用goimports功能，可以在gopls设置中配置相关选项，或直接在Go扩展设置中选择格式化工具。

GoLand用户可以通过Tools -> File Watchers添加watcher：

Program: goimports
Arguments: -w $FilePath$

Vim用户可以在.vimrc中添加：

let g:go_fmt_command = "goimports"
let g:go_fmt_autosave = 1

Git钩子集成

通过pre-commit钩子，可以在代码提交前自动格式化：

#!/bin/sh
gofiles=$(git diff --cached --name-only --diff-filter=ACM | grep '\.go$')
[ -z "$gofiles" ] && exit 0

goimports -w $gofiles
git add $gofiles

这样每次提交前都会自动格式化代码，确保提交的代码符合规范。

CI/CD流程集成

在持续集成中加入goimports检查，是保障代码质量的最后一道防线。以GitHub Actions为例：

- name: Check formatting
  run: |
    go install golang.org/x/tools/cmd/goimports@latest
    if [ -n "$(goimports -l .)" ]; then
      echo "Code is not formatted"
      exit 1
    fi

对于使用Makefile的项目，可以添加：

.PHONY: fmt check-fmt

fmt:
 goimports -w .

check-fmt:
 @if [ -n "$(shell goimports -l .)" ]; then \
  echo "Code is not formatted. Run 'make fmt'"; \
  exit 1; \
 fi