使用 Make 构建项目

构建工具 make 是在公司写 Go 项目的时候新学的，当时只是按需边搜索边写，没有过系统的总结，因为使用效率很高，所以这次简单整理下。

我的新书《LangChain编程从入门到实践》 已经开售！推荐正在学习AI应用开发的朋友购买阅读！

Makefile文件

• 构建规则都写在 Makefile 文件里面，Make 命令实际上取决于 Makefile 文件，Makefile文件由一系列规则（rules）构成。每条规则的形式如下:

  <target> : <prerequisites> 
  [tab]  <commands>

• 上面第一行冒号前面的部分，叫做”目标”（target），冒号后面的部分叫做”前置条件”（prerequisites）；第二行必须由一个tab键起首，后面跟着”命令”（commands）。
• “目标”是必需的，不可省略；”前置条件”和”命令”都是可选的，但是两者之中必须至少存在一个。(实际项目中绝大多数采用目标：命令)
• 每条规则就明确两件事：构建目标的前置条件是什么，以及如何构建。

  目标（target）

• 一个目标（target）就构成一条规则。实际项目中目标通常是某个具体操作的名字，这称为”伪目标”（phony target）。比如 Go 项目中

  # 移除编译的二进制文件
  clean:
  	@if [ -f ${BINARY} ] ; then rm ${BINARY} ; fi

• 到时候直接运行 make clean即可，如果当前目录中，正好有一个文件叫做clean，那么这个命令不会执行。因为Make发现clean文件已经存在，就认为没有必要重新构建了，就不会执行指定的rm命令。为了避免这种情况，可以明确声明clean是”伪目标”，写法如下：

  clean:
      @if [ -f ${BINARY} ] ; then rm ${BINARY} ; fi
  .PHONY: clean

• 声明clean是”伪目标”之后，make就不会去检查是否存在一个叫做clean的文件，而是每次运行都执行对应的命令。类似.PHONY这样的声明具体查看手册。

注意：如果Make命令运行时没有指定目标，默认会执行Makefile文件的第一个目标。

前置条件（prerequisites）

• 前置条件通常是一组文件名，之间用空格分隔。它指定了”目标”是否重新构建的判断标准：只要有一个前置文件不存在，或者有过更新（前置文件的last-modification时间戳比目标的时间戳新），”目标”就需要重新构建。

  result.txt: source.txt
      cp source.txt result.txt

• 上面代码中，构建 result.txt 的前置条件是 source.txt 。如果当前目录中，source.txt 已经存在，那么make result.txt可以正常运行，否则必须再写一条规则，来生成 source.txt 。

  命令（commands）

• 命令（commands）表示如何更新目标文件，由一行或多行的Shell命令组成。它是构建”目标”的具体指令，它的运行结果通常就是生成目标文件。
• 需要注意的是，每行命令在一个单独的shell中执行。这些Shell之间没有继承关系。解决办法是将两行命令写在一行，中间用分号分隔。

  clean:
  	@if [ -f ${BINARY} ] ; then rm ${BINARY} ; fi

• 另一个解决办法是在换行符前加反斜杠转义。

  fmt-check:
  	@diff=$$(gofmt -s -d $(GOFILES)); \
  	if [ -n "$$diff" ]; then \
  		echo "Please run 'make fmt' and commit the result:"; \
  		echo "$${diff}"; \
  		exit 1; \
  	fi;

  Makefile文件的语法

  echo

• 正常情况下，make会打印每条命令，然后再执行，这就叫做回声（echoing）。在命令的前面加上@，就可以关闭回声。
• 由于在构建过程中，需要了解当前在执行哪条命令，所以通常只在注释和纯显示的echo命令前面加上@。

  PACKAGES=`go list ./... | grep -v /vendor/`
  list:
  	@echo ${PACKAGES}

  通配符

• 通配符（wildcard）用来指定一组符合条件的文件名。Makefile 的通配符与 Bash 一致，主要有星号（*）、问号（？）和 […]

  模式匹配

• Make命令允许对文件名，进行类似正则运算的匹配，主要用到的匹配符是%。比如，假定当前目录下有 f1.c 和 f2.c 两个源码文件，需要将它们编译为对应的对象文件。

  %.o: %.c

• 使用匹配符%，可以将大量同类型的文件，只用一条规则就完成构建

  变量和赋值符

• Makefile 允许使用等号自定义变量，调用时，变量需要放在 $( ) 之中。调用Shell变量，需要在美元符号前，再加一个美元符号，这是因为Make命令会对美元符号转义。

  参考链接

• Make 命令教程
• 跟我一起写Makefile