微前端項目部署方案

来源:https://www.cnblogs.com/jingdongkeji/archive/2023/04/10/17301771.html
-Advertisement-
Play Games

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


作者：京東科技 高飛

前言

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

部署順序

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

部署分支

線上環境部署統一用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，登錄後如下圖：

在瀏覽器中訪問datalink子應用測試地址localhost:8888，登錄後如下圖：

在瀏覽器中訪問datax子應用測試地址localhost:9528, 登錄後如下圖：

在瀏覽器中訪問標簽系統子應用測試地址localhost:8080, 登錄後如下圖：

至此，nginx服務部署大功告成！

擴展

如果需要把服務部署到真實伺服器，只需要把所有的 localhost 都換成真實註冊的功能變數名稱即可，其他配置都可以復用！


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • GreatSQL社區月報 | 2023.03
    GreatSQL社區月報 | 2023.03 GreatSQL 是一個開源的 MySQL 技術路線資料庫社區，社區致力於通過開放的社區合作，構建國內自主 MySQL 版本及開源資料庫技術，推動中國開源資料庫及應用生態繁榮發展。 為了幫助社區的小伙伴們更好地瞭解 GreatSQL 社區的實時進展，我們 ...
  • 前端工程化實戰：React 模塊化開發、性能優化和組件化實踐
    前端工程化實戰是指通過組織工作流程、使用工具和技術來提高前端開發效率和質量的一種方法。常見的前端工程化實踐包括模塊化開發、自動化構建、代碼檢查和測試、性能優化等。下麵將簡要介紹模塊化開發、性能優化和組件化實踐。 ...
  • 記錄-html-docs-js避坑指南
    這裡給大家分享我在網上總結出來的一些知識，希望對大家有所幫助 前言 我們公司目前在做基於tiptap的線上協同文檔，最近需要做導出 pdf、word 需求。 導出 word 文檔使用的是html-docx-js-typescript，是用 typescript 重寫了一下html-docx-js，可 ...
  • 如何配置jsconfig.json文件解決VSCode中無法識別@別名引用的問題
    其他章節請看： 低代碼 系列 中後臺集成低代碼預研 背景 筆者目前維護一個 react 中後臺系統（以 spug 為例），每次來了新的需求都需要前端人員重新開發。 前面我們已經對低代碼有了一定的認識，如果能通過一個可視化的配置頁面就能完成前端開發，將極大的提高前端（或後端）的效率。甚至能加快企業內部 ...
  • 基於SqlSugar的開發框架循序漸進介紹（26）-- 實現本地上傳、FTP上傳、阿裡雲OSS上傳三者合一處理
    在前面介紹的隨筆《基於SqlSugar的開發框架循序漸進介紹（7）-- 在文件上傳模塊中採用選項模式【Options】處理常規上傳和FTP文件上傳》中介紹過在文件上傳處理的過程中，整合了本地文件上傳和基於FTP方式的上傳文件的處理整合。本篇隨筆繼續介紹文件上傳的處理，基於選項模式【Options】方... ...
  • OpenTiny 跨端、跨框架組件庫升級TypeScript，10萬行代碼重獲新生
    摘要：一份精心準備的《JS項目改造TS指南》文檔供大家參考，順便介紹TS 基礎知識和 TS 在 Vue 中的實踐。 本文分享自華為雲社區《歷史性的時刻！OpenTiny 跨端、跨框架組件庫正式升級 TypeScript，10 萬行代碼重獲新生！》，作者：Kagol。 根據 The Software ...
  • CSS樣式中顏色與顏色值的應用
    使用CSS描繪頁面樣式時，顏色是其中不可或缺的，無論是對文本、背景還是邊框、陰影，我們都寫過無數代碼用來增添顏色。而為了讓網頁的色彩表現更出色，我們很有必要完整梳理下CSS中的色彩。 要講清楚CSS中的顏色，離不開顏色模型的概念，這是我們需要先瞭解的。 顏色模型 顏色模型電腦中用來描述顏色的數學模 ...
  • 介紹一下sourcemap
    Sourcemap（源代碼映射）用於將生產環境中的壓縮代碼映射回原始的源代碼。在前端開發過程中，JavaScript、CSS 和其他文件通常會被壓縮和混淆，以減小文件大小和提高網站載入速度。然而，這會讓調試和錯誤定位變得困難，因為生產環境中的代碼難以閱讀和理解。 Sourcemap 的作用是在開發和 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類