適用於 Go 項目的 Makefile 指南

適用於 Go 項目的 Makefile 指南

大家好，我叫謝偉，是一名使用 Go 語言的後端開發者。

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

1. 前提：

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

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

命令來執行。

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

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

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

2. Makefile 語法

PROJECT="example"

default:
    echo ${PROJECT}

install:
    @govendor sync -v
    
test: install
    @go test ./...

.PHONY: default install test

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

格式介紹：

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

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

3. Go 項目

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

一個完善的 Go 項目經常會執行哪些命令？

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

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

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

所以整體可以如下安排：

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

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

default:
    @go build -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 "Please run 'make fmt' and commit the result:"; \
        echo "$${diff}"; \
        exit 1; \
    fi;

install:
    @govendor sync -v

test:
    @go test -cpu=1,2,4 -v -tags integration ./...

vet:
    @go vet $(VETPACKAGES)

docker:
    @docker build -t wuxiaoxiaoshen/example:latest .

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

.PHONY: default fmt fmt-check install test vet docker clean

4. 補充

Makefile 構建工具，大大的簡化了構建項目的難度。

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

比如新合併的代碼，先觸發單元測試，靜態檢查等，在執行 CI 腳本，成功之後，再構建鏡像，推送鏡像到服務器上，完成持續集成和持續部署一整套流程。

Makefile 通常配合 travis 使用。

比如：

language: go
go:
  - "1.11"
  - "1.11.x"
env:
  - GO111MODULE=on
notifications:
  email:
    recipients:
      - [email protected]
    on_success: change # default: change
    on_failure: always # default: always

before_install:
  - go test -cpu=1,2,4 -v -tags integration ./...
  - go vet $(go list ./... | grep -v /vendor/)

script:
  - make fmt
  - make fmt-check
  - make vet
  - make list  
  - go test -race  ./... -coverprofile=coverage.txt -covermode=atomic

希望對大家有所啓發。

<完>

參考：

• Makefile
• TravisCI