使用 React、Vue 和 Single-spa 构建微前端

2025-05-24

使用 React、Vue 和 Single-spa 构建微前端

在过去的几周里，围绕微前端出现了大量讨论（有的消极，有的积极）。

有一条推文引起了我的注意，它来自Single SPA的创建者Joel Denning：

当我看到像这样的新鲜且有争议的事物时，我总是想亲自尝试一下，看看所有的炒作都是关于什么的，同时也让我能够对这个主题形成自己的看法。

这使我走上了创建微前端应用程序的道路，该应用程序可以渲染两个独立的 React 应用程序以及一个 Vue 应用程序。

在本教程中，我将分享我所学到的知识，并向您展示如何构建由 React 和 Vue 应用程序组成的微前端应用程序。

要查看此应用程序的最终代码，请单击此处。

单人SPA

我们将使用来创建项目的工具是Single SPA - 用于前端微服务的 javascript 框架。

单个 SPA 使您能够在单页应用程序中使用多个框架，从而允许您按功能拆分代码并让 Angular、React、Vue.js 等应用程序共存。

你可能已经习惯了 Create React APP CLI 和 Vue CLI。使用这些工具，你可以快速启动整个项目，并准备好完整的 webpack 配置、依赖项和样板文件。

如果你已经习惯了这种简单的设置，那么第一部分可能会有点不适应。因为我们将从头开始创建所有内容，包括安装所需的所有依赖项，以及从头创建 webpack 和 babel 配置。

如果您仍然好奇 Single SPA 的作用或为什么您可能想要使用微前端架构进行构建，请观看此视频。

入门

您需要做的第一件事是创建一个新文件夹来保存应用程序并切换到目录：



mkdir single-spa-app

cd single-spa-app
Enter fullscreen mode Exit fullscreen mode

接下来，我们将初始化一个新的 package.json 文件：



npm init -y
Enter fullscreen mode Exit fullscreen mode

现在，最有趣的部分来了。我们将安装此项目所需的所有依赖项。我会将这些步骤分成几个独立的步骤。

安装常规依赖项



npm install react react-dom single-spa single-spa-react single-spa-vue vue
Enter fullscreen mode Exit fullscreen mode

安装 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
Enter fullscreen mode Exit fullscreen mode

安装 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
Enter fullscreen mode Exit fullscreen mode

现在，所有依赖项都已安装，我们可以创建文件夹结构。

我们应用程序的主要代码将位于src目录中。此src目录将包含每个应用程序的子文件夹。让我们继续在src文件夹中创建react和vue应用程序文件夹：



mkdir src src/vue src/react
Enter fullscreen mode Exit fullscreen mode

现在，我们可以为 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
  }
};
Enter fullscreen mode Exit fullscreen mode

创建 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"
  ]
}
Enter fullscreen mode Exit fullscreen mode

初始化 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();
Enter fullscreen mode Exit fullscreen mode

此文件用于注册所有将构成主单页应用的应用程序。每次调用都会registerApplication注册一个新的应用程序，并接受三个参数：

  1. 应用程序名称
  2. 加载函数（加载哪个入口点）
  3. 活动功能（判断是否加载应用程序的逻辑）

接下来，我们需要为每个应用程序创建代码。

React 应用

在src/react中，创建以下两个文件：



touch main.app.js root.component.js
Enter fullscreen mode Exit fullscreen mode

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,
];
Enter fullscreen mode Exit fullscreen mode

src/react/root.component.js



import React from "react"

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

export default App
Enter fullscreen mode Exit fullscreen mode

Vue 应用

在src/vue中，创建以下两个文件：



touch vue.app.js main.vue
Enter fullscreen mode Exit fullscreen mode

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,
];
Enter fullscreen mode Exit fullscreen mode

src/vue/main.vue



<template>
  <div>
      <h1>Hello from Vue</h1>
  </div>
</template>
Enter fullscreen mode Exit fullscreen mode

接下来，在应用程序的根目录中创建 index.html 文件：



touch index.html
Enter fullscreen mode Exit fullscreen mode

索引.html



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

使用脚本更新 Package.json

要运行该应用程序，让我们在 package.json 中添加启动脚本和构建脚本：



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

运行应用程序

要运行该应用程序，请运行以下start脚本：



npm start
Enter fullscreen mode Exit fullscreen mode

现在，您可以访问以下网址：



# renders both apps
http://localhost:8080/

# renders only react
http://localhost:8080/react

# renders only vue
http://localhost:8080/vue
Enter fullscreen mode Exit fullscreen mode

要查看此应用程序的最终代码，请单击此处。

结论

总体而言，除了所有初始样板设置之外，设置这个项目相当轻松。

我认为将来如果有某种 CLI 可以处理大部分样板和初始项目设置就好了。

如果您需要这种类型的架构，那么Single-spa绝对是目前最成熟的方法，并且非常好用。

我叫Nader Dabit。我是 Amazon Web Services 的开发倡导者，负责AWS AppSync和AWS Amplify等项目。我专注于跨平台和云端应用程序开发。

文章来源：https://dev.to/dabit3/building-micro-frontends-with-react-vue-and-single-spa-52op
Devto 翻译
PREV
使用 GraphQL 和 AWS Amplify 进行深度数据建模 - 17 种数据访问模式
NEXT
使用 Arweave、Smartweave 和 Next.js 构建全栈永久应用程序