single-spa的简单介绍
文章目录
目录
<h2 id="heading-1">一、背景</h2>
简单介绍下背景吧~
为什么要用single-spa呢,是因为业务逐渐繁盛,衍生出许多不相互依赖的,独立的服务,这个时候就需要引入微服务的概念。那么什么是微服务呢?
据 亚马逊云 的介绍,微服务是:
微服务是一种开发软件的架构和组织方法,其中软件由通过明确定义的 API 进行通信的小型独立服务组成。这些服务由各个小型独立团队负责。微服务架构使应用程序更易于扩展和更快地开发,从而加速创新并缩短新功能的上市时间。

<center>图: 将整体式应用程序拆分为微服务</center>
也就是说,一开始的时候业务都是整体式架构,随着业务的发展,添加或改进整体式应用程序的功能变得更加复杂,这限制了业务的发展,这个时候可以将独立的服务抽象出来变成组件,以满足针对各项服务进行更新、部署和扩展的需求。
后端的概念应用到前端,前端微服务/微前端服务就诞生了,我们简称其为微前端。
举个例子,百度云的服务,数据存储是一个独立的服务,语音识别又是一个独立的服务,不同的服务聚合成百度云这个体系,所以可以把其做成微服务的体系。
<h3 id="heading-1-1">1.1 微前端服务</h3>
微前端架构是一种类似于微服务的架构,由ThoughtWorks2016 年提出,它将微服务的理念应用于浏览器端,即将Web应用由单一的单体应用转变为多个小型前端应用聚合为一的应用。
由此带来的变化是,这些前端应用可以独立运行、独立开发、独立部署。

<center>微前端服务体系</center>
如图所示,root-config 是项目的中心,用于启动项目,而 module1 、 module2 等其他模块是独立的,并且可以嵌入到项目中。
本文主要介绍的是基于 single-spa 实现的前端微服务。
<h3 id="heading-1-2">1.2 single-spa</h3>
single-spa是一个用于前端微服务化的JavaScript前端解决方案。
特点:
- (兼容各种技术栈)在同一个页面中使用多种技术框架(React, Vue, AngularJS, Angular, Ember等任意技术框架),并且不需要刷新页面.
- (无需重构现有代码)使用新的技术框架编写代码,现有项目中的代码无需重构.
- (更优的性能)每个独立模块的代码可做到按需加载,不浪费额外资源.每个独立模块可独立运行.
<h3 id="heading-1-3">1.3 import-map</h3>
import-map 的实现是 single-spa 的核心部分,我们首先得知晓什么是 import-map 。
我们先来看两段代码
import moment from 'moment';
import 'http://momentjs.com/downloads/moment.js';
这是一个典型的 es6 的 ES Module的代码,但是现在浏览器并不支持。为了让浏览器支持,我们需要对其进行兼容处理。
在一个文件中我们写入如上代码,显然第一行是无法正常运行的,第二行是可以正常运行的,但如果我们想要第一行正常运行的话, import-map 就可以粉墨登场啦。只需要在 html 文件书写如下:
<script type="importmap">
{
"imports": {
"moment": "https://momentjs.com/downloads/moment.js",
}
}
</script>
就可以了。
但是现在浏览器并不支持,想要让它支持的话,需要引入 system.js 。
<script type="systemjs-importmap">
{
"imports": {
"moment": "https://momentjs.com/downloads/moment.js",
}
}
</script>
<script src="https://cdn.jsdelivr.net/npm/systemjs/dist/system.js"></script>
而在 single-spa 的使用过程中,我们需要用 import-map 在根项目中引入所有的模块文件和子项目,从而在其余项目中可以进行模块的引用,就像上面说的那样,可以把 moment 想象成一个子项目。
<script type="systemjs-importmap">
{
"imports": {
"module": "https://[cdn-link].js",
}
}
</script>
<script src="https://cdn.jsdelivr.net/npm/systemjs/dist/system.js"></script>
再把其优化,就变成了 =>
<script type="systemjs-importmap" src="https://[bucket]/import-map.json"></script>
<script src="https://cdn.jsdelivr.net/npm/systemjs/dist/system.js"></script>
而 import-map.json 里面的文件就是
{
"imports": {
"module": "https://[cdn-link].js",
}
}
所以我们开发者需要做的,就是把模块文件打包成单一的 cdn 文件,然后在 root-config 中引入 import-map.json, 从而实现子模块的引入。(当然了,import-map.json 也是放在 cdn 上的)
<h2 id="heading-2">二、怎么安装</h2>
大概原理了解完之后,就可以着手single-spa的改装了。可以戳这里看一个线上的 single-spa 地址。
首先把 root-config 拉下来,这是我们的根文件。
<h3 id="heading-2-1">2.1 子项目添加single-spa配置项</h3>
// package.json
"dependencies": {
+ "single-spa-vue": "^1.8.2",
+ "systemjs-webpack-interop": "^2.1.0",
},
"devDependencies": {
+ "vue-cli-plugin-single-spa": "^1.1.0",
},
// main.js
+ import "./set-public-path";
+ import singleSpaVue from "single-spa-vue";
+ const vueLifecycles = singleSpaVue({
+ Vue,
+ appOptions: {
+ render: h => h(App),
+ router,
+ store
+ }
+ });
+ export const bootstrap = vueLifecycles.bootstrap;
+ export const mount = vueLifecycles.mount;
+ export const unmount = vueLifecycles.unmount;
在main.js目录下新建set-public-path.js文件。
// set-public-path.js
+ import { setPublicPath } from "systemjs-webpack-interop";
+ setPublicPath("@[项目名称]/[模块名称]");
**!! 删除原有的vue.config.js文件,将就有项目的vue.config.js文件拷入。
!! 如果需要在原模块进行开发而不是跨项目开发,需保留一份原配置。**
(如果还是看着有点懵的话,请参照沉末的这篇文章进行安装。)
<h2 id="heading-3">三、怎么开发</h2>
<h3 id="heading-3-1">3.1 怎么进行开发</h3>
npm run start启动root-config.js- 在浏览器的
console中输入,localStorage.setItem('devtools', true);,开启import-map插件。

npm run serve启动子项目。- 在
import-map指向的地址将子项目指向的路径更改为本地项目指向的路径。
如本地启动的项目地址为module1(http://localhost:8081/),点击import-map更改地址为http://localhost:8081/js/app.js。js/app.js由打包后的路径决定。可以在子模块的启动地址处的控制台的 sources 处查看。
<h3 id="heading-3-2">3.2 子项目怎么打包</h3>
在微服务的组件引用中,由于运用cdn引入,因此文件需要打包成单一的js文件,而vue-cli3-service(文件路径位于node_modules/_@vue_cli-service@4.3.1@@vue/cli-service/lib/config, 并没有找到github地址)内置了一些webpack配置,在子项目的打包过程中需要把某些配置关掉,并且将其打包成支持system.js的文件,我们需要做如下事情:
- 将项目打包成可引入的文件
- 去除代码分割的配置 (代码分割会生成
chunk-vendors文件) - 去除
mini-css-extract-plugin(该插件会将组件中的css抽离出来)
代码如下
// vue.config.js
process.env.VUE_CLI_CSS_SHADOW_MODE = true; // 去除将css从js分出去的配置
module.exports = {
chainWebpack: config => {
config.optimization.delete('splitChunks') // 关闭代码分割
config.output
.filename('app.js')
.library('@[library]/[sub-project]')
.libraryTarget('amd') // 打包方式
.end()
}
...
}
但是上面都是屁话。。。。这些事情其实只要一个插件就可以解决了,原作者写了vue-cli-plugin-single-spa这个插件,直接安装即可。
npm install vue-cli-plugin-single-spa -D
<h2 id="heading-4">四、其他问题</h2>
<h3 id="heading-4-1">4.1 子项目的文件路径404了</h3>
经过如上的过程打包之后,打包后的文件为/dist/js/app.js,在原作者写的插件中,改写文件路径如下:

就可以了。
假如还是404,可能项目被打包到了不同的路径,需要打开子项目的tab在浏览器中查看文件地址。

<h3 id="heading-4-2">4.2 element-ui 图标显示不出</h3>
需要注意的是vue-cli-plugin-single-spa这个插件并没有处理文字等静态资源,因此尽管npm run build没有显示静态资源被打包成单独的文件,事实上其还是被打包成了静态文件了。解决这个问题最好的方法是把element-ui转化为cdn引入的而不是通过node_module引入的。
<h3 id="heading-4-3">4.3 渲染错项目</h3>
明明指向的是项目A,但是却渲染成了项目B。

插件中配置的文件路径错了,可能A项目是8080端口配置成了8081端口,在多项目开发的时候尤其容易出现该问题。
<h3 id="heading-4-4">4.4 怎么实现两栏布局右边可切换项目</h3>
之前的我天真得以为可以将子项目变成一个router的组件直接引入,但事实上是实现不了的。由于项目的耦合程度过大,依赖于各个插件,是无法将其打包成一个组件的。所以其实质上是两个并排的DOM节点。但是我们可以实现一个假的效果。
在菜单栏的router中设置,
{
path: '/',
component: Home,
name: 'home',
redirect: '/sub-project',
children: [{
path: 'sub-project/*',
name: 'sub-project',
}]
},
为什么要加星号呢,是为了解决另一个问题,不加通配符的话会导致navbar无法正常匹配,如果sub-project具有一些router转换的话。
为了在子项目中能匹配相应的router,需要设置
base: 'sub-project'
接着在菜单栏中设置浮动,右边margin相应的宽度就可以了。
<h2 id="heading-5">五、更多</h2>
https://www.youtube.com/watch...
以上就是 single-spa 的简单介绍,喜欢可以给一个小小的赞,谢谢~
评论
登录后参与技术讨论,分享你的经验与见解。
登录 / 注册暂无评论