作者：京東科技高飛

前言

本文旨在通過部署微前端專案的實踐程序中沉淀出一套部署方案，針對專案分別部署在不同的服務器上的場景，就一些重點步驟、碰到的問題做了一些總結，

部署順序

因為線上部署主應用時需要用到子應用的線上可訪問地址，因此部署順序應該是先部署子應用，保證子應用能夠線上可訪問后，再將子應用的線上可訪問地址配置到主應用，最后再將主應用部署到線上環境，

部署分支

線上環境部署統一用master分支的代碼

應用構建打包

主應用構建打包

主應用csd-tech-main-app基于ant-design-pro，需要在config目錄中配置微前端專案的訪問地址，

在config目錄下配置config.test.ts用于測驗環境的打包配置，生產環境打包配置放在在config.prod.ts中，由于本次部署是在本地機器測驗部署，因此子應用訪問地址都用localhost，如果部署到測驗環境，或者生產環境，可以換成對應的訪問地址，

測驗環境打包配置：

// config/config.test.ts  用于本地或者測驗環境構建測驗
export default defineConfig({
  define: {
    DATALINK_MICRO_APP_HOST: '//localhost:8888',  // 本地環境調度系統訪問地址
    DATAX_MICRO_APP_HOST: '//localhost:9528',     // 本地環境資料遷移系統訪問地址
    LABEL_SYSTEM_MICRO_APP_HOST: '//localhost:8080', // 本地環境標簽系統訪問地址
  KINESISLINK_MICRO_APP_HOST: '//localhost:6001', // 本地環境監控系統訪問地址
  },
})

生產環境打包配置：

// config/config.prod.ts 用于生產環境構建測驗
export default defineConfig({
  define: {
    DATALINK_MICRO_APP_HOST: 'xxxx',  // 生產環境調度系統訪問地址
    DATAX_MICRO_APP_HOST: 'xxxx',     // 生產環境資料遷移系統訪問地址
    LABEL_SYSTEM_MICRO_APP_HOST: 'xxxx', // 生產環境標簽系統訪問地址
    KINESISLINK_MICRO_APP_HOST: 'xxxx', // 生產環境監控系統訪問地址
  },
});

然后，我們需要在微應用注冊資訊中，將我們加載微應用的地址換成我們配置的地址，代碼實作如下：

// src/app.tsx


const microAppsOptions = [
  {
    name: 'datalink',
    entry: DATALINK_MICRO_APP_HOST,
    container: '#subapp-container',
    loader,
    activeRule: '/datalink',
    className: 'data-link-child-app',
  },
  {
    name: 'datax',
    entry: DATAX_MICRO_APP_HOST,
    container: '#subapp-container',
    loader,
    activeRule: '/datax',
    className: 'datax-child-app',
  },
  {
    name: 'label-system',
    entry: LABEL_SYSTEM_MICRO_APP_HOST,
    container: '#subapp-container',
    loader,
    activeRule: '/label-system',
    className: 'label-child-app',
  },
];

最后，我們在package.json中，通過不同的命令區分不同環境，代碼實作如下：

"scripts": {
// ....其他配置
// 生產環境打包命令
    "build": "cross-env REACT_APP_ENV=prod UMI_ENV=prod umi build",
// 測驗環境打包命令
    "build:test": "cross-env REACT_APP_ENV=test UMI_ENV=test umi build",
// 生產環境打包命令
  "build:prod": "cross-env REACT_APP_ENV=prod UMI_ENV=prod umi build",
// ...其他配置
}

在配置完成后，我們在命令列運行如下命令，將主應用構建打包：

rm -f -r node_modules // 如果部署到真實環境，洗掉舊的依賴包


yarn install  // 或者 npm install


// 本地測驗部署，用測驗環境命令打包， 如果是生產環境打包，直接用yarn build 或者 npm run build
yarn build:test  // 或者 npm run build:test

在構建打包完成后，我們將構建好的dist目錄移動到nginx配置根目錄下的html目錄下，并重命名為csd-tech-main-app，目錄結構如下（見下圖）

到這里，我們的主應用就構建打包好了，接下來我們介紹各個微應用構建打包程序，

調度系統(dlink)微應用構建打包

進入專案目錄，直接使用打包命令構建打包即可，在命令列運行：

rm -f -r node_modules  // 如果部署到真實環境，洗掉舊的依賴包


yarn install   // 或者 npm install


yarn build     // 或者 npm run build

在構建打包完成后，我們將構建好的dist目錄移動到nginx配置目錄下的html目錄下，并重命名為datalink，目錄結構如下（見下圖）

資料遷移系統（datax）微應用構建打包

進入專案目錄，直接使用打包命令構建打包即可，在命令列運行：

rm -f -r node_modules  // 如果部署到真實環境，洗掉舊的依賴包


yarn install   // 或者 npm install


yarn build     // 或者 npm run build

在構建打包完成后，我們將構建好的dist目錄移動到nginx配置目錄下的html目錄下，并重命名名為datax，目錄結構如下（見下圖）

標簽系統微應用構建打包

進入專案目錄，直接使用打包命令構建打包即可，在命令列運行：

rm -f -r node_modules  // 如果部署到真實環境，洗掉舊的依賴包


yarn install   // 或者 npm install


yarn build     // 或者 npm run build

在構建打包完成后，我們將構建好的dist目錄移動到nginx配置目錄下的html目錄下，并重命名名為label-system，目錄結構如下（見下圖）

Nginx 服務器部署方案

在將我們的主應用和微應用全部打包完成后，我們將介紹如何使用Nginx完成微前端架構的部署，

Nginx部署方案是可以作為生產方案使用的，

配置時有三點注意事項：

?搭建nginx服務之前，保證所用到的埠是空閑

?子應用和主應用的nginx配置基本上是一致的，唯一不同的是子應用需要配置允許跨域訪問，這是因為我們的微前端架構需要通過ajax請求子應用資源，所以需要配置跨域，通過同源策略的限制，

?子應用和主應用所用到介面地址都需要在nginx配置代理

本地測驗nginx服務配置如下：

worker_processes  1;   # Nginx 行程數，一般設定為和 CPU 核數一樣


events {
  worker_connections  1024;   # 每個行程允許最大并發數
}


error_log  /usr/local/etc/nginx/logs/error.log;   # 錯誤日志路徑
error_log  /usr/local/etc/nginx/logs/error.log  notice; # 錯誤日志路徑
error_log  /usr/local/etc/nginx/logs/error.log  info;  # 錯誤日志路徑


http {
  include mime.types;   # 檔案擴展名與型別映射表
  default_type application/octet-stream;   # 默認檔案型別
  server {
    set $root "/usr/local/etc/nginx/html";   # 設定靜態檔案目錄的絕對路徑，該變數根據個人的專案配置有所不同
    listen       8000;   # 配置監聽的埠
    server_name  localhost;    # 配置的域名，目前是本地測驗，所以直接使用 localhost
  
    location / {
      root   $root/csd-tech-main-app;  # 網站根目錄，這里選用主應用構建后的檔案目錄
      index  index.html;   # 默認首頁檔案
      try_files  $uri $uri/index.html /index.html;   # 兼容 history 路由模式，找不到的檔案直接重定向到 index.html 


      expires -1;                          # 首頁一般沒有強制快取
      add_header Cache-Control no-cache;
    }


    location ~*\.(js|css|png|jpg|jpeg|gif|ico)$ {
        add_header Access-Control-Allow-Origin *;
        add_header Access-Control-Allow-Methods 'GET, POST, OPTIONS';
        add_header Access-Control-Allow-Headers 'DNT,X-Mx-ReqToken,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Authorization';


        root   $root/csd-tech-main-app;
        expires 30d;
    }


    location /api {
        proxy_pass http://xxxxxx;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header Host $http_host;
    }


    location /dolphinscheduler {
        proxy_pass http://xxxxxxxx;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header Host $http_host;
    }


    location /labelapi {
        proxy_pass http://xxxxxx;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header Host $http_host;
        rewrite ^/labelapi/(.*)$ /api/$1 break; 
    }


    location /webhdfs {
        proxy_pass http://xxxxxxx;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header Host $http_host;
    }


  }


  server {
    set $root "/usr/local/etc/nginx/html";   # 設定靜態檔案目錄的絕對路徑，該變數根據個人的專案配置有所不同
    listen       8888;   # 配置監聽的埠
    server_name  localhost;    # 配置的域名，目前是本地測驗，所以直接使用 localhost


    location / {
      root   $root/data-link;  # 網站根目錄
      index  index.html;   # 默認首頁檔案
      try_files  $uri $uri/index.html /index.html;   # 兼容 history 路由模式，找不到的檔案直接重定向到 index.html 


      expires -1;                          # 首頁一般沒有強制快取
      add_header Cache-Control no-cache;


      add_header "Access-Control-Allow-Origin" $http_origin;   # 全域變數獲得當前請求origin，帶cookie的請求不支持*
      add_header "Access-Control-Allow-Methods" "*";  # 允許請求方法
      add_header "Access-Control-Allow-Headers" "*";  # 允許請求的 header
    }


    location ~*\.(js|css|png|jpg|jpeg|gif|ico)$ {
        add_header Access-Control-Allow-Origin *;
        add_header Access-Control-Allow-Methods 'GET, POST, OPTIONS';
        add_header Access-Control-Allow-Headers 'DNT,X-Mx-ReqToken,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Authorization';


        root   $root/data-link;
        expires 30d;
    }


    location /dolphinscheduler {
        proxy_pass http://xxxxxxxx;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header Host $http_host;
    }


    location /webhdfs {
        proxy_pass http://xxxxxxxxx;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header Host $http_host;
    }


  }


  server {
    set $root "/usr/local/etc/nginx/html";   # 設定靜態檔案目錄的絕對路徑，該變數根據個人的專案配置有所不同
    listen       9528;   # 配置監聽的埠
    server_name  localhost;    # 配置的域名，目前是本地測驗，所以直接使用 localhost


    location / {
      root   $root/datax;  # 網站根目錄
      index  index.html;   # 默認首頁檔案
      try_files  $uri $uri/index.html /index.html @rewrites;   # 兼容 history 路由模式，找不到的檔案直接重定向到 index.html 


      expires -1;                          # 首頁一般沒有強制快取
      add_header Cache-Control no-cache;


      add_header "Access-Control-Allow-Origin" $http_origin;   # 全域變數獲得當前請求origin，帶cookie的請求不支持*
      add_header "Access-Control-Allow-Methods" "*";  # 允許請求方法
      add_header "Access-Control-Allow-Headers" "*";  # 允許請求的 header
    }


    location ~*\.(js|css|png|jpg|jpeg|gif|ico)$ {
        add_header Access-Control-Allow-Origin *;
        add_header Access-Control-Allow-Methods 'GET, POST, OPTIONS';
        add_header Access-Control-Allow-Headers 'DNT,X-Mx-ReqToken,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Authorization';


        root   $root/datax;
        expires 30d;
    }


    location /api {
        proxy_pass http://xxxxxxxx;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header Host $http_host;
    }


  }


  server {
    set $root "/usr/local/etc/nginx/html";   # 設定靜態檔案目錄的絕對路徑，該變數根據個人的專案配置有所不同
    listen       8080;   # 配置監聽的埠
    server_name  localhost;    # 配置的域名，目前是本地測驗，所以直接使用 localhost


    location / {
      root   $root/label-system;  # 網站根目錄
      index  index.html;   # 默認首頁檔案
      try_files  $uri $uri/index.html /index.html;   # 兼容 history 路由模式，找不到的檔案直接重定向到 index.html 


      expires -1;                          # 首頁一般沒有強制快取
      add_header Cache-Control no-cache;


      add_header "Access-Control-Allow-Origin" $http_origin;   # 全域變數獲得當前請求origin，帶cookie的請求不支持*
      add_header "Access-Control-Allow-Methods" "*";  # 允許請求方法
      add_header "Access-Control-Allow-Headers" "*";  # 允許請求的 header
    }


    location ~*\.(js|css|png|jpg|jpeg|gif|ico)$ {
        add_header Access-Control-Allow-Origin *;
        add_header Access-Control-Allow-Methods 'GET, POST, OPTIONS';
        add_header Access-Control-Allow-Headers 'DNT,X-Mx-ReqToken,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Authorization';


        root   $root/label-system;
        expires 30d;
    }


    location /labelapi {
        proxy_pass http://xxxxxxxx;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header Host $http_host;
        rewrite ^/labelapi/(.*)$ /api/$1 break; 
    }


  }


 server {
    set $root "/usr/local/etc/nginx/html";   # 設定靜態檔案目錄的絕對路徑，該變數根據個人的專案配置有所不同
    listen       6001;   # 配置監聽的埠
    server_name  localhost;    # 配置的域名，目前是本地測驗，所以直接使用 localhost


    location / {
      root   $root/kinesislink;  # 網站根目錄
      index  index.html;   # 默認首頁檔案
      try_files  $uri $uri/index.html /index.html;   # 兼容 history 路由模式，找不到的檔案直接重定向到 index.html 


      expires -1;                          # 首頁一般沒有強制快取
      add_header Cache-Control no-cache;


      add_header "Access-Control-Allow-Origin" $http_origin;   # 全域變數獲得當前請求origin，帶cookie的請求不支持*
      add_header "Access-Control-Allow-Methods" "*";  # 允許請求方法
      add_header "Access-Control-Allow-Headers" "*";  # 允許請求的 header
    }


    location ~*\.(js|css|png|jpg|jpeg|gif|ico)$ {
        add_header Access-Control-Allow-Origin *;
        add_header Access-Control-Allow-Methods 'GET, POST, OPTIONS';
        add_header Access-Control-Allow-Headers 'DNT,X-Mx-ReqToken,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Authorization';


        root   $root/kinesislink;
        expires 30d;
    }


    location /ksapi {
       proxy_pass http://xxxxxxxx;
       proxy_set_header X-Real-IP $remote_addr;
       proxy_set_header Host $http_host;
       rewrite ^/ksapi/(.*)$ /api/$1 break; 
    }


    location /2.0 {
       proxy_pass http://xxxxxxxx;
       proxy_set_header X-Real-IP $remote_addr;
       proxy_set_header Host $http_host;
    }


    location /3.0 {
       proxy_pass http://xxxxxxxxx;
       proxy_set_header X-Real-IP $remote_addr;
       proxy_set_header Host $http_host;
    }


    location /dolphinscheduler {
        proxy_pass http://xxxxxxxxxx;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header Host $http_host;
    }
  }
 
}

在配置完成后，我們需要重啟一下nginx服務，

輸入nginx啟動命令啟動nginx

在瀏覽器中訪問主應用測驗地址localhost:8000，登錄后如下圖：