如何在Go语言中跨模块导入测试代码且不暴露到生产代码？

问题描述 #

• 项目包含两个模块：logutils（日志工具库模块）和authentication（认证应用模块）
• logutils实现了TestLogger结构体，它实现了Logger接口，仅用于测试场景：将日志写入缓冲区，方便测试结束后验证日志内容
• 若将TestLogger放在logutils/test-logger_test.go中，authentication/login_tests.go编译时会报错，提示TestLogger未声明
• 临时解决方案是将文件重命名为logutils/test-logger.go，但这样生产代码也能引用TestLogger，存在误用风险
• 核心需求：让logutils的任意_test.go文件代码能被authentication的任意_test.go文件导入，但绝对禁止生产代码引用

问题原因 #

这是Go语言的原生设计特性：

• 后缀为_test.go的文件属于测试专属文件，Go编译生产代码时会完全忽略这类文件
• 运行go test时，每个模块的测试代码只会与当前模块的生产代码、当前模块的测试文件一同编译，不会导入其他模块的_test.go文件内容

可行解决方法 #

1. 构建标签（Build Tags）控制编译 #

将TestLogger放在logutils/test-logger.go中，在文件顶部添加构建标签：

//go:build test
// +build test

• 生产代码编译时（默认不带-tags test参数），该文件会被忽略，避免被生产代码引用
• authentication模块运行测试时，需要带上标签参数：

  go test ./authentication -tags test
  

这种方法无需调整包结构，通过编译标签精准控制文件的编译场景。

2. 创建测试专属子包 #

在logutils模块下新建一个子包（比如logutils/testing），将TestLogger的代码放在该子包的常规.go文件中（如testlogger.go）：

• 在子包的注释中明确标注此包仅用于测试，生产代码禁止导入
• 配合golangci-lint等工具添加自定义规则，检查生产代码是否误导入了该测试包
• authentication的测试代码可以正常导入your-module-path/logutils/testing来使用TestLogger

3. 复制测试工具代码（仅适用于小型工具） #

如果TestLogger逻辑简单，可以直接将其代码复制到authentication模块的_test.go文件或测试专属子包中。但这种方法会导致代码冗余，后续维护成本高，仅推荐用于极小体量的测试工具。

内容的提问来源于stack exchange，提问作者Simz84