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

更新日期: 2020-10-21阅读: 1.8k标签: 微前端

Single SPA

Single SPA 是一个用于前端微服务的 javascript 框架

它使你可以在单页应用中使用多个框架,这样就可以按功能拆分代码,并 能使 angularreactvue.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 目录中创建 reactvue 程序的目录:

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

原文:https://dev.to/dabit3/building-micro-frontends-with-react-vue-and-single-spa-52op


    链接: https://fly63.com/article/detial/9762

    实施微前端的六种方式

    微前端架构是一种类似于微服务的架构,它将微服务的理念应用于浏览器端,即将 Web 应用由单一的单体应用转变为多个小型前端应用聚合为一的应用。由此带来的变化是,这些前端应用可以独立运行、独立开发、独立部署。

    基于 React & TS & Webpack 的微前端应用模板

    在 Web 开发导论/微前端与大前端一文中,笔者简述了微服务与微前端的设计理念以及微前端的潜在可行方案。微服务与微前端,都是希望将某个单一的单体应用,转化为多个可以独立运行、独立开发、独立部署、独立维护的服务或者应用的聚合

    微前端的好处和缺陷

    “微前端架构”是一种使用微服务模式构建前端应用的方法。微前端的理念是将你的前端拆分为一组可独立部署、松散耦合的应用。然后将这些应用组装在一起以创建面向用户的单个应用程序

    微前端如何落地?

    在过去的几星期里,随着 Martin Fowler 博客上,那篇 Cam Jackson 写的微前端的文章发布,到处都在讨论 Microfrontend。作为一个微前端 “专家”,我也分享一下:如何去落地微前端

    微前端究竟好在哪?

    微前端架构是一种设计方法,其中,前端应用被分解为多个松散而协同工作的半独立“微应用”。微前端的思想来源于微服务,其名称也遵循了微服务的命名方式。那么,微前端的优势和好处在哪?让我们一起通过这篇微前端教程来了解

    从微前端聊聊架构演进

    就目前来看,微前端已经不是一个新话题了。随着越来越多的公司的深入研究,当前也提出了很多的解决方案。不过本文不是想要来介绍微前端,更想介绍项目如何一步步到达微前端架构的实际需求

    实现微前端需要了解的 Vue Genesis 渲染器

    核心的就是渲染器,它提供了最基础渲染能力,有了它,你可以实现微前端、微服务、远程组件、首屏渲染,甚至可以和 React、EJS 等配合使用。

    微前端开发常见问题汇总

    微前端开发常见问题汇总,前端应用可以独立运行、独立开发、独立部署。微前端不是单纯的前端框架或者工具而是一套架构体系。其在开发中会有各种问题,今天小编整理了一下分享给大家!

    5分钟带你了解微前端

    不同于单纯的前端框架/工具,微前端是一套架构体系,这个概念最早在2016年底由 ThoughtWorks 提出。 微前端是一种类似于微服务的架构,它将微服务的理念应用于浏览器端,将 Web 应用从整个的「单体应用」转变为多个小型前端应用的「聚合体」。

    什么是微前端

    微前端的理念源自微服务,使用一个主应用作为主体框架和微应用加载器,根据不用的路由加载不同的微应用。微应用之间做到技术隔离,在展示上却是统一的。微前端主要用来解决单体应用在相对长的时间跨度下

    点击更多...

    内容以共享、参考、研究为目的,不存在任何商业目的。其版权属原作者所有,如有侵权或违规,请与小编联系!情况属实本人将予以删除!