https://github.com/tengmaoqing/vite-plugin-qiankun

保留vite es特性，快速接入乾坤微前端子应用
https://github.com/tengmaoqing/vite-plugin-qiankun

Last synced: 7 days ago
JSON representation

保留vite es特性，快速接入乾坤微前端子应用

• Host: GitHub
• URL: https://github.com/tengmaoqing/vite-plugin-qiankun
• Owner: tengmaoqing
• License: mit
• Created: 2021-07-03T06:46:57.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-06-17T03:20:36.000Z (5 months ago)
• Last Synced: 2024-10-14T06:28:49.817Z (about 1 month ago)
• Language: TypeScript
• Size: 1.02 MB
• Stars: 462
• Watchers: 3
• Forks: 83
• Open Issues: 46
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
#### 简介

> vite-plugin-qiankun: 帮助应用快速接入乾坤的vite插件

- 保留vite构建es模块的优势

- 一键配置，不影响已有的vite配置

- 支持vite开发环境

#### 快速开始

###### 1、在 `vite.config.ts` 中安装插件

```typescript

// vite.config.ts

import qiankun from 'vite-plugin-qiankun';

export default {

  // 这里的 'myMicroAppName' 是子应用名，主应用注册时AppName需保持一致

  plugins: [qiankun('myMicroAppName')],

  // 生产环境需要指定运行域名作为base

  base: 'http://xxx.com/'

}

```

###### 2、在入口文件里面写入乾坤的生命周期配置

```typescript

// main.ts

import { renderWithQiankun, qiankunWindow } from 'vite-plugin-qiankun/dist/helper';

// some code

renderWithQiankun({

  mount(props) {

    console.log('mount');

    render(props);

  },

  bootstrap() {

    console.log('bootstrap');

  },

  unmount(props: any) {

    console.log('unmount');

    const { container } = props;

    const mountRoot = container?.querySelector('#root');

    ReactDOM.unmountComponentAtNode(

      mountRoot || document.querySelector('#root'),

    );

  },

});

if (!qiankunWindow.__POWERED_BY_QIANKUN__) {

  render({});

}

```

###### 3、dev下作为子应用调试

> 因为开发环境作为子应用时与热更新插件（可能与其他修改html的插件也会存在冲突）有冲突，所以需要额外的调试配置

```typescript

// useDevMode 开启时与热更新插件冲突,使用变量切换

const useDevMode = true

const baseConfig: UserConfig = {

  plugins: [

    ...(

      useDevMode ? [] : [

        reactRefresh()

      ]

    ),

    qiankun('viteapp', {

      useDevMode

    })

  ],

}

```

上面例子中 `useDevMode = true` 则不使用热更新插件，`useDevMode = false` 则能使用热更新，但无法作为子应用加载。

###### 4、其它使用注意点 `qiankunWindow`

因为es模块加载与`qiankun`的实现方式有些冲突，所以使用本插件实现的`qiankun`微应用里面没有运行在js沙盒中。所以在不可避免需要设置window上的属性时，尽量显示的操作js沙盒，否则可能会对其它子应用产生副作用。qiankun沙盒使用方式

```typescript

import { qiankunWindow } from 'vite-plugin-qiankun/dist/helper';

qiankunWindow.customxxx = 'ssss'

if (qiankunWindow.__POWERED_BY_QIANKUN__) {

  console.log('我正在作为子应用运行')

}

```

#### 例子

详细的信息可以参考例子里面的使用方式

 ```

git clone xx

npm install

npm run example:install

# 生产环境调试demo

npm run example:start

# vite开发环境demo, demo中热更新已经关闭

npm run example:start-vite-dev

```