構建 Go 應用 docker 映象的十八種姿勢

kevwan發表於2022-03-31
GoDocker

修煉背景

我夜以繼日，加班加點開發了一個最簡單的 Go Hello world 應用，雖然只是跑了列印一下就退出了，但是老闆也要求我上線這個我能寫出的唯一應用。

專案結構如下：

.
├── go.mod
└── hello.go

hello.go 程式碼如下：

package main

func main() {
    println("hello world!")
}

並且，老闆要求用 docker 部署，顯得我們們緊跟潮流，高大上一點。。。

第一次嘗試

我在拜訪了一些武林朋友之後，發現把整個過程丟到 docker 裡面去編譯一下就好了，一番琢磨之後，我得到了如下 Dockerfile:

FROM golang:alpine

WORKDIR /build

COPY hello.go .

RUN go build -o hello hello.go

CMD ["./hello"]

構建映象：

$ docker build -t hello:v1 .

搞定，讓我們湊近了看看。

$ docker run -it --rm hello:v1 ls -l /build
total 1260
-rwxr-xr-x    1 root     root       1281547 Mar  6 15:54 hello
-rw-r--r--    1 root     root            55 Mar  6 14:59 hello.go

好傢伙，我好不容易寫出來的程式碼也在裡面，看來程式碼不能寫的爛，不然運維妹子偷看了要笑話我。。。

我們再看看映象到底有多大，據說大了拉取映象就會比較慢呢

$ docker docker images | grep hello
hello 		v1    2783ee221014   44 minutes ago   314MB

哇，居然有314MB，難道 docker build 一下變 Java 了嗎？不是什麼東西都是越大越好的。。。

讓我們看看為啥這麼大！

看看，我們跑第一個指令（WORKDIR）前就已經300+MB了，有點猛啊！

不管怎麼說，我們先跑一下看看

$ docker run -it --rm hello:v1
hello world!

沒問題呀，好歹可以工作嘛～

第二次嘗試

經過一番菸酒，加上朋友指點，發現原來我們用的那個基礎映象實在太大了。

$ docker images | grep golang
golang    alpine     d026981a7165   2 days ago          313MB

並且朋友告訴我可以把程式碼先編譯好，再拷貝進去，就不用那個巨大的基礎映象了，不過說起來容易，我還是好好花了點功夫的，最後 Dockerfile 長這樣：

FROM alpine

WORKDIR /build

COPY hello .

CMD ["./hello"]

跑一下試試

$ docker build -t hello:v2 .
...
=> ERROR [3/3] COPY hello .                         0.0s
------
 > [3/3] COPY hello .:
------
failed to compute cache key: "/hello" not found: not found

不對，hello 找不到，忘記先編譯一下 hello.go 了，再來~

$ go build -o hello hello.go

再跑 docker build -t hello:v2 .，沒問題，走兩步試試。。。

$ docker run -it --rm hello:v2
standard_init_linux.go:228: exec user process caused: exec format error

失敗！好吧，格式不對，原來我們開發機不是 linux 呀，再來~

$ GOOS=linux go build -o hello hello.go

重新 docker build 終於搞定了，趕緊跑下

$ docker run -it --rm hello:v2
hello world!

沒問題，我們來看看內容和大小。

$ docker run -it --rm hello:v2 ls -l /build
total 1252
-rwxr-xr-x    1 root     root       1281587 Mar  6 16:18 hello

裡面只有 hello 這個可執行檔案，再也不用擔心別人鄙視我的程式碼了~

$ docker images | grep hello
hello    v2   0dd53f016c93   53 seconds ago      6.61MB
hello    v1   ac0e37173b85   25 minutes ago      314MB

哇，6.61MB，絕對可以！

看看，我們跑第一個指令（WORKDIR）前面只有 5.3MB 了，開心啊！

第三次嘗試

一頓炫耀之後，居然有人鄙視我，說現在流行什麼多階段構建，那麼第二種方式到底有啥問題呢？細細琢磨之後發現，我們要能從 Go 程式碼構建出 docker 映象，其中分為三步：

  1. 本機編譯 Go 程式碼，如果牽涉到 cgo 跨平臺編譯就會比較麻煩了
  2. 用編譯出的可執行檔案構建 docker 映象
  3. 編寫 shell 指令碼或者 makefile 讓這幾步通過一個命令可以獲得

多階段構建就是把這一切都放到一個 Dockerfile 裡，既沒有原始碼洩漏，又不需要用指令碼去跨平臺編譯，還獲得了最小的映象。

愛學習，追求完美的我最終寫出瞭如下 Dockerfile，多一行則肥，少一行則瘦：

FROM golang:alpine AS builder

WORKDIR /build

ADD go.mod .
COPY . .
RUN go build -o hello hello.go


FROM alpine

WORKDIR /build
COPY --from=builder /build/hello /build/hello

CMD ["./hello"]

第一個 FROM 開始的部分是構建一個 builder 映象，目的是在其中編譯出可執行檔案 hello，第二個 From 開始的部分是從第一個映象裡 copy 出來可執行檔案 hello，並且用盡可能小的基礎映象 alpine 以保障最終映象儘可能小，至於為啥不用更小的 scratch，是因為 scratch 真的啥也沒有，有問題連上去看一眼的機會都沒有，而 alpine 也才 5MB，對我們的服務不會構成多少影響。

我們先跑了驗證一下：

$ docker run -it --rm hello:v3
hello world!

沒問題，正如預期！看看大小如何：

$ docker images | grep hello
hello    v3     f51e1116be11   8 hours ago    6.61MB
hello    v2     0dd53f016c93   8 hours ago    6.61MB
hello    v1     ac0e37173b85   8 hours ago    314MB

跟第二種方法構建的映象大小完全一樣。再看看映象裡的內容：

$ docker run -it --rm hello:v3 ls -l /build
total 1252
-rwxr-xr-x    1 root     root       1281547 Mar  6 16:32 hello

也是隻有一個可執行的 hello 檔案，完美！

跟第二個最終映象基本是一致的，但我們簡化了流程，只需要一個 Dockerfile，跑一條命令就好了，不需要我去整那些晦澀難懂的 shell 和 makefile 了。

神功練成

至此，團隊小夥伴都覺得完美，紛紛給我點贊！但是，既追求完美，又喜歡偷懶（摸魚）的我覺得吧，每次都讓我寫出這麼個增一行則肥，減一行則瘦的 Dockerfile，我還是覺得挺煩的，於是我瞞著老闆寫了個工具，我來秀一秀~~

# 安裝一下先
$ GOPROXY=https://goproxy.cn/,direct go install github.com/zeromicro/go-zero/tools/goctl@latest
# 一鍵編寫 Dockerfile
$ goctl docker -go hello.go

搞定！看看生成的 Dockerfile 哈

FROM golang:alpine AS builder

LABEL stage=gobuilder

ENV CGO_ENABLED 0
ENV GOPROXY https://goproxy.cn,direct

RUN apk update --no-cache && apk add --no-cache tzdata

WORKDIR /build

ADD go.mod .
ADD go.sum .
RUN go mod download
COPY . .
RUN go build -ldflags="-s -w" -o /app/hello ./hello.go


FROM alpine

RUN apk update --no-cache && apk add --no-cache ca-certificates
COPY --from=builder /usr/share/zoneinfo/Asia/Shanghai /usr/share/zoneinfo/Asia/Shanghai
ENV TZ Asia/Shanghai

WORKDIR /app
COPY --from=builder /app/hello /app/hello

CMD ["./hello"]

其中幾點可以瞭解下：

  • 預設禁用了 cgo
  • 啟用了 GOPROXY 加速 go mod download
  • 去掉了除錯資訊 -ldflags="-s -w" 以減小映象尺寸
  • 安裝了 ca-certificates，這樣使用 TLS證照就沒問題了
  • tzdata 在 builder 映象安裝，並在最終映象只拷貝了需要的時區
  • 自動設定了本地時區，這樣我們在日誌裡看到的是北京時間了

我們看看用這個自動生成的 Dockerfile 構建出的映象大小：

$ docker images | grep hello
hello     v4    94ba3ece3071   4 hours ago     6.66MB
hello     v3    f51e1116be11   8 hours ago     6.61MB
hello     v2    0dd53f016c93   8 hours ago     6.61MB
hello     v1    ac0e37173b85   9 hours ago     314MB

略微大一點，這是因為我們拷貝了 ca-certificates 和 tzdata。驗證一下：

我們看看映象裡有啥：

$ docker run -it --rm hello:v4 ls -l /app
total 832
-rwxr-xr-x    1 root     root        851968 Mar  7 08:36 hello

也是隻有 hello 可執行檔案，並且檔案大小從原來的 1281KB 減到了 851KB。跑一下看看：

$ docker run -it --rm hello:v4
hello world!

並且你可以在生成 Dockerfile 的時候指定基礎映象為 scratch，這樣映象就更小了，但是你就不能直接通過 sh 登陸進去了。

$ goctl docker -base scratch -go hello.go

尺寸也是真的好小：

$ docker images | grep hello
hello   v5   d084eed88d88   4 seconds ago   1.07MB
hello   v4   94ba3ece3071   15 hours ago    6.66MB
hello   v3   f51e1116be11   4 days ago      6.61MB
hello   v2   0dd53f016c93   4 days ago      6.61MB
hello   v1   ac0e37173b85   4 days ago      314MB

再看看映象裡都有啥

我這是在 Macbook M1 上編譯的是 linux/arm64 映象，我猜你常規的是要打 linux/amd64 的映象，用下面這個命令就好：

$ docker build --rm --platform linux/amd64 -t hello:v6 .

好了好了，不再糾纏 Dockerfile 了，我要去學習新技能了～

專案地址

https://github.com/zeromicro/go-zero

覺得不錯嗎？歡迎打賞吆，打賞只需點亮 GitHub 小星星⭐️

微信交流群

關注『微服務實踐』公眾號並點選 交流群 獲取社群群二維碼。

相關文章