使用React，Vue和Single-spa構建微前端Micro Frontends

banq發表於2019-06-19
ReactVue前端

在過去的幾周裡，圍繞微觀前端進行了大量討論（一些是負面的，一些是積極的）。在本教程中，我將分享我所學到的知識，並向您展示如何構建由React和Vue應用程式組成的微前端應用程式。

要檢視此應用程式的最終程式碼，請單擊此處。

Single-spa

我們將用於建立專案的工具是Single SPA - 用於前端微服務的javascript框架。

Single SPA使您可以在單頁面應用程式中使用多個框架，允許您按功能拆分程式碼，並使Angular，React，Vue.js等應用程式共存。

您可能已經習慣了Create React APP CLI和Vue CLI的時代。使用這些工具，您可以快速啟動整個專案，完成webpack配置，依賴關係和樣板檔案，隨時為您服務。

如果你已經習慣了這種簡易設定，那麼第一部分可能會有點囉嗦。這是因為我們將從頭開始建立所有內容，包括安裝我們需要的所有依賴項，以及從頭開始建立webpack和babel配置。

入門

您需要做的第一件事是建立一個新資料夾來儲存應用程式並切換到目錄：

mkdir single-spa-app

cd single-spa-app

接下來，我們將初始化一個新的package.json檔案：

npm init -y

現在，這是有趣的部分。我們將安裝此專案所需的所有依賴項。我將把它們分成不同的步驟。

1. 安裝常規依賴項

npm install react react-dom single-spa single-spa-react single-spa-vue v

2. 安裝babel依賴項

npm install @babel/core @babel/plugin-proposal-object-rest-spread @babel/plugin-syntax-dynamic-import @babel/preset-env @babel/preset-react babel-loader --save-dev

3. 安裝webpack依賴項

npm install webpack webpack-cli webpack-dev-server clean-webpack-plugin css-loader html-loader style-loader vue-loader vue-template-compiler --save-dev

現在，已經安裝了所有依賴項，我們可以建立資料夾結構。

我們的應用程式的主要程式碼將存在於src目錄中。這個src目錄將儲存每個應用程式的子資料夾。讓我們繼續在src資料夾中建立react和vue應用程式資料夾：

mkdir src src/vue src/react

現在，我們可以為webpack和babel建立配置。

建立webpack配置

在主應用程式的根目錄中，使用以下程式碼建立一個webpack.config.js檔案：

const path = require('path');
const webpack = require('webpack');
const { CleanWebpackPlugin } = require('clean-webpack-plugin');
const VueLoaderPlugin = require('vue-loader/lib/plugin')

module.exports = {
  mode: 'development',
  entry: {
    'single-spa.config': './single-spa.config.js',
  },
  output: {
    publicPath: '/dist/',
    filename: '[name].js',
    path: path.resolve(__dirname, 'dist'),
  },
  module: {
    rules: [
      {
        test: /\.css$/,
        use: ['style-loader', 'css-loader']
      }, {
        test: /\.js$/,
        exclude: [path.resolve(__dirname, 'node_modules')],
        loader: 'babel-loader',
      },
      {
        test: /\.vue$/,
        loader: 'vue-loader'
      }
    ],
  },
  node: {
    fs: 'empty'
  },
  resolve: {
    alias: {
      vue: 'vue/dist/vue.js'
    },
    modules: [path.resolve(__dirname, 'node_modules')],
  },
  plugins: [
    new CleanWebpackPlugin(),
    new VueLoaderPlugin()
  ],
  devtool: 'source-map',
  externals: [],
  devServer: {
    historyApiFallback: true
  }
};

建立babel配置

在主應用程式的根目錄中，.babelrc使用以下程式碼建立一個檔案：

{
  "presets": [
    ["@babel/preset-env", {
      "targets": {
        "browsers": ["last 2 versions"]
      }
    }],
    ["@babel/preset-react"]
  ],
  "plugins": [
    "@babel/plugin-syntax-dynamic-import",
    "@babel/plugin-proposal-object-rest-spread"
  ]
}

初始化Single-SPA

註冊應用程式是我們如何告訴single-spa何時以及如何引導，裝載和解除安裝應用程式。

在webpack.config.js檔案中，我們將入口點設定為single-spa.config.js。

讓我們繼續在專案的根目錄中建立該檔案並進行配置。

spa.config.js:

import { registerApplication, start } from 'single-spa'

registerApplication(
  'vue', 
  () => import('./src/vue/vue.app.js'),
  () => location.pathname === "/react" ? false : true
);

registerApplication(
  'react',
  () => import('./src/react/main.app.js'),
  () => location.pathname === "/vue"  ? false : true
);

start();

您可以在此檔案中註冊將成為主要單頁應用程式一部分的所有應用程式。每次呼叫registerApplication註冊一個新的應用程式並採取三個引數：

  1. 應用名稱
  2. 載入功能（要載入的入口點）
  3. 活動功能（判斷是否載入應用程式的邏輯）

接下來，我們需要為每個應用程式建立程式碼。

React應用

在src / react中，建立以下兩個檔案：

touch main.app.js root.component.js

src/react/main.app.js： 

import React from 'react';
import ReactDOM from 'react-dom';
import singleSpaReact from 'single-spa-react';
import Home from './root.component.js';

function domElementGetter() {
  return document.getElementById("react")
}

const reactLifecycles = singleSpaReact({
  React,
  ReactDOM,
  rootComponent: Home,
  domElementGetter,
})

export const bootstrap = [
  reactLifecycles.bootstrap,
];

export const mount = [
  reactLifecycles.mount,
];

export const unmount = [
  reactLifecycles.unmount,
];

src/react/root.component.js

import React from "react"

const App = () => <h1>Hello from React</h1>

export default App

Vue應用

在 src/vue建立下面兩個檔案：

touch vue.app.js main.vue

src/vue/vue.app.js：

import Vue from 'vue';
import singleSpaVue from 'single-spa-vue';
import Hello from './main.vue'

const vueLifecycles = singleSpaVue({
  Vue,
  appOptions: {
    el: '#vue',
    render: r => r(Hello)
  } 
});

export const bootstrap = [
  vueLifecycles.bootstrap,
];

export const mount = [
  vueLifecycles.mount,
];

export const unmount = [
  vueLifecycles.unmount,
];

src/vue/main.vue：

<template>
  <div>
      <h1>Hello from Vue</h1>
  </div>
</template>

接下來，在應用程式的根目錄中建立index.html檔案：

touch index.html

內容：

<html>
  <body>
    <div id="react"></div>
    <div id="vue"></div>
    <script src="/dist/single-spa.config.js"></script>
  </body>
</html>

使用指令碼更新Package.json

要執行應用程式，我們在package.json中新增啟動指令碼和構建指令碼：

"scripts": {
  "start": "webpack-dev-server --open",
  "build": "webpack --config webpack.config.js -p"
}

執行應用程式

要執行該應用程式，請執行該start指令碼：

npm start

要檢視此應用程式的最終程式碼，請單擊此處。

結論

總的來說，除了所有初始樣板設定之外，設定這個專案是相當輕鬆的。

我認為將來如果能夠處理大部分樣板和初始專案設定的CLI會很好。

如果您需要這種型別的體系結構，那麼Single-spa絕對是目前最成熟的方式，並且非常適合使用。

相關文章