适用于Go语言的 Makefile 极速入门指南
本文目标
含一定复杂度的软件工程,基本上都是先编译 A,再依赖 B,再编译 C…,最后才执行构建。如果每次都人为编排,又或是每新来一个同事就问你项目 D 怎么构建、重新构建需要注意什么…等等情况,岂不是要崩溃?
我们常常会在开源项目中发现 Makefile,你是否有过疑问?
本章节会简单介绍 Makefile 的使用方式,最后建议深入学习。
怎么解决
对于构建编排,Docker 有 Dockerfile ,在 Unix 中有神器 Make ….
Make
是什么
Make 是一个构建自动化工具,会在当前目录下寻找 Makefile 或 makefile 文件。如果存在,会依据 Makefile 的构建规则去完成构建
当然了,实际上 Makefile 内都是你根据 make 语法规则,自己编写的特定 Shell 命令等
它是一个工具,规则也很简单。在支持的范围内,编译 A, 依赖 B,再编译 C,完全没问题
规则
Makefile 由多条规则组成,每条规则都以一个 target(目标)开头,后跟一个 : 冒号,冒号后是这一个目标的 prerequisites(前置条件)
紧接着新的一行,必须以一个 tab 作为开头,后面跟随 command(命令),也就是你希望这一个 target 所执行的构建命令
[target] ... : [prerequisites] ...
<tab>[command]
...
...
- target:一个目标代表一条规则,可以是一个或多个文件名。也可以是某个操作的名字(标签),称为伪目标(phony)
- prerequisites:前置条件,这一项是可选参数。通常是多个文件名、伪目标。它的作用是 target 是否需要重新构建的标准,如果前置条件不存在或有过更新(文件的最后一次修改时间)则认为 target 需要重新构建
- command:构建这一个 target 的具体命令集
简单的例子
当前目录结构:
$ ls -l
-rw-rw-r-- 1 zengfeng zengfeng 0 12月 30 17:51 image
-rw-rw-r-- 1 zengfeng zengfeng 127 12月 30 18:07 makefile
以下是这个 makefile 文件的内容:
.PHONY: flashcard put-files
put-files:
echo "i am put-files"
image:
@echo "i am image"
flashcard:
@echo "i am flashcard"
各个makefile的输出结果如下:
$ make
echo "i am put-files"
i am put-files
$ make put-files
echo "i am put-files"
i am put-files
$ make image
make: 'image' is up to date.
$ make flashcard
i am flashcard
.PHONY 的作用
在上述文件中,使用了 .PHONY
,其作用是声明 flashcard / put-files / image 为伪目标,声明为伪目标会怎么样呢?
- 声明为伪目标后:在执行对应的命令时,make 就不会去检查是否存在 build / clean / tool / lint / help 其对应的文件,而是每次都会运行标签对应的命令
- 若不声明:恰好存在对应的文件,则 make 将会认为 xx 文件已存在,没有重新构建的必要了。
可以对比上面例子中的 make put-files
和 make image
。由于当前目录下已经存在 image 文件,所以这时候不会执行make image
。
单单一个 make 的作用
make: 单单一个make只会列表中的第一个target,在这里就等同于 make put-files。
可以查看上面例子中的 make
输出结果。
命令前面@符号的作用
make 默认会打印每条命令,再执行。这个行为被定义为回声。可以在对应命令前加上 @,可指定该命令不被打印到标准输出上。
可以对比上面例子中的 make put-files
和 make flashcard
。
小结
这是一篇比较简洁的文章,希望可以让您对 Makefile 有一个基本了解。
参考文章
「番外」请入门 Makefile (eddycjy.com)