用Single-spa 創建基於 React 和 Vue 的微型前端

用Single-spa 創建基於 React 和 Vue 的微型前端

前段小混混 前端先鋒

Single SPA

---

Single SPA 是一個用於前端微服務的 javascript 框架。

它使你可以在單頁應用中使用多個框架，這樣就可以按功能拆分代碼，並 能使 Angular、React、Vue.js 程序一起運行。

你可能已經習慣了 React 和 Vue 的 CLI，通過這些工具可以快速創建項目，並準備好 webpack 的配置、依賴項和樣板代碼等。

如果你已經習慣了這種操作，那麼你可能會覺得本文的前半部分有些繁瑣。因爲我們要從頭創建所有內容，包括安裝所需的所有依賴項以及從零創建 webpack 和 babel 配置。

環境與配置

---

首先在終端下創建一個新目錄並進入其中：

mkdir single-spa-app

cd single-spa-app

接下來初始化 package.json 文件：

npm init -y

然後安裝項目所需的所有依賴項。爲了讓大家清楚的知道都安裝了些什麼，在這裏我把它們分解成單獨的步驟。

安裝依賴項

</>安裝常規依賴項

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

</>安裝 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

</>安裝 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 目錄中創建 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。

在項目的根目錄中創建這個文件並進行配置。

</>single-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

</>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

現在可以通過以下URL訪問了：

# 渲染基於所有框架的程序
http://localhost:8080/

# 只渲染 react
http://localhost:8080/react

# 之渲染 vue
http://localhost:8080/vue

總結

---

除了開始時的配置外，其他工作都很輕鬆。如果以後 Single-spa 能夠添加處理樣板文件和初始項目設置的 CLI 會更好。

如果你需要微前端這種類型的體系結構，那麼 Single-spa 無疑是現在最成熟的方法。