Nader Dabit翻译:疯狂的技术宅
原文:https://dev.to/dabit3/buildin...
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
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
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.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 } };
在根目录中创建 .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 找到、装载和卸载程序的时机和方法。
在 webpack.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
都会注册一个新的应用,它接受三个参数:
接下来需要为每个应用创建代码。
在 src/react 目录中创建以下两个文件:
touch main.app.js root.component.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, ];
import React from "react" const App = () => <h1>Hello from React</h1> export default App
在 src/vue 目录中创建以下两个文件:
touch vue.app.js main.vue
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, ];
<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 中添加启动脚本和构建脚本:
"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 无疑是现在最成熟的方法。