使用React,Vue和Single-spa构建微前端Micro Frontends

19-06-19 banq
              

在过去的几周里,围绕微观前端进行了大量讨论(一些是负面的,一些是积极的)。在本教程中,我将分享我所学到的知识,并向您展示如何构建由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绝对是目前最成熟的方式,并且非常适合使用。

              

4