Go astutil.DeleteImport 怎样移除指定导入路径

我在做 Go 源码重写时遇到过一个很具体的清理任务：一份文件里有多个 import，只想移除某一个路径，不能靠字符串替换误伤别的声明。这个场景可以交给 golang.org/x/tools/go/ast/astutil 的 DeleteImport。

结论：先用 parser.ParseFile 得到 *ast.File，再调用 astutil.DeleteImport(fset, file, path)。返回值为 true 说明至少删除了一个匹配路径；最后使用 format.Node 把修改后的 AST 输出成 Go 源码。

官方地址：https://pkg.go.dev/golang.org/x/tools/go/ast/astutil#DeleteImport

我先把问题收窄到一个导入路径

DeleteImport 的签名是：

func DeleteImport(fset *token.FileSet, f *ast.File, path string) (deleted bool)

它按导入路径匹配，而不是按源码中显示的变量名匹配。比如下面两个声明的路径分别是 net/http 和 encoding/json，本次任务只删除前者：

package demo

import (
	"encoding/json"
	"net/http"
)

func main() {
	_ = json.Valid
	_ = http.MethodGet
}

这种边界很重要：文章只处理 AST 中的导入声明，不负责分析删除后业务代码是否仍然引用了被移除的包。若调用方仍使用该包名，后续编译自然会失败，这属于调用方需要继续处理的源码一致性问题。

先解析源码，再修改 ast.File

我习惯把解析和修改拆成两个阶段。解析阶段创建一个 token.FileSet，把源代码交给 parser.ParseFile；修改阶段只操作返回的 *ast.File。这样可以把语法错误和“路径没有找到”区分开。

package main

import (
	"bytes"
	"fmt"
	"go/format"
	"go/parser"
	"go/token"

	"golang.org/x/tools/go/ast/astutil"
)

func removeImport(src []byte, target string) ([]byte, bool, error) {
	// FileSet 保存 AST 的位置信息，解析和格式化要复用同一个集合。
	fset := token.NewFileSet()
	file, err := parser.ParseFile(fset, "input.go", src, parser.ParseComments)
	if err != nil {
		// 语法不完整时直接返回，避免把解析失败误判成未找到导入。
		return nil, false, fmt.Errorf("parse Go source: %w", err)
	}

	// path 按 import 的字符串路径匹配，例如 "net/http"。
	deleted := astutil.DeleteImport(fset, file, target)

	var out bytes.Buffer
	if err := format.Node(&out, fset, file); err != nil {
		// AST 被修改后仍需经过格式化，输出错误也要交给调用方处理。
		return nil, deleted, fmt.Errorf("format Go AST: %w", err)
	}
	return out.Bytes(), deleted, nil
}

func main() {
	// 输入同时包含目标导入和需要保留的导入。
	src := []byte("package demo\n\nimport (\n\t\\\"encoding/json\\\"\n\t\\\"net/http\\\"\n)\n")
	result, deleted, err := removeImport(src, "net/http")
	if err != nil {
		panic(err)
	}
	fmt.Printf("deleted=%t\\n%s", deleted, result)
}

这里的关键不是“删除一行文本”，而是让 astutil 根据 AST 中的 ImportSpec 改动导入列表。format.Node 负责把修改后的节点按 Go 源码格式写回缓冲区。

用返回值区分“删到了”和“本来就没有”

DeleteImport 返回一个布尔值。目标路径存在时返回 true；不存在时返回 false，但这不是错误。这个语义适合做幂等的源码清理：第一次可能删除，第二次对同一个 AST 再删就不会产生变化。

deleted := astutil.DeleteImport(fset, file, "net/http")
if !deleted {
	// false 只说明没有匹配声明，是否报错由业务策略决定。
	fmt.Println("target import was not present")
}

如果你的工具要求“必须清理掉目标依赖”，可以把 false 记为业务错误；如果只是重复执行整理步骤，通常把它当成无变化结果即可。

别名和重复声明要按路径理解

导入别名改变的是源码里的本地名称，不改变导入路径。下面的 web 只是别名，路径仍然是 net/http，因此按路径删除时会被匹配：

import web "net/http"

官方文档还明确说明：如果文件里存在重复的目标导入声明，所有匹配项都会删除。实际 Go 源码通常不会保留这种重复声明，但源码生成器、合并器或中间态 AST 可能遇到它，所以不要把返回值理解成“只删了一行”。

如果业务需要只针对别名和路径的组合做判断，可以进一步考虑 DeleteNamedImport；当前标题的任务只要求按路径删除，因此调用 DeleteImport 就足够。

解析失败和输出失败不要混成删除失败

完整流程里至少有三种结果：源码解析失败、AST 格式化失败、解析和格式化都成功但没有找到目标路径。它们的处理方式不同：

我会把原始输入和格式化输出分开保存，只有 format.Node 成功后才替换文件。这样即使上游传入了残缺源码，也不会因为“目标导入没删掉”而覆盖原文件。

最后检查保留项，而不是只看删除项

调用成功后，最小复查是把输出重新作为文本或 AST 输入，确认目标路径不再出现，同时仍保留需要的导入。这里的复查不是重新发请求，而是源码编辑器本身的结果判断：

// 只展示调用方可以采用的结果判断，不依赖线上环境。
if bytes.Contains(result, []byte(`"net/http"`)) {
	return fmt.Errorf("target import still exists")
}
if !bytes.Contains(result, []byte(`"encoding/json"`)) {
	return fmt.Errorf("required import was removed unexpectedly")
}

如果源码中还使用了被删除包的标识符，最终编译检查会暴露问题。DeleteImport 只负责导入声明本身，不会自动删除或重写其它 AST 节点。

常见追问

DeleteImport 找不到路径时会返回 error 吗？

不会。它返回 false 表示没有匹配的导入声明；解析和格式化错误则由各自的函数返回。

有别名时应该传别名还是路径？

使用 DeleteImport 时传完整导入路径，例如 net/http，不是源码里的别名。需要同时约束别名时再考虑 DeleteNamedImport。

删除导入后会自动清理无用代码吗？

不会。函数修改的是 ast.File 的导入声明，调用方仍需处理引用、格式化和后续编译。

总结：把任务拆成“解析源码—按路径调用 DeleteImport—依据 bool 判断—格式化输出”四步，就能稳定移除指定导入。记住它按路径匹配、重复匹配会全部删除，而且不会替你修复其它 AST 引用。