优化 Makefile 的质量

最新推荐文章于 2024-02-09 16:03:27 发布

물の韜

最新推荐文章于 2024-02-09 16:03:27 发布

阅读量142

点赞数 1

分类专栏：软件工具的使用系列文章标签：开发语言 golang 后端

本文链接：https://blog.csdn.net/qq_46457076/article/details/128883514

版权

软件工具的使用系列专栏收录该内容

18 篇文章 1 订阅

订阅专栏

Makefile 简介

Makefile 是和 make 命令一起配合使用的，很多大型项目的编译都是通过 Makefile 来组织的，若没有 Makefile ，那么很多项目中各种库和代码之间的依赖关系不知会有多复杂。

优化 Makefile 的质量

熟练掌握 Makefile 的语法

“ 工欲善其事，必先利其器 ”，编写高质量的 Makefile 第一步便是熟练掌握 Makefile 的核心语法。

Makefile 的语法比较多，包括 Makefile 规则语法、伪目标、变量赋值、条件语句和 Makefile 常用函数等，参考学习 Makefile 语法。

规划 Makefile 要实现的功能

提前规划好功能，有利于设计 Makefile 的整体结构和实现方法。对于 Go 项目来说，虽然不同项目集成的功能不一样，但绝大部分项目都需要实现一些通用的功能，例如在一个 Go 项目中，通过 Makefile 可以实现以下功能：

Usage: make <TARGETS> <OPTIONS> ...

Targets:
  # 代码生成类命令
  gen                Generate all necessary files, such as error code files.

  # 格式化类命令
  format             Gofmt (reformat) package sources (exclude vendor dir if existed).

  # 静态代码检查
  lint               Check syntax and styling of go sources.

  # 测试类命令
  test               Run unit test.
  cover              Run unit test and get test coverage.

  # 构建类命令
  build              Build source code for host platform.
  build.multiarch    Build source code for multiple platforms. See option PLATFORMS.

  # Docker 镜像打包类命令
  image              Build docker images for host arch.
  image.multiarch    Build docker images for multiple platforms. See option PLATFORMS.
  push               Build docker images for host arch and push images to registry.
  push.multiarch     Build docker images for multiple platforms and push images to registry.

  # 部署类命令
  deploy             Deploy updated components to development env.

  # 清理类命令
  clean              Remove all files that are created by building.

  # 其他命令，不同项目会有区别
  release            Release iam
  verify-copyright   Verify the boilerplate headers for all files.
  ca                 Generate CA files for all iam components.
  install            Install iam system with all its components.
  swagger            Generate swagger document.
  tools              install dependent tools.

  # 帮助命令
  help               Show this help info.

# 选项
Options:
  DEBUG        Whether to generate debug symbols. Default is 0.
  BINS         The binaries to build. Default is all of cmd.
               This option is available when using: make build/build.multiarch
               Example: make build BINS="iam-apiserver iam-authz-server"
  ...

通常，在 Go 项目中的 Makefile 应该实现以下功能：

格式化代码、静态代码检查、单元测试、代码构建、文件清理、帮助等功能。
如果需通过 docker 部署，还需要有 docker 镜像打包的功能，因为 Go 语言是跨平台的语言，所以构建和 docker 打包命令，还要能够支持不同的 CPU 架构和平台。
为了能够更好地控制 Makefile 命令的行为，还需要支持 Options 功能。

为了方便查看 Makefile 集成了哪些功能，需要支持 help 命令，help 命令最好通过解析 Makefile 文件来输出集成的功能，例如如下的形式：

## help: Show this help info.
.PHONY: help
help: Makefile
  @echo -e "\nUsage: make <TARGETS> <OPTIONS> ...\n\nTargets:"
  @sed -n 's/^##//p' $< | column -t -s ':' | sed -e 's/^/ /'
  @echo "$$USAGE_OPTIONS"

上面的 help 命令，通过解析 Makefile 文件中的 ## 注释，获取支持的命令。

设计合理的Makefile结构

设计完 Makefile 需要实现的功能后需要设计出一个合理的 Makefile 结构，采用分层的设计方法（根目录下的 Makefile 聚合所有的 Makefile 命令，具体实现则按功能分类，放在另外的 Makefile 中），一个合理的 Makefile 结构还应该具有前瞻性（即在不改变现有结构的情况下，接纳后面的新功能）

例如在 Makefile 命令中集成 shell 脚本，如果 shell 脚本过于复杂，也会导致 Makefile 内容过多，难以阅读和维护。对于这种情况，可以将复杂的 shell 命令封装在 shell 脚本中，供 Makefile 直接调用，而一些简单的命令则可以直接集成在 Makefile 中，如采用以下类似的 Makefile 结构：

在上面的 Makefile 组织方式中，根目录下的 Makefile 聚合了项目所有的管理功能，这些管理功能通过 Makefile 伪目标的方式实现。同时，还将这些伪目标进行分类，把相同类别的伪目标放在同一个 Makefile 中，这样可以使得 Makefile 更容易维护。对于复杂的命令，则编写成独立的 shell 脚本并在 Makefile 命令中调用这些 shell 脚本。

为了与 Makefile 的层级相匹配，golang.mk 中的所有目标都按 go.xxx 这种方式命名，通过这种命名方式可以很容易分辨出某个目标完成什么功能，放在什么文件里，如以下项目根目录下的 Makefile 的内容摘录：

include scripts/make-rules/golang.mk
include scripts/make-rules/image.mk
include scripts/make-rules/gen.mk
include scripts/make-rules/...

## build: Build source code for host platform.
.PHONY: build
build:
	@$(MAKE) go.build

## build.multiarch: Build source code for multiple platforms. See option PLATFORMS.
.PHONY: build.multiarch
build.multiarch:
	@$(MAKE) go.build.multiarch

## image: Build docker images for host arch.
.PHONY: image
image:
	@$(MAKE) image.build

## push: Build docker images for host arch and push images to registry.
.PHONY: push
push:
	@$(MAKE) image.push

## ca: Generate CA files for all iam components.
.PHONY: ca
ca:
	@$(MAKE) gen.ca