用Single-spa 创建基于 React 和 Vue 的微前端

2020/10/22 14:03:43

编程Tag： javascript vue.js 前端 React.js 微前端

本文主要是介绍用Single-spa 创建基于 React 和 Vue 的微前端，对大家解决编程问题具有一定的参考价值，需要的程序猿们随着小编来一起学习吧！

Nader Dabit
翻译：疯狂的技术宅
原文：https://dev.to/dabit3/buildin...

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 都会注册一个新的应用，它接受三个参数：

应用的名称
要加载的函数（要加载的入口点）
用来激活的函数（用于告知是否加载应用的逻辑）

接下来需要为每个应用创建代码。

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 无疑是现在最成熟的方法。

本文首发微信公众号：前端先锋

欢迎扫描二维码关注公众号，每天都给你推送新鲜的前端技术文章

欢迎继续阅读本专栏其它高赞文章：

深入理解Shadow DOM v1
一步步教你用 WebVR 实现虚拟现实游戏
13个帮你提高开发效率的现代CSS框架
快速上手BootstrapVue
JavaScript引擎是如何工作的？从调用栈到Promise你需要知道的一切
WebSocket实战：在 Node 和 React 之间进行实时通信
关于 Git 的 20 个面试题
深入解析 Node.js 的 console.log
Node.js 究竟是什么？
30分钟用Node.js构建一个API服务器
Javascript的对象拷贝
程序员30岁前月薪达不到30K，该何去何从
14个最好的 JavaScript 数据可视化库
8 个给前端的顶级 VS Code 扩展插件
Node.js 多线程完全指南
把HTML转成PDF的4个方案及实现

更多文章...

这篇关于用Single-spa 创建基于 React 和 Vue 的微前端的文章就介绍到这儿，希望我们推荐的文章对大家有所帮助，也希望大家多多支持为之网！