如何使用 Docker 高效部署 Node 應用

本文收錄於 GitHub 山月行博客: shfshanyue/blog，內含我在實際工做中碰到的問題、關於業務的思考及在全棧方向上的學習

• 前端工程化系列
• Node進階系列

如何在生產環境部署一個 Node 應用？

一個合理而且高效的部署方案，不只可以實現快速升級，平滑切換，負載均衡，應用隔離等部署特性，並且配有一套成熟穩定的監控。

kubernetes 把 Node 應用視做一個服務端應用的黑盒子，完美匹配了以上條件，愈來愈多的團隊把 node 部署在 k8s 上。

但在此以前，須要先把 Node 應用跑在一個 Docker 容器上，這也是本章的主題。

關於前端在 docker 上部署，山月曾寫了兩篇文章：

1. 如何在 docker 中部署前端
2. 前端部署 Prview 與 Production
3. 前端部署的發展過程

一個簡單的 Node 應用

index.js

一個 hello, world 版的 Node Web App

const http = require('http')

const app = async (req, res) => {
  res.end('hello, world')
}

http.createServer(app).listen(3000, () => console.log(3000))

package.json

配置 npm start 來啓動應用

"scripts": {
  "start": "node index.js"
},

但這僅僅是最簡單的 Node 應用，真實環境中還有各類數據存儲及定時任務調度等，暫撇開不談，這已經足夠了。

再稍微複雜一點點的 Node 應用能夠查看山月的項目 whoami: 一個最簡化的 serverless 與 dockerize 示例。

NODE_ENV=production

在生產環境中，無需安裝 devDependecies 中依賴，NODE_ENV 環境變量設置爲 production 時將會跳過 devDep。

# 經過設置環境變量，只安裝生產環境依賴
$ NODE_ENV=production npm ci

# 經過顯式指定 flag，只安裝生產環境依賴
$ npm ci --production

另外一方面，某些第三方模塊會根據 NODE_ENV 環境變量作出一些意料不到的配置。所以在生產環境注意該環境變量的配置。

一個 Node 應用的簡單部署

一個典型的、面向服務端的 Node 應用是這麼跑起來的:

1. npm install
2. npm run config，從配置服務(consul/vault)拉取配置 ，如數據庫與緩存的帳號密碼，此時構建服務器須要配置服務權限
3. npm run migrate，數據庫遷移腳本，執行數據庫表列行更改操做，此時構建服務器須要數據庫訪問權限
4. npm start，啓動一個 Node 服務

把運行步驟翻譯爲 Dockerfile:

# 選擇一個體積小的鏡像 (~5MB)
FROM node:12-alpine

# 環境變量設置爲生產環境
ENV NODE_ENV production

WORKDIR /code

# 更好的根據 Image Layer 利用緩存
ADD package.json package-lock.json /code
RUN npm ci

ADD . /code

# 配置服務及數據庫遷移
RUN npm run config --if-present && npm run migrate --if-present

EXPOSE 3000
CMD npm start

這對於大部分 Node 應用已是足夠了，若是精益求精，能夠再走接下來的多階段構建

node-gyp 與 Native Addon

在 Node 中有可能存在着一些 Native Addon，它們經過 node-gyp 進行編譯，而它依賴於 python，make 與 g++。

$ apk --no-cache add python make g++

在帶有編譯過程的鏡像構建中，源文件與構建工具都會形成空間的浪費。藉助鏡像的多階段構建能夠高效利用空間。Go App 與 FE App 的構建也遵循此規則。

• 多階段構建 Go 應用
• 多階段構建前端應用

在構建 Node 應用鏡像時，第一層鏡像用以構造 node_modules。

# 選擇一個體積小的鏡像 (~5MB)
FROM node:12-alpine as builder

# 環境變量設置爲生產環境
ENV NODE_ENV production

# 更好的根據 Image Layer 利用緩存
ADD package.json package-lock.json ./
RUN npm ci

# 多階段構建之第二階段
# 多階段構建之第二階段
# 多階段構建之第二階段
FROM node:12-alpine

WORKDIR /code
ENV NODE_ENV production

ADD . .
COPY --from=builder node_modules node_modules
# 配置服務及數據庫遷移
RUN npm run config --if-present && npm run migrate --if-present

EXPOSE 3000
CMD npm start

相關文章

1. N-API and getting started with writing C addons for Node.js
2. Using Docker for Node.js in Development and Production