Skip to content

Latest commit

 

History

History
134 lines (102 loc) · 3.76 KB

README.md

File metadata and controls

134 lines (102 loc) · 3.76 KB
Raw

基于single-spa的微前端框架

解决了single-spa没有解决的微前端项目资源加载的问题

安装

npm i @hydesign/grape --save

使用

import Grape from '@hydesign/grape'

new Grape([
        {
            name:'xxx',// 项目名
            projectIndex:'http://xxxx.com',// 项目访问入口
            base:false,// 是否需要一直在页面中显示
            path:'#/goods',// 项目显示条件。可以是数组
            routeMode: 'hash' // 路由模式
        }
    ])
    .start()

子项目配置

字段 类型 是否必填 可选值 默认值 描述
name String 是 - - 项目名
projectIndex String 是 - - 项目访问入口
base Boolean 否 true,false false 是否需要一直在页面中显示
path [String,Array] 否 - [] 项目的显示条件，当base为true时，path的值会被忽略
routeMode String 否 hash，history hash 路由模式。 routeMode 和 path 配合使用来确认项目的显示与否
domID String 否 - '' 项目要挂载的dom节点的id属性
customProps Object 否 - {} 各个生命周期要传递到项目的自定义属性

grape实例

grape实例有两个方法，分别是start方法和setImportMap方法。

setImportMap方法的使用见下文

start方法

start 方法可以接受一个对象作为参数

grape.start({})

对象的属性

属性名 类型 是否必填 可选值 默认值 描述
fetch Function 否 - window.fetch @hydesign/grape 通过 fetch 函数来获取项目访问入口对应的 html 文档，fetch函数必须返回一个promise

设置子项目的生命周期函数

import vue from 'vue';
import App from './App.vue';
import router from './router';
import singleSpaVue from 'single-spa-vue';
const vueLifecycles = singleSpaVue({
  Vue:vue,
  appOptions: {
    el:'#main',
    render: (h) => h(App),
    router,
  },
});

export const bootstrap = vueLifecycles.bootstrap;
export const mount = vueLifecycles.mount;
export const unmount = vueLifecycles.unmount;

给子项目的入口js加标识

经过打包工具（如：webpack）打包之后一个项目在 index.html 中插入的 js 脚本可能不只一个，所以为了确保@hydesign/grape能够正确的从项目中解析到入口js，给入口 js 文件加上一个 entry 属性，如果所有的js脚本都没有 entry 属性,@hydesign/grape会将index.html 的中最后一个脚本当作入口js

const ScriptExtHtmlWebpackPlugin = require('script-ext-html-webpack-plugin')
plugins:[
    ...
    new ScriptExtHtmlWebpackPlugin({
      custom: {
        test: /app.*\.js$/,
        attribute: 'entry',
        value: true
      }
    })
  ]

将子项目打包成umd格式

output: {
    ...
    libraryTarget: 'umd',
    library: xxx,
}

与 webpack 的 external 配合

@hydesign/grape与webpack的 externals 配合使用，能够抽离出项目中不想打包的库，并且在项目运行当使用到这个库的时候在动态加载。

 externals(['vue',{'vue-router':'vueRouter'},{'element-ui':'elementUI'},'axios','hytools'])

 import Grape from '@hydesign/grape';

 new Grape(appsConf)
        .setImportMap({
                "vue": "https://cdn.jsdelivr.net/npm/[email protected]/dist/vue.js",
                "vueRouter": "https://cdn.jsdelivr.net/npm/[email protected]/dist/vue-router.min.js",
                "elementUI":"https://cdn.jsdelivr.net/npm/[email protected]/lib/index.js",
                "Vuex":"https://cdn.jsdelivr.net/npm/[email protected]/dist/vuex.min.js",
                "axios":"https://cdn.jsdelivr.net/npm/[email protected]/dist/axios.min.js"
            })
        .start()

demo

github 源代码