如何复用 Makefile 片段:基于 Git 子模块的模块化构建实践

夏磊同学_3798

夏磊同学_3798

2026-05-18

243人浏览

原创

本文介绍一种轻量、可靠且可维护的 Makefile 复用方案:通过 Git 子模块将通用构建逻辑抽离为独立仓库,并在各 Go 项目中以 include 方式导入,避免重复粘贴、提升一致性与可升级性。

本文介绍一种轻量、可靠且可维护的 makefile 复用方案:通过 git 子模块将通用构建逻辑抽离为独立仓库,并在各 go 项目中以 `include` 方式导入,避免重复粘贴、提升一致性与可升级性。

在多 Go 项目协作或快速原型开发中,开发者常面临 Makefile 逻辑高度雷同的问题——如 go build、goimports -w、依赖同步、测试覆盖等任务几乎每个项目都要重写一遍。直接复制粘贴(Copy & Paste)虽快,却带来严重维护负担:一处修复需同步修改数十个项目;新增功能易遗漏;不同项目间行为逐渐偏离。

一个简洁而工程友好的解法是:将通用 Makefile 片段提取为独立 Git 仓库,并通过子模块(git submodule)引入主项目,再用 GNU Make 的 include 指令加载复用逻辑。

✅ 实践步骤

  1. 创建专用 Makefile 仓库
    新建仓库(如 gomakefiles),仅存放 .mk 文件,例如:

    # gomakefiles/go-build.mk
    .PHONY: build
    build: $(SOURCES)
     @echo "→ Formatting source files..."
     goimports -w $(SOURCES)
     @echo "→ Installing dependencies..."
     go get ./...
     @echo "→ Building binary..."
     go build -o $(APP_NAME) .
  2. 在项目中添加子模块

    git submodule add https://github.com/milanaleksic/gomakefiles.git vendor/makefiles
    git commit -m "feat: add shared makefiles via submodule"
  3. 编写精简根 Makefile
    主项目根目录下保留极简 Makefile,专注项目特有变量与入口:

    # Makefile
    APP_NAME := jenkins_ping
    SOURCES := $(shell find . -name '*.go' -not -path "./vendor/*")
    
    # 导入共享逻辑(路径需匹配 submodule 目录)
    include vendor/makefiles/go-build.mk
    
    .PHONY: all
    all: build

✅ 优势显著:

GitHub一键发布助手(专业版)
GitHub一键发布助手(专业版)

本地项目发布到GitHub的完整工作流助手。自动执行:安全检查(.gitignore、排除敏感.env/凭据文件)、补齐开源文件(LICENSE、.gitignore)、git init/commit/branch、创建远程仓库、首次推送、可选打tag。支持git filter-repo历史敏感信息重写、force push、tag管理。Windows下走Credential Manager自动认证。触发词:"发布到GitHub"、"上传到github"、&quot

下载
  • 零网络依赖:子模块内容本地化,构建不依赖 GitHub raw CDN 或网络稳定性;
  • 版本可控:git submodule update --remote 可批量升级所有项目到指定 commit/tag;
  • 按需组合:支持多个 .mk 文件(如 go-test.mk、go-lint.mk),通过 include 灵活组装;
  • IDE 友好:VS Code、JetBrains 等工具能正常识别 include 的目标与变量。

⚠️ 注意事项:

  • 避免在子模块 Makefile 中使用绝对路径或硬编码项目名,应全部通过主 Makefile 传入变量(如 APP_NAME, SOURCES);
  • 子模块更新后需 git add vendor/makefiles && git commit 提交新 SHA,否则 CI/其他协作者无法同步变更;
  • 若需完全自动化 CI 场景,可在 CI 脚本中添加 git submodule update --init --recursive。

这种“模块化 Makefile”模式已在多个 Go 工具链项目中验证可行(如 jenkins_ping),兼顾简洁性与扩展性——它不是银弹,但却是比 curl 下载原始文件或全量复制更可持续的工程选择。

相关专题

更多
自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

2023.07.05

7739

9

git和svn的区别
git和svn的区别

git和svn的区别:1、定义不同;2、模型类型不同;3、存储单元不同;4、是否拥有全局版本号;5、内容完整性不同;6、版本库不同;7、克隆目录速度不同;8、分支不同。php中文网为大家带来了git和svn的相关知识、以及相关文章等内容。

2023.07.06

2120

6

git撤销提交的commit
git撤销提交的commit

Git是一个强大的版本控制系统,它提供了很多功能帮助开发人员有效地管理和控制代码的变更,本专题为大家提供git 撤销提交的commit相关的各种文章内容,供大家免费下载体验。

2023.07.24

1274

5

git提交错误怎么撤回
git提交错误怎么撤回

git提交错误撤回的方法:git reset head^:撤回最后一次提交,恢复到提交前状态。git revert head:创建新提交,内容与之前提交相反。git reset :使用提交的 sha-1 哈希撤回指定提交。交互式舞台区:标记要撤回的特定更改,然后提交,排除已撤回更改。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.09

4997

7

git怎么对比两个版本的文件内容
git怎么对比两个版本的文件内容

要对比两个版本的 git 文件,请使用 git diff 命令:git diff 比较工作树和暂存区之间的差异。git diff 比较两个提交或标签之间的差异。git diff 输出显示差异块,其中 + 表示添加的行,- 表示删除的行, 表示修改的行。可使用 gitkraken、meld、beyond compare 等可视化工具更直观地查看差异。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.09

5001

6

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

2026.11.12

140

15

Go-Zero安装与goctl环境配置教程
Go-Zero安装与goctl环境配置教程

本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.12

100

15

Go-Zero零基础入门教程
Go-Zero零基础入门教程

本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。

2026.11.12

100

15

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

2026.11.06

160

12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Postman Native Git工作流指南
Postman Native Git工作流指南

共0课时 | 0人学习

vscode手册
vscode手册

共0课时 | 0人学习

Git 教程
Git 教程

共21课时 | 8.2万人学习