EMP微前端-带你快速入门!

·  阅读 3483

本文讲述的是react项目中如何接入和使用emp。场景主要是两种, 第一种是通过@efox/emp-cli初始化新建项目(已默认接入),第二种就是现有的react项目如何改造emp。

越来越多公司团队都用上了微前端(微前端是什么可以点这里哟),今天小编就手把手带你快速感受一番EMP微前端的开发体验(EMP是什么点击这里+1),话不多说,开始吧~

开箱使用EMP

了解一下emp命令

EMP维护了一套cli脚手架和一系列的template模板,可以让新手开箱使用。

首先我们可以全局安装@efox/emp-cli

yarn global add @efox/emp-cli
// or npm i -g @efox/emp-cli 
复制代码

安装成功后,我们可以输入命令查看版本:

emp -v
复制代码

当然,我们也可以查看帮助更好了解emp命令的使用:

emp -h
复制代码

初始化两个应用项目

接下来,我们会在emp初始化的指引下,建立两个应用项目,分别命名为react-basereact-project,我们将体验两个项目之间如何进行资源共享。

我们先执行初始化指令,跟着命令的指引完成项目初始化,模板我们先选择react-base

emp init
复制代码

我们可以先看看react-base的目录:

其中重点关注的是emp-config.js这个文件。从这个文件中,我们可以看出使用了webpack的mfhtml两个插件,我们先看mf插件的传参:

  config.plugin('mf').tap(args => {
    args[0] = {
      ...args[0],
      ...{
        // 项目名称
        name: 'empReactBase',
        // 暴露项目的全局变量名
        library: {type: 'var', name: projectName},
        // 被远程引入的文件名
        filename: 'emp.js',
        remotes: {
          // 远程项目别名:远程引入的项目名
          '@emp/react-project': 'empReactProject',
          // ...
        },
        // 需要暴露的东西
        exposes: {
          // 别名:组件的路径
          './configs/index': 'src/configs/index',
          // ...
        },
        // 需要共享的依赖
        shared: {...dependencies},
      },
    }
    return args
  })
复制代码

参数含义:

字段名类型含义
namestring项目名称,可以理解为应用的身份证,在应用分享资源时使用的标识应用唯一性的凭证
libraryobject暴露项目的全局变量名, 声明一个挂载在全局下的变量名
filenamestring构建后的chunk名称,也是被远程引入的文件名,可以理解为应用有了身份证还需要具体的入口地址才可以互相使用资源
remotesobject此处声明该应用想使用其他应用的什么资源,格式如:【远程项目别名:远程引入的项目名(即其他应用身份证name字段)】
exposesobject此处声明该应用可以分享出去什么资源,格式如【别名:组件的路径】
sharedobject需要共享的依赖,可以在这里控制第三包的版本号

我们再留意一下html插件的传参:

// 配置 index.html
  config.plugin('html').tap(args => {
    args[0] = {
      ...args[0],
      ...{
        // head 的 title
        title: 'EMP-Base-Project',
        // 远程调用项目的文件链接
        files: {
          js: ['http://localhost:8002/emp.js'],
        },
      },
    }
    return args
  })
复制代码

参数含义:

字段名类型含义
titlestringhead 的 title
filesobject远程调用项目的文件链接,这里该应用加载了另外一个端口应用的微前端入口文件,这样该应用就可以美滋滋得使用其他应用的资源啦

看到这里,我们大概理解了react-base项目的emp.config.js文件是怎么配置想要其他应用的资源,以及如何分享出去自己的资源的,那么我们再初始化一个react-project项目来实践一下吧,记得选择react-project模板:

我们对比react-basereact-project项目的配置,看到react-baseemp.config.js配置文件中声明分享了一个Hello组件:

exposes: {
  // 别名:组件的路径
  './components/Hello': 'src/components/Hello',
},
复制代码

react-projectemp.config.js配置文件中声明需要使用react-base项目的Hello组件:

remotes: {
  // 远程项目别名:远程引入的项目名
  '@emp/react-base': 'empReactBase',
},
复制代码

并且react-project在项目代码中,引入使用了react-base项目的Hello组件:

import HelloDEMO from '@emp/react-base/components/Demo'
const App = () => (
  <>
    // ...
     <HelloDEMO />
    // ...
  </>
)
复制代码

那么,我们跟着指令分别跑起react-basereact-project项目来看Hello组件引入效果吧:

cd react-base && yarn && yarn dev
cd react-project && yarn && yarn dev
复制代码

恭喜你跨入EMP微前端第一步!!!

应用之间可以分享的东西可多了,包括UI组件、函数甚至是应用,赶紧试试吧~

已有项目接入EMP

很多情况下,我们应用微前端希望是可以无缝接入现有项目的。那么,在现有的React项目中如何中途无缝接入EMP更真实感受EMP的魅力呢?我们一起来吧~

1. 修改package.json

我们可以根据上面react-basereact-project项目中的package.json,将其中的scripts命令按需添加进已有的项目:

"scripts": {
    "dev": "emp dev",
    "dev:hot": "emp dev --hot",
    "build": "emp build",
    "build:ts": "emp build -t",
    "build:lab": "emp build --env lab",
    "tss": "emp tss http://localhost:8001/index.d.ts -n @emp-react-base.d.ts",
    "start": "emp serve",
    "analyze": "emp build --analyze"
},
复制代码

2. 添加emp-config.js

我们在当前项目根目录下添加emp-config.js配置文件,内容也可以参考react-basereact-project项目,只要懂得了配置字段的含义,相信一点都不难:

const path = require('path')
const packagePath = path.join(path.resolve('./'), 'package.json')
const {dependencies} = require(packagePath)
console.log(packagePath)

module.exports = ({config, env}) => {
  const port = 8003
  const projectName = 'projectName'
  const publicPath = `http://localhost:${port}/`
  config.plugin('mf').tap(args => {
    args[0] = {
      ...args[0],
      ...{
        // 项目名称
        name: projectName,
        // 暴露项目的全局变量名
        library: {type: 'var', name: projectName},
        // 被远程引入的文件名
        filename: 'emp.js',
        // 远程项目别名:远程引入的项目名
        remotes: {
          '@emp/react-base': 'empReactBase',
        },
        // 需要暴露的东西
        exposes: {
          // 别名:组件的路径,例如:
          //'./configs/index': 'src/configs/index',
        },
        shared: {...dependencies},
      },
    }
    return args
  })
  config.output.publicPath(publicPath)
  config.devServer.port(port)
  config.plugin('html').tap(args => {
    args[0] = {
      ...args[0],
      ...{
        files: {
          js: ['http://localhost:8001/emp.js'],
        },
      },
    }
    return args
  })
}
复制代码

3.添加入口文件

接着,可以在src目录下增加入口文件bootstrap.tsx和 index.ts。

其中index.ts文件内容如下:

import('./bootstrap')
复制代码

bootstrap.tsx内容如下:

import React from 'react'
import ReactDOM from 'react-dom'
import App from 'src/view/index' //原来项目的入口文件
ReactDOM.render(<App />, document.getElementById('emp-root'))
复制代码

4.使用共享资源

接下来,我们就可以在项目中引用远程组件了:

import HelloDEMO from '@emp/react-base/components/Demo'
const App = () => (
  <>
    <HelloDEMO />
  </>
)
export default App
复制代码

最后

在实际使用中,我们可能会遇到下面几点小问题:

  1. 项目中如果使用了@别名,需要在emp-config.js增加以下代码
  config.resolve.alias
    .set('@', path.resolve('./', 'src'))
复制代码
  1. 在webpack5中是默认没有node的core module,如果使用了这些核心库。需要在emp-config.js增加这些核心库,代码如下:
  config.resolve.alias
    .set('zlib',"browserify-zlib")
    .set('assert', "assert")
    .set('buffer', "buffer")
    .set('util', "util")
    .set('stream', "stream-browserify")
    .set('timers', "timers-browserify")
复制代码

最后的最后,EMP微前端其实不局限于React项目,Vue项目也可以快速启用和接入,甚至cocos游戏项目也可以无缝使用EMP微前端方案(cocos游戏项目应用EMP会给大家带来精彩文章,尽情关注wiki博文首发)。EMP微前端目前已经应用在了我司内部80%大型项目,具有稳健性、灵活性和可靠性,是一个非常适合想学习和使用微前端的童鞋们的微前端框架,欢迎大家一起在EMP的github上一起学习和交流

分类:
前端
标签:
分类:
前端
标签:
收藏成功!
已添加到「」, 点击更改