【導讀】本文是一篇 Go 項目的 Makefile 指南。

本文章的主題是: 編寫適用于 Go 項目的 Makefile 指南。

1. 前提：

• 會使用 Makefile
• 會使用 Go 編寫項目

編寫項目的過程中，經(jīng)常需要對文件進行編譯和執(zhí)行，查看功能開發(fā)或者修復的 Bug 是否正確。你當然可以直接執(zhí)行 go build 命令用來編譯，執(zhí)行 go run

命令來執(zhí)行。

在編寫 Go 項目其實還會經(jīng)常執(zhí)行些諸如 測試、格式檢查、庫下載安裝等命令。

當然你也可以編寫 shell 腳本來執(zhí)行這些命令，進一步進行了簡化。

其實有更好的選擇，即 Makefile。在諸多的開源項目中經(jīng)常能看到 Makefile 的身影。當你的項目中文件發(fā)生變化，都可以使用 Makefile 執(zhí)行命令來自動構(gòu)建

2. Makefile 語法

PROJECT="example"

default:
echo${PROJECT}

install:
@govendorsync-v

test:install
@gotest./...

.PHONY:defaultinstalltest

上文是一個非常簡單的 Makefile 文件，通過這些命令的編寫，直接執(zhí)行 make , make install, make test 等就能完成對應的命令。

格式介紹：

:
[tab]

• target : 即自定義的想要執(zhí)行的命令
• prerequisites: 前置條件，即執(zhí)行 target 命令之前執(zhí)行的命令
• commands : 具體的執(zhí)行的命令
• .PHONY 偽指令，內(nèi)置的關(guān)鍵字
• 不帶參數(shù)，默認執(zhí)行第一個 target
• @ 表示禁止回聲，即終端不會打印真實的執(zhí)行命令
• # 表示注釋
• ${val} 表示變量，和 shell 腳本中的變量的聲明和使用一致
• 允許使用 通配符

3. Go 項目

Go 中支持內(nèi)置的 go 命令，可以用來執(zhí)行：測試、編譯、運行、語法檢查等命令

一個完善的 Go 項目經(jīng)常會執(zhí)行哪些命令？

• go vet 靜態(tài)檢查
• go test 運行單元測試
• go fmt 格式化
• go build 編譯
• go run 運行...

所以一個適用于 Go 項目的 Makefile 也應該支持這些命令。

• make default : 編譯
• make fmt: 格式化
• make vet: 靜態(tài)檢查
• make test: 運行測試
• make install: 下載依賴庫
• make clean: 移除編譯的二進制文件

所以整體可以如下安排：

BINARY="example"
VERSION=1.0.0
BUILD=`date+%FT%T%z`

PACKAGES=`golist./...|grep-v/vendor/`
VETPACKAGES=`golist./...|grep-v/vendor/|grep-v/examples/`
GOFILES=`find.-name"*.go"-typef-not-path"./vendor/*"`

default:
@gobuild-o${BINARY}-tags=jsoniter

list:
@echo${PACKAGES}
@echo${VETPACKAGES}
@echo${GOFILES}

fmt:
@gofmt-s-w${GOFILES}

fmt-check:
@diff=?(gofmt-s-d$(GOFILES));
if[-n"$$diff"];then
echo"Pleaserun'makefmt'andcommittheresult:";
echo"$${diff}";
exit1;
fi;

install:
@govendorsync-v

test:
@gotest-cpu=1,2,4-v-tagsintegration./...

vet:
@govet$(VETPACKAGES)

docker:
@dockerbuild-twuxiaoxiaoshen/example:latest.

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

.PHONY:defaultfmtfmt-checkinstalltestvetdockerclean

4. 補充

Makefile 構(gòu)建工具，大大的簡化了構(gòu)建項目的難度。

真實的生產(chǎn)環(huán)境下，需要使用到CI/CD（持續(xù)集成和持續(xù)部署）， 所以 Makefile 也通常用來和 CI 工具配合使用。

比如新合并的代碼，先觸發(fā)單元測試，靜態(tài)檢查等，在執(zhí)行 CI 腳本，成功之后，再構(gòu)建鏡像，推送鏡像到服務器上，完成持續(xù)集成和持續(xù)部署一整套流程。

Makefile 通常配合 travis 使用。

比如：

language:go
go:
-"1.11"
-"1.11.x"
env:
-GO111MODULE=on
notifications:
email:
recipients:
-wuxiaoshen@shu.edu.cn
on_success:change#default:change
on_failure:always#default:always

before_install:
-gotest-cpu=1,2,4-v-tagsintegration./...
-govet$(golist./...|grep-v/vendor/)

script:
-makefmt
-makefmt-check
-makevet
-makelist
-gotest-race./...-coverprofile=coverage.txt-covermode=atomic

希望對大家有所啟發(fā)。