Golang构建工具之Makefile

一、Make是什么

Make是一个自动化构建工具，会在当前目录下寻找 Makefile 或 makefile 文件。如果存在，会依据 Makefile 的构建规则去完成构建。实际上，Makefile内都是你根据 make 语法规则，自己编写的特定 Shell 命令等。

二、Makefile 规则

Makefile文件是多条规则的集合体，每条规则都以一个target（目标）开头，后面接一个 ：冒号，冒号后是这一个目标的 prerequisites（前置条件）。接着新开启一行，必须以一个 tab 开头，后面跟随 command（命令），也就是你希望这一个 target 所执行的构建命令

• target：一个目标代表一条规则，可以是一个或多个文件名，也可以是某个操作的名字（标签），称为伪目标（phony）
• prerequisites：前置条件，这一项是可选参数。通常是多个文件名、伪目标。它的作用是确定 target 是否需要重新构建，如果前置条件不存在或有过更新（文件的最后一次修改时间）则认为 target 需要重新构建
• command：构建这一个 target 的具体命令集

在编写 Makefile 前，需要先分析构建先后顺序、依赖项，需要解决的问题等

三、Makefile支持功能

• make build: 编译
• make vendor: 下载依赖
• make api: 生成协议代码
• make json: easyjson 代码生成
• make test: 运行单元测试
• make benchmark: 运行性能测试
• make stat: 代码复杂度统计，代码行数统计
• make clean: 清理 build 目录
• make deep_clean: 清理所有代码以外的其他文件
• make third: 下载所有依赖的第三方工具
• make protoc: 下载 protobuf 工具
• make glide: 下载 glide 依赖管理工具
• make golang: 下载 golang 环境
• make cloc: 下载 cloc 统计工具
• make gocyclo: 下载 gocyclo 圈复杂度计算工具
• make easyjson: 下载 easyjson 工具

四、举例分析

.PHONY: build clean tool lint help

all: build

build:
    go build -v .

tool:
    go tool vet . |& grep -v vendor; true
    gofmt -w .

lint:
    golint ./...

clean:
    rm -rf go-gin-example
    go clean -i .

help:
    @echo "make: compile packages and dependencies"
    @echo "make tool: run specified go tool"
    @echo "make lint: golint ./..."
    @echo "make clean: remove object files and cached files"

分析1:
在上述文件中，使用了 .PHONY，其作用是声明 build / clean / tool / lint / help 为伪目标。

声明为伪目标会怎么样呢？声明为伪目标后，在执行对应的命令时，make 就不会去检查是否存在 build / clean / tool / lint / help 其对应的文件，而是每次都会运行标签对应的命令。

若不声明，恰好存在对应的文件，则 make 将会认为 xx 文件已存在，没有重新构建的必要了

分析2:

• make: 就是 make all
• make build: 编译当前项目的包和依赖项
• make tool: 运行指定的 Go 工具集
• make lint: golint一下
• make clean: 删除对象文件和缓存文件
• make help: help

分析3:
针对会打印执行命令的问题，产生原因是：make 默认会打印每条命令，再执行。这个行为被定义为回声。可以在对应命令前加上 @，可指定该命令不被打印到标准输出上

例如：

build:
    @go build -v .