前後端分離，如何在前端專案中動態插入後端API基地址？（in docker）

有態度的小碼甲發表於2020-06-02
後端前端APIDocker

開門見山，本文分享前後端分離，容器化前端專案時動態插入後端API基地址，這是一個很讚的實踐，解決了前端專案容器化過程中受制後端呼叫的尷尬。

尷尬從何而來

常見的web前後端分離：前後端分開部署，前端專案由nginx承載打包檔案，反向代理請求。
應用的某些部分必須是可配置的，比如API呼叫基地址，
前端打包的時候需要統一插入該地址形成完整chunk files。

# ------------------------------------------------------
# generate chunk file
# ------------------------------------------------------
FROM node:10-alpine as builder

# install and cache app dependencies
COPY package.json package-lock.json ./
RUN npm install && mkdir /react-frontend && mv ./node_modules ./react-frontend
WORKDIR /react-frontend
COPY . .
RUN npm run build


# ------------------------------------------------------
# Production Build
# ------------------------------------------------------
FROM nginx:latest
COPY  nginx.conf  /etc/nginx/nginx.conf
COPY --from=builder /react-frontend/build /usr/share/nginx/html
EXPOSE 80
CMD ["nginx", "-g", "daemon off;"]

當在Docker中打包前端，或許會嘗試用映象構建引數Arg/Env來傳遞後端API呼叫基地址，但這樣是很不理想的：
打包時引數被統一插入，打包結果chunk files作為最終映象的一部分，導致最終的前端映象會與後端API地址強關聯。

或許你會針對不用的後端環境（canary、staging、production）構建不同的前端映象，但這是一次又一次的工作量，並不是最佳實踐。

下面分享一個容器執行階段動態插入後端API基地址的實踐

前端獨立部署，動態插入後端API基地址(in Docker)

我希望將API基地址延遲到生成容器階段(與構建映象的過程解耦)， 這樣我就可以使用一個映象，針對不同的環境傳參形成不同的前端容器。


前端專案插入配置的指令碼如下：

// FILE: set-env.ts
...
export const environment = {
  production: ${isProd},
  apiBaseUrl: 'API_BASE_URL',
  version: 'v${require('../package.json').version}'
};
...

我們在前端配置中寫入API_BASE_URL佔位符，按照既定流程前端打包；


Dockerfile CMD指令指示容器如何執行：

  • 用真實值替換前端chunk files中原插入的API_BASE_URL佔位符
  • 使用nginx承載替換後的chunk files
# FILE: Dockerfile
...
EXPOSE 80

COPY --from=builder /react-frontend/replace_api_url.sh /
CMD ["sh", "replace_api_url.sh"]

下面是replace_api_url.sh的內容：

#!/usr/bin/env sh

find '/usr/share/nginx/html' -name '*.js' -exec sed -i -e 's,API_BASE_URL,'"$API_BASE_URL"',g' {} \;
nginx -g "daemon off;"


正常構建映象之後；現在生成容器時，可通過環境變數傳參替換原前端chunk files的API_BASE_URL字串

docker build -t front .
docker run -p 80:80 -e API_BASE_URL=http://somebackend.com/api front

總結輸出

這是一個巧妙的設計，讓我們在前端獨立容器化部署時,能解耦後端API基地址，避免了一次又一次的構建映象工作量。

Dockerfile CMD指令包裝的容器啟動指令碼：讓我們在nginx承載前端打包檔案之前，做一次字串替換，成功將後端API基地址“延遲”到容器執行階段。

相關文章