使用 Makefile 简化工作流¶

本文转载了阮一峰的 Make 命令教程。

使用 Makefile，我们可以将复杂的命令、脚本打包成一条命令，从而简化工作流程。

代码变成可执行文件，叫做编译（compile）；先编译这个，还是先编译那个（即编译的安排），叫做构建（build）。

Make是最常用的构建工具，诞生于 1977 年，主要用于 C 语言的项目。但是实际上，任何只要某个文件有变化，就要重新构建的项目，都可以用 Make 构建。

本文介绍 Make 命令的用法，从简单的讲起，不需要任何基础，只要会使用命令行，就能看懂。我的参考资料主要是 Isaac Schlueter 的《Makefile 文件教程》和《GNU Make 手册》。

Make 的概念¶

Make 这个词，英语的意思是"制作"。Make 命令直接用了这个意思，就是要做出某个文件。比如，要做出文件 a.txt，就可以执行下面的命令。

Bash

$ make a.txt

但是，如果你真的输入这条命令，它并不会起作用。因为 Make 命令本身并不知道，如何做出 a.txt，需要有人告诉它，如何调用其他命令完成这个目标。

比如，假设文件 a.txt 依赖于 b.txt 和 c.txt，是后面两个文件连接（cat 命令）的产物。那么，make 需要知道下面的规则。

Bash

a.txt: b.txt c.txt
    cat b.txt c.txt > a.txt

也就是说，make a.txt 这条命令的背后，实际上分成两步：第一步，确认 b.txt 和 c.txt 必须已经存在，第二步使用 cat 命令将这个两个文件合并，输出为新文件。

像这样的规则，都写在一个叫做 Makefile 的文件中，Make 命令依赖这个文件进行构建。Makefile 文件也可以写为 makefile，或者用命令行参数指定为其他文件名。

Bash

$ make -f rules.txt
# 或者
$ make --file=rules.txt

上面代码指定 make 命令依据 rules.txt 文件中的规则，进行构建。

总之，make 只是一个根据指定的 Shell 命令进行构建的工具。它的规则很简单，你规定要构建哪个文件、它依赖哪些源文件，当那些文件有变动时，如何重新构建它。

Makefile 文件的格式¶

构建规则都写在 Makefile 文件里面，要学会如何 Make 命令，就必须学会如何编写 Makefile 文件。

概述¶

Makefile 文件由一系列规则（rules）构成。每条规则的形式如下。

Bash

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

上面第一行冒号前面的部分，叫做"目标"（target），冒号后面的部分叫做"前置条件"（prerequisites）；第二行必须由一个 tab 键起首，后面跟着"命令"（commands）。

"目标"是必需的，不可省略；"前置条件"和"命令"都是可选的，但是两者之中必须至少存在一个。

每条规则就明确两件事：构建目标的前置条件是什么，以及如何构建。下面就详细讲解，每条规则的这三个组成部分。

目标（target）¶

一个目标（target）就构成一条规则。目标通常是文件名，指明 Make 命令所要构建的对象，比如上文的 a.txt。目标可以是一个文件名，也可以是多个文件名，之间用空格分隔。

除了文件名，目标还可以是某个操作的名字，这称为"伪目标"（phony target）。

Bash

clean:
      rm *.o

上面代码的目标是 clean，它不是文件名，而是一个操作的名字，属于"伪目标 "，作用是删除对象文件。

Bash

$ make clean

但是，如果当前目录中，正好有一个文件叫做 clean，那么这个命令不会执行。因为 Make 发现 clean 文件已经存在，就认为没有必要重新构建了，就不会执行指定的 rm 命令。

为了避免这种情况，可以明确声明 clean 是"伪目标"，写法如下。

Bash

.PHONY: clean
clean:
        rm *.o temp

声明 clean 是"伪目标"之后，make 就不会去检查是否存在一个叫做 clean 的文件，而是每次运行都执行对应的命令。像.PHONY 这样的内置目标名还有不少，可以查看手册。

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

Bash

$ make

上面代码执行 Makefile 文件的第一个目标。

前置条件（prerequisites）¶

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

Bash

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

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

Bash

source.txt:
    echo "this is the source" > source.txt

上面代码中，source.txt 后面没有前置条件，就意味着它跟其他文件都无关，只要这个文件还不存在，每次调用make source.txt，它都会生成。

Bash

$ make result.txt
$ make result.txt

上面命令连续执行两次make result.txt。第一次执行会先新建 source.txt，然后再新建 result.txt。第二次执行，Make 发现 source.txt 没有变动（时间戳晚于 result.txt），就不会执行任何操作，result.txt 也不会重新生成。

如果需要生成多个文件，往往采用下面的写法。

Bash

source: file1 file2 file3

上面代码中，source 是一个伪目标，只有三个前置文件，没有任何对应的命令。

Bash

$ make source

执行make source命令后，就会一次性生成 file1，file2，file3 三个文件。这比下面的写法要方便很多。

Bash

$ make file1 $ make file2 $ make file3

命令（commands）¶

命令（commands）表示如何更新目标文件，由一行或多行的 Shell 命令组成。它是构建"目标"的具体指令，它的运行结果通常就是生成目标文件。

每行命令之前必须有一个 tab 键。如果想用其他键，可以用内置变量.RECIPEPREFIX 声明。

Bash

.RECIPEPREFIX = >
all:
> echo Hello, world

上面代码用.RECIPEPREFIX 指定，大于号（>）替代 tab 键。所以，每一行命令的起首变成了大于号，而不是 tab 键。

需要注意的是，每行命令在一个单独的 shell 中执行。这些 Shell 之间没有继承关系。

Bash

var-lost:
    export foo=bar
    echo "foo=[$$foo]"

上面代码执行后（make var-lost），取不到 foo 的值。因为两行命令在两个不同的进程执行。一个解决办法是将两行命令写在一行，中间用分号分隔。

Bash

var-kept:
    export foo=bar; echo "foo=[$$foo]"

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

Bash

var-kept:
    export foo=bar; \
    echo "foo=[$$foo]"

最后一个方法是加上.ONESHELL:命令。

Bash

.ONESHELL:
var-kept:
    export foo=bar; 
    echo "foo=[$$foo]"

Makefile 文件的语法¶

注释¶

井号（#）在 Makefile 中表示注释。

Bash

# 这是注释
result.txt: source.txt
    # 这是注释
    cp source.txt result.txt # 这也是注释

回声（echoing）¶

正常情况下，make 会打印每条命令，然后再执行，这就叫做回声（echoing）。

Bash

test:
    # 这是测试

执行上面的规则，会得到下面的结果。

Bash

$ make test
# 这是测试

在命令的前面加上@，就可以关闭回声。

Bash

test:
    @# 这是测试

现在再执行make test，就不会有任何输出。

由于在构建过程中，需要了解当前在执行哪条命令，所以通常只在注释和纯显示的 echo 命令前面加上@。

Bash

test:
    @# 这是测试
    @echo TODO

通配符¶

通配符（wildcard）用来指定一组符合条件的文件名。Makefile 的通配符与 Bash 一致，主要有星号（*）、问号（？）和 [...] 。比如， *.o 表示所有后缀名为 o 的文件。

Bash

clean:
        rm -f *.o

模式匹配¶

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

Bash

%.o: %.c

等同于下面的写法。

Bash

f1.o: f1.c
f2.o: f2.c

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

变量和赋值符¶

Makefile 允许使用等号自定义变量。

Bash

txt = Hello World
test:
    @echo $(txt)

上面代码中，变量 txt 等于 Hello World。调用时，变量需要放在 $( ) 之中。

调用 Shell 变量，需要在美元符号前，再加一个美元符号，这是因为 Make 命令会对美元符号转义。

Bash

test:
    @echo $$HOME

有时，变量的值可能指向另一个变量。

Bash

v1 = $(v2)

上面代码中，变量 v1 的值是另一个变量 v2。这时会产生一个问题，v1 的值到底在定义时扩展（静态扩展），还是在运行时扩展（动态扩展）？如果 v2 的值是动态的，这两种扩展方式的结果可能会差异很大。

为了解决类似问题，Makefile 一共提供了四个赋值运算符（=、:=、？=、+=），它们的区别请看StackOverflow。

Bash

VARIABLE = value
# 在执行时扩展，允许递归扩展。

VARIABLE := value
# 在定义时扩展。

VARIABLE ?= value
# 只有在该变量为空时才设置值。

VARIABLE += value
# 将值追加到变量的尾端。

更多进阶内容可以参考：阮一峰 - Make 命令教程。

使用示例¶

以下是一个 Makefile 示例。在项目中添加本文件后，只需要 make lint 就可以使用 autocorrect 来进行文本检查，make all 就可以一键更新博客。

Makefile

.PHONY: all lint fix serve push deploy

all: lint fix push deploy
lint:
    autocorrect --lint ./
fix:
    autocorrect --fix ./
serve:
    mkdocs serve
push:
    git add . ;\
    git commit -m ":sparkles: docs: update" ;\
    git push
deploy:
    mkdocs gh-deploy --force

使用 Makefile 简化工作流¶

Make 的概念¶

Makefile 文件的格式¶

概述¶

目标（target）¶

前置条件（prerequisites）¶

命令（commands）¶

Makefile 文件的语法¶

注释¶

回声（echoing）¶

通配符¶

模式匹配¶

变量和赋值符¶

使用示例¶

评论