構建前端微服務

在過去的幾周裏，圍繞微觀前端進行了大量討論（一些是負面的，一些是積極的）。在本教程中，我將分享我所學到的知識，並向您展現如何構建由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絕對是目前最成熟的方式，而且很是適合使用。