使用 hel-micro 制作远程 antd、tdesign-react

[fantasticsoul]

hel-micro，模块联邦 sdk 化，免构建、热更新、工具链无关的微模块方案 ，欢迎关注与了解

制作远程 react 图形组件库

使用 hel-micro 模块联邦技术 sdk 化方案，基于react 组件模板制作远程antd库（hel-antd）、远程tdesign-react库（hel-tdesign-react）。

hel-antd 、hel-tdesign-react 两者制作过程完全一样，区别仅是安装的库不同，你可以参考此文将其他优秀的react图形组件库制作为对应的远程库，以下步骤以制作 hel-antd 为主。

传统的 react 图形组件库导入方式，多项目升级时很麻烦：

基于 hel-micro 提升为远程库后，被其他项目使用时，实际运行逻辑不参与项目打包，可以做到使用方无感知动态升级（顺带也降低了项目打包体积，并提高编译速度），以 antd 为例，假如你有 5 个项目用到了 antd2.20 ，某一天暴露出 2.20 存在了一个严重 bug ，官方升级到了 2.21 版本，这时候你需要把你的 5 个项目全部安装一下最新的 antd 版本并重新部署一遍，而如果是引用的 hel-antd ，就只需要基于 2.21 版本重新发布一下 hel-antd 即可，所用使用方就可以运行最新版本的 antd 了。

基于代理对象技术使用方可以像使用本地 antd 一样使用远程 antd 、远程 tdesign-react ，见在线示例：使用 hel-antd 、使用 hel-tdesign-react

克隆 react 模板库

克隆 react 模板库，保存为hel-antd目录，接下来的步骤里，我们都将基于此目录下的文件改造

git clone https://github.com/hel-eco/hel-tpl-remote-react-comp-ts.git hel-antd

修改模块名称

• 修改package.json里的模块名称为hel-antd

- "name": "hel-tpl-remote-react-comps-ts",
- "appGroupName": "hel-tpl-remote-react-comps-ts",
+ "name": "hel-antd",
+ "appGroupName": "hel-antd",

• 修改项目里 src/configs/subApp.ts 的 LIB_NAME 为 hel-antd（如不修改，构建时会报模块名不一致错误）

- export const LIB_NAME = 'hel-tpl-remote-react-comps-ts';
+ export const LIB_NAME = 'hel-antd';

可根据需要修改为自己想要的命名，此处仅为示例

安装 antd

此处我们基于4.23.4版本的 antd 构建远程 antd 库

npm i [email protected]

导出 antd 模块

导出 antd 模块主要包含 2 个部分，

• 导出运行时代码供webpack打包用，方便hel-micro可以动态拉取已构建的运行代码
• 导出代理对象供rollup打包用，方便使用方可以安装远程模块类型文件，并在文件头使用import静态导入远程模块

运行时代码导出

我们先在src/components下导出我们想要暴露的远程组件

- import HelloRemoteReactComp from './HelloRemoteReactComp';
- export {
-   HelloRemoteReactComp,
- }

+ import * as antd from 'antd';
+ export { default as TestExport } from './TestExport';
+ export default antd;

注意此处额外导出了一个TestExport组件，用于示范可以扩展原始antd库加入自己的新组件

function TestExport() {
  return <span>TestExport Component</span>
};
TestExport.displayName = 'TestExport';
export default TestExport;

然后在src/entrance/libProperties.ts里合并导出模块（此合并逻辑也可在src/components里面处理），并同时暴露推导出的模块类型对象

- import comps from 'components';
- export type LibProperties = typeof comps;
- export default comps;

+ import antd, { TestExport } from 'components';
+ const toExport = { ...antd, TestExport };
+ export type LibProperties = typeof toExport;
+ export default toExport;

代理对象导出

src/entrance/libTypes.ts文件内容表示导出代理对象，对象的实际内容由使用方hel-micro模块的preFetchLib函数填充，如下面的一行也不修改也是没问题的

import type { LibProperties } from './libProperties';
import { exposeLib } from 'hel-lib-proxy';
import { LIB_NAME } from 'configs/subApp';

export const lib = exposeLib<LibProperties>(LIB_NAME);
export type Lib = LibProperties;
export default lib;

但使用方只能使用 default 导出语法，而不能在文件头直接解构

// ok
import antd from 'hel-antd';
const { Button } = antd;

// error
import  { Button } from 'hel-antd';

为了支持文件头直接解构的写法，我们需要调整src/entrance/libTypes.ts文件内容，单独导出antd的各个组件

// 以下单个导出，支持 import { Button } from 'hel-antd'; 直接解构的语法
+ export const Affix = lib.Affix;
+ export const Alert = lib.Alert;

引入样式文件

在src/index.ts文件里导入 antd 的样式文件，因 hel-antd 支持使用 css 变量自定义主题，所以导入的时调整后的样式文件（将原始 css 文件的关键颜色替换为 css 变量）

import { libReady, isMasterApp } from 'hel-lib-proxy';
import { LIB_NAME } from './configs/subApp';
+ import './styles/theme.css';
+ import './styles/antd-style.css';

如不需要此功能，直接导入原始样式文件即可

import { libReady, isMasterApp } from 'hel-lib-proxy';
import { LIB_NAME } from './configs/subApp';
+ import 'antd/dist/antd.css'

打包与发布

修改package.json里的version版本号为1.0.0，运行 build 命令打包

npm run build

运行 publish 命令发布

npm publish

发布成功后，可以访问 unpkg 链接获取元数据验证是否已发布到 cdn：

• js 入口文件 https://unpkg.com/hel-antd

• 元数据 json 描述文件 https://unpkg.com/[email protected]/hel_dist/hel-meta.json

使用远程 antd

使用远程 antd 包括预加载远程模块和导入代理模块两个步骤

预加载远程模块

使用 npm 命令按照代理模块

npm i hel-antd

入口文件后移，绑定 react 公共对象，预加载hel-antd，让远程模块的实际运行代码通过hel-micro填充到代理模块里

import { preFetchLib, bindReactRuntime } from "hel-micro";
import React from "react";
import ReactDOM from "react-dom";
import ReactIs from "react-is";

bindReactRuntime({ React, ReactDOM, ReactIs });

async function main() {
  // 预加载远程模块 ，例如 hel-antd
  await preFetchLib("hel-antd", { enableDiskCache: true });
  await import("./loadApp"); // 你的原始入口文件
}

main().catch(console.error);

preFetchLib默认总是拉取最新版本模块，如需运行时锁定版本号，透传版本号即可。

  await preFetchLib("hel-antd", { enableDiskCache: true, versionId:'1.0.0' });

此时可把版本号集中放后台某个地方管理（例如配置中心、自建的模块管控中心等），并统一下发到前端，就可以很方便的按需定制版本加载策略了。

导入代理模块

接下来你可以在项目里除入口文件之外的其他任意文件想导入本地模块一样导入远程模块并使用了。

import { Button } from "hel-antd";

// render antd  Button
<Button danger>remote antd button</Button>

新窗口访问在线示例：使用 hel-antd 、使用 hel-tdesign-react

自定义 cdn

hel-micro 默认采用的是unpkg文件 cdn 服务，如有自建的unpkg私服，可调整打包策略注入自己的 cdn 服务前缀，只需要修改config/subApp.js即可

- const subApp = helDevUtils.createReactSubApp(pkg, { npmCdnType: 'unpkg' });
+ const subApp = helDevUtils.createReactSubApp(pkg, { npmCdnType: 'unpkg', homePage: 'http://my-unpkg.com' });

自建 npm+unpkg 私服可参考issue 19

结语

使用hel-micro，可以用极低的代价来铺开模块联邦技术，优势见往期文章hel-micro 模块联邦新革命，欢迎了解与使用^_^

---

附：我的其他开源作品友链（欢迎关注与了解）：

concent，一个自带依赖收集、提供 setup 特性的 react 数据流方案

limu，一个比 immer 更高效的 js 不可变操作库