工具目录 (/tools)

相关源文件

• README.md
• README_es.md
• tools/README.md

/tools 目录包含特定于您的 Go 项目的辅助工具。这些实用程序、脚本和程序有助于项目的开发、测试、构建或其他方面，但它们不是主应用程序功能的一部分。

来源: README.md158-162 tools/README.md1-3

目的与范围

/tools 目录用于托管辅助程序和实用程序，以支持您的项目的开发、构建和维护流程。与 /cmd (参见 命令目录) 中的应用程序代码或 /pkg (参见 包目录) 中的库代码不同，此目录中的工具面向的是开发人员和操作员，而不是最终用户。

工具的一个关键特性是它们可以导入项目自身的 /pkg 和 /internal 目录中的代码，从而允许它们利用项目自身的代码来执行其支持功能。

来源: README.md158-162 tools/README.md1-3

在项目结构中的位置

/tools 目录被视为支持目录，而不是核心应用程序结构的一部分。它位于项目根级别，与 /cmd、/internal 和 /pkg 等目录并列。

来源: README.md151-162

导入关系

与大多数外部代码不同，工具可以导入项目公共 (/pkg) 和私有 (/internal) 目录中的代码。此功能允许工具利用项目自身的代码来执行诸如代码生成、测试或部署之类的任务。

来源: README.md158-162 tools/README.md1-3

常见工具类型

/tools 目录通常包含支持开发生命周期各个方面的各种实用程序。

来源: README.md158-162 tools/README.md1-3

开发生命周期中的工具集成

/tools 目录中的工具支持开发生命周期的各个阶段，从开发过程中的代码生成到构建和部署支持。

来源: README.md158-162

Go Modules 集成

/tools 目录的一个常见做法是使用 Go Modules 来管理工具依赖。这通常通过创建 "tools.go" 文件来完成，该文件导入工具，但使用构建标签将其从常规构建中排除。

示例结构

/tools/
├── tools.go       # Imports all required tools
├── codegen/       # Code generation tools
├── analysis/      # Code analysis tools
└── build/         # Build-related tools

tools.go 文件可能看起来像

这种方法可确保所有工具都经过版本控制，并可以使用 go install 轻松安装。

来源: README.md158-162 tools/README.md1-9

最佳实践

1. 工具隔离：将每个工具放在其自己的子目录中，以保持关注点的清晰分离。

2. 文档：为每个工具包含 README 文件，解释其目的、用法和任何配置要求。

3. 版本控制：使用 Go Modules 显式版本化工具依赖项。

4. 项目特定工具：如果某个工具与您的项目高度相关，请将其放在 /tools 目录中，而不是作为单独的存储库。

5. 代码复用：利用您项目自身的 /pkg 和 /internal 目录中的代码，以避免重复。

来源: README.md158-162 tools/README.md1-9

现实世界中的例子

一些重要的 Go 项目遵循此模式，包括：

• Istio: https://github.com/istio/istio/tree/master/tools
• OpenShift: https://github.com/openshift/origin/tree/master/tools
• Dapr: https://github.com/dapr/dapr/tree/master/tools

这些项目使用它们的 /tools 目录来实现各种目的，包括代码生成、测试、代码检查和构建自动化。

来源: tools/README.md5-9

总结

/tools 目录是项目特定实用程序和支持程序的家园，它们有助于开发、测试、构建和维护。它通过提供可以利用项目自身代码的专用工具，来展示项目对可维护性和开发者体验的承诺。