前面几篇文章,我们分析了umijs
「核心」Service
「类的初始化流程」、「插件化的核心流程」以及「构建阶段」dev
「命令的执行流程」。那我们今天继续分析项目在「运行时阶段」又会做哪些事呢?
在开始今天的文章之前,大家不妨想几个问题:
plugin-model
、plugin-request
等插件)又是「如何注册到项目」中的?render
「方法」?umijs
生成的「临时文件通过其他构建工具」(不限于webpack
、rollup
、esbuild
)可以跑起来吗?在前面我们提到了在解析preset-built-in
预设阶段会批量导入generate files
相关的plugin
,同时在这些plugin
中注册onGenerateFiles
钩子,然后在webpack
编译前触发,生成临时文件。
接下来,我们从入口文件出发,看下通过执行umi dev
命令生成的入口文件内容:
// path: src/.umi/umi.ts
// @ts-nocheck
import './core/polyfill';
import '@@/core/devScripts';
import { plugin } from './core/plugin';
import './core/pluginRegister';
import { createHistory } from './core/history';
import { ApplyPluginsType } from '~/umi-test/node_modules/@umijs/runtime';
import { renderClient } from '~/umi-test/node_modules/@umijs/renderer-react';
import { getRoutes } from './core/routes';
const getClientRender = (args: { hot?: boolean; routes?: any[] } = {}) => plugin.applyPlugins({
key: 'render',
type: ApplyPluginsType.compose,
initialValue: () => {
const opts = plugin.applyPlugins({
key: 'modifyClientRenderOpts',
type: ApplyPluginsType.modify,
initialValue: {
routes: args.routes || getRoutes(),
plugin,
history: createHistory(args.hot),
isServer: process.env.__IS_SERVER,
rootElement: 'root',
defaultTitle: ``,
},
});
return renderClient(opts);
},
args,
});
const clientRender = getClientRender();
export default clientRender();
window.g_umi = {
version: '3.5.14',
};
// hot module replacement
...
首先可以看到文件的顶部导入了polyfill
文件,也就是我们平时自己开发项目导入的babel
相关的polyfill
文件。
❝当然在
umi-next
版本已经在尝试用swc
代替babel
,感兴趣的小伙伴可以自行查阅umi-next
的相关issues
。❞
// path: src/.umi/umi.ts
// @ts-nocheck
import 'core-js';
import 'regenerator-runtime/runtime';
export {};
接下来我们继续往下分析,通过执行getClientRender
函数,返回clientRender
。在getClientRender
函数内部我们看到了熟悉的面孔--plugin
,运行时阶段同样通过插件化返回渲染需要的render
方法。
值得注意的是这里的Plugin
是有别于前面提到的PluginAPI
,PluginAPI
是在作用于编译阶段,而Plugin
是作用于运行时的插件。
接下来,我们看下运行时插件是怎么实现的。
❝阅读源码最好的出入点就是从它的测试用例出发。测试用例是题干,源码就是答案。 ------加夫列尔·加西亚·马尔波斯
❞
「接下来我们从不同方向出发,更好的了解运行时插件机制的原理及实现。」
接下来,我们看下几个plugin
的「测试用例」:
key
,同时在register
时会校验key
是否允许test('invalid key', () => {
const p = new Plugin({
validKeys: [],
});
expect(() => {
p.register({
apply: { foo: 1 },
path: '/foo.js',
});
}).toThrow(/invalid key foo from plugin \/foo.js/);
});
2 . 通过getHooks
方法可获取指定key
注册的hook
test('getHooks', () => {
const p = new Plugin({
validKeys: ['foo'],
});
p.register({
apply: { foo: 1 },
path: '/foo1.js',
});
p.register({
apply: { foo: 2 },
path: '/foo2.js',
});
expect(p.getHooks('foo')).toEqual([1, 2]);
});
3 . 通过applyPlugins
方法可执行指定key
注册的hook
,同时还支持以下三种操作:
hook
的返回值作为入参传递给下一个hook
args
当前hook
的其他参数initialValue
// path: ~/umi/packages/runtime/src/Plugin/Plugin.test.ts
test('applyPlugins modify', () => {
const p = new Plugin({
validKeys: ['foo'],
});
p.register({
apply: {
foo(memo: object) {
return { ...memo, a: 1 };
},
},
path: '/foo1.js',
});
p.register({
apply: {
foo(memo: object, args: { step: number }) {
return { ...memo, b: 1 + ((args && args.step) || 0) };
},
},
path: '/foo2.js',
});
p.register({
apply: {
foo: {
a: 2,
c: 1,
},
},
path: '/foo3.js',
});
// 1. 把上一个hook的返回值作为入参传递给下一个hook
expect(
p.applyPlugins({
key: 'foo',
type: ApplyPluginsType.modify,
}),
).toEqual({
a: 2,
b: 1,
c: 1,
});
// 2. 支持args当前hook的其他参数
expect(
p.applyPlugins({
key: 'foo',
type: ApplyPluginsType.modify,
args: { step: 5 },
}),
).toEqual({
a: 2,
b: 6,
c: 1,
});
// 3. 支持默认值initialValue
expect(
p.applyPlugins({
key: 'foo',
type: ApplyPluginsType.modify,
initialValue: { d: 4 },
}),
).toEqual({
a: 2,
b: 1,
c: 1,
d: 4,
});
});
通过分析Plugin
常见的「测试用例」,我们大致知道了Plugin
的使用方法,那么接下来我们从「源码」出发,更加进一步的了解Plugin
的工作流程。
// path: ~/umi/packages/runtime/src/Plugin/Plugin.ts
export default class Plugin {
validKeys: string[];
hooks: {
[key: string]: any;
} = {};
constructor(opts?: IOpts) {
this.validKeys = opts?.validKeys || [];
}
// 注册插件
register(plugin: IPlugin) {
assert(!!plugin.apply, `register failed, plugin.apply must supplied`);
assert(!!plugin.path, `register failed, plugin.path must supplied`);
Object.keys(plugin.apply).forEach((key) => {
assert(
this.validKeys.indexOf(key) > -1,
`register failed, invalid key ${key} from plugin ${plugin.path}.`,
);
if (!this.hooks[key]) this.hooks[key] = [];
this.hooks[key] = this.hooks[key].concat(plugin.apply[key]);
});
}
// 获取 hook
getHooks(keyWithDot: string) {
const [key, ...memberKeys] = keyWithDot.split('.');
let hooks = this.hooks[key] || [];
if (memberKeys.length) {
hooks = hooks
.map((hook: any) => {
try {
let ret = hook;
for (const memberKey of memberKeys) {
ret = ret[memberKey];
}
return ret;
} catch (e) {
return null;
}
})
.filter(Boolean);
}
return hooks;
}
// 执行 hook
applyPlugins({
key,
type,
initialValue,
args,
async,
}) {
const hooks = this.getHooks(key) || [];
switch (type) {
case ApplyPluginsType.modify:
if (async) {
return hooks.reduce(
async (memo: any, hook: Function | Promise<any> | object) => {
if (isPromiseLike(memo)) {
memo = await memo;
}
if (typeof hook === 'function') {
const ret = hook(memo, args);
if (isPromiseLike(ret)) {
return await ret;
} else {
return ret;
}
} else {
if (isPromiseLike(hook)) {
hook = await hook;
}
return { ...memo, ...hook };
}
},
isPromiseLike(initialValue)
? initialValue
: Promise.resolve(initialValue),
);
} else {
return hooks.reduce((memo: any, hook: Function | object) => {
if (typeof hook === 'function') {
return hook(memo, args);
} else {
// TODO: deepmerge?
return { ...memo, ...hook };
}
}, initialValue);
}
case ApplyPluginsType.event:
return hooks.forEach((hook: Function) => {
hook(args);
});
case ApplyPluginsType.compose:
return () => {
return _compose({
fns: hooks.concat(initialValue),
args,
})();
};
}
}
}
首先从Plugin
初始化阶段我们可以看到,Plugin
的hook
是不同于构建时插件的hook
,Plugin
的hook
在初始化阶段就定义好了允许注册hook
的key
,同时后续也不允许修改。在register
阶段注册插件时会通过validKeys
校验是否允许注册当前插件。
接下来是通过getHooks
获取指定key
对应的hook
,在测试用例阶段我们只分析了key='foo'
简单格式的用例,而在正式使用过程中还支持key='a.b.c'
格式的注册方式。
Plugin
执行插件同样是调用applyPlugins
方法,并且支持modify
、event
和compose
三种类型的hook
。相较于构建时的插件执行流程还是比较简单的。
分析完Plugin
源码,那我们再看下umijs
的临时文件又是如何使用Plugin
进行注册和执行hook
的。
我们回忆下入口文件umi.ts
内容:
// path: src/.umi/umi.ts
// @ts-nocheck
...
import { plugin } from './core/plugin';
import './core/pluginRegister';
...
const getClientRender = (args) => plugin.applyPlugins({
key: 'render',
type: ApplyPluginsType.compose,
initialValue: () => {},
args,
});
...
// path: src/.umi/core/plugin.ts
// @ts-nocheck
import { Plugin } from '~/umi-test/node_modules/@umijs/runtime';
const plugin = new Plugin({
validKeys: ['modifyClientRenderOpts','patchRoutes','rootContainer','render','onRouteChange','__mfsu','getInitialState','initialStateConfig','request',],
});
export { plugin };
// path: src/.umi/core/pluginRegister.ts
// @ts-nocheck
import { plugin } from './plugin';
import * as Plugin_0 from '../plugin-initial-state/runtime';
import * as Plugin_1 from '../plugin-model/runtime';
plugin.register({
apply: Plugin_0,
path: '../plugin-initial-state/runtime',
});
plugin.register({
apply: Plugin_1,
path: '../plugin-model/runtime',
});
分析上面代码,首先会从./core/plugin
文件导入实例化好的plugin
,同时在./core/pluginRegister
中注册plugin
,然后在入口执行key=render
的hook
获取渲染所需的render
方法。
接下来,我们再看下临时文件plugin.ts
和pluginRegister.ts
是如何生成的。
// path: ~/umi/packages/preset-built-in/src/plugins/generateFiles/core/plugin.ts
export default function (api: IApi) {
api.onGenerateFiles(async (args) => {
const validKeys = await api.applyPlugins({
key: 'addRuntimePluginKey',
type: api.ApplyPluginsType.add,
initialValue: [
'modifyClientRenderOpts',
'patchRoutes',
'rootContainer',
'render',
'onRouteChange',
'__mfsu',
],
});
const plugins = await api.applyPlugins({
key: 'addRuntimePlugin',
type: api.ApplyPluginsType.add,
initialValue: [
getFile({
base: paths.absSrcPath!,
fileNameWithoutExt: 'app',
type: 'javascript',
})?.path,
].filter(Boolean),
});
api.writeTmpFile({
path: 'core/plugin.ts',
content: Mustache.render(
readFileSync(join(__dirname, 'plugin.tpl'), 'utf-8'),
{
validKeys,
runtimePath,
},
),
});
api.writeTmpFile({
path: 'core/pluginRegister.ts',
content: Mustache.render(
readFileSync(join(__dirname, 'pluginRegister.tpl'), 'utf-8'),
{
plugins: plugins.map((plugin: string, index: number) => {
return {
index,
path: winPath(plugin),
};
}),
},
),
});
});
...
}
分析生成文件plugin.ts
的插件,我们可以看到这个插件主要做了4件事:
1 . 调用「构建时插件」的addRuntimePluginKey
的hook
获取运行时插件所需的validKeys
❝注:我们开发自定义插件时,可以通过
addRuntimePluginKey
注册自定义的validKey
❞
2 . 调用「构建时插件」的addRuntimePlugin
的hook
获取运行时所需的插件
❝注:我们可以看到运行时插件的默认值
initialValue
是从src/app
文件中获取的,也就是在src/app
文件中注册我们所需的hook
,例如:通过patchRoutes
更改路由、通过onRouteChange
设置标题等操作❞
3 . 读取plugin.tpl
模版,生成临时文件plugin.ts
4 . 读取pluginRegister.tpl
模版,生成临时文件pluginRegister.ts
接下来,回到入口文件.umi/umi.ts
的getClientRender
方法。
import { renderClient } from '~/umi-test/node_modules/@umijs/renderer-react';
const getClientRender = (args: { hot?: boolean; routes?: any[] } = {}) => plugin.applyPlugins({
key: 'render',
type: ApplyPluginsType.compose,
initialValue: () => {
// 获取 renderClient 方法所需的参数
const opts = plugin.applyPlugins({
key: 'modifyClientRenderOpts',
type: ApplyPluginsType.modify,
initialValue: {
routes: args.routes || getRoutes(),
plugin,
history: createHistory(args.hot),
isServer: process.env.__IS_SERVER,
rootElement: 'root',
defaultTitle: ``,
},
});
return renderClient(opts);
},
args,
});
const clientRender = getClientRender();
export default clientRender();
从上面代码,可以看出执行clientRender
方法返回的结果就是执行renderClient
方法的返回值。那么接下来,我们看下renderClient
方法到底做了哪些事情。
从上面可以看到renderClient
方法是从@umijs/renderer-react
包中导出的:
// path: ~/umi/packages/renderer-react/src/renderClient/renderClient.tsx
import { hydrate, render } from 'react-dom';
export default function renderClient(opts: IOpts) {
const rootContainer = opts.plugin.applyPlugins({
type: ApplyPluginsType.modify,
key: 'rootContainer',
initialValue: (
<RouterComponent
history={opts.history}
routes={opts.routes}
plugin={opts.plugin}
ssrProps={opts.ssrProps}
defaultTitle={opts.defaultTitle}
/>
),
args: {
history: opts.history,
routes: opts.routes,
plugin: opts.plugin,
},
});
if (opts.rootElement) {
const rootElement =
typeof opts.rootElement === 'string'
? document.getElementById(opts.rootElement)
: opts.rootElement;
const callback = opts.callback || (() => {});
// flag showing SSR successed
if (window.g_useSSR) {
...
} else {
render(rootContainer, rootElement, callback);
}
} else {
return rootContainer;
}
}
分析renderClient
方法主要做了2件事:
rootContainer
运行时阶段的hook
,获取rootContainer
组件rootElement
DOM元素rootContainer
作为根组件,rootElement
作为根元素,执行render
方法,挂载组件,此时的render
方法也就是react-dom
导出的render
方法接下来,我们再看下rootContainer
组件的initialValue
:
import { ApplyPluginsType, Plugin, Router } from '@umijs/runtime';
function RouterComponent(props: IRouterComponentProps) {
const { history, ...renderRoutesProps } = props;
useEffect(() => {
function routeChangeHandler(location: any, action?: string) {
...
// 触发 onRouteChange 对应的 hook
props.plugin.applyPlugins({
key: 'onRouteChange',
type: ApplyPluginsType.event,
args: {
routes: props.routes,
matchedRoutes,
location,
action,
},
});
}
routeChangeHandler(history.location, 'POP');
return history.listen(routeChangeHandler);
}, [history]);
return <Router history={history}>{renderRoutes(renderRoutesProps)}</Router>;
}
这里RouterComponent
返回的Router
也就是react-router-dom
包中导出的Router
组件,同时在RouterComponent
组件内部监听history
,在history
发生变化时触发运行时阶段的onRouteChange
对应的hook
,此时也就可以触发我们自己在业务代码中订阅的onRouteChange
的回调了,例如:监听路由改变时,发送埋点或者改变document.title
。
到这里,umijs
项目也就可以跑起来了。那么执行umi dev
命令生成的临时文件,同样是通过umijs
内部的webpack
构建工具以及umijs
内部自己实现的server
让项目跑起来的,也就是说如果我们仅仅是让umijs
帮我们生成临时文件,而项目的构建通过第三方构建工具是否也是可以呢?
接下来,我们通过esbuild
如何让项目跑起来呢?
❝An extremely fast JavaScript bundler.
❞
简单介绍下esbuild
:它是一个「极速的模块打包工具」,有着相较于webpack
、rollup
等构建工具高到离谱的性能优势。至于esbuild
构建速度为何如此之快,首先从语言特性(esbuild
底层是使用Go
语言开发的)就赢了一半,尤其在资源打包这种「CPU密集」场景下,感兴趣的小伙伴可以自行查询亦或持续关注我们的公众号。
除了「构建功能」,esbuild
还提供了「服务」。话不多说,上代码:
const esbuild = require('esbuild');
const http = require('http');
const path = require('path')
const { lessLoader } = require('esbuild-plugin-less')
esbuild.serve({
// 服务根路径
servedir: path.resolve(__dirname, 'www'),
}, {
format: 'iife',
logLevel: 'error',
outdir: 'www/',
platform: "browser",
bundle: true,
define: {
// HOOK:umi 内部会用到
'process.env.__IS_SERVER': JSON.stringify('null')
},
plugins: [lessLoader({
javascriptEnabled: true
})],
external: ['esbuild'],
// 入口文件
entryPoints: [path.resolve(__dirname, 'src/.umi/umi.ts')]
}).then(result => {
console.log('service: ', `http://127.0.0.1:${result.port}`);
});
我们通过esbuild
提供的serve
API在本地开启web
服务器来为我们通过esbuild
构建生成的代码提供服务。简单介绍下esbuild
的使用方法:
servedir
entryPoints
以及出口路径outdir
platform
和bundle
最后一点就是esbuild
默认是不支持less
文件,需要设置额外的插件(esbuild-plugin-less
)进行解析less
文件。
附:通过esbuild
构建umijs
临时文件的[demo](https://github.com/asyncguo/build-umi-tempfile)。
聊到插件化架构,我们更多想到的是「构建阶段」的插件机制(不限于webpack
、babel
),而umijs
提供的「运行时阶段」的插件机制就比较少见了。相较于「构建时插件」,「运行时插件」就比较简单,运行时插件更多做的事情偏向于渲染相关。而这观点又该如何更加合理的应用到业务层逻辑,也是值得探索的。
同时通过对esbuild
构建umijs
生成的临时文件的探索,也是可以看到umijs
在插件设计以及各个环节的解耦能力还是很值得学习的。以及对esbuild
工具的使用,也可以看出在前端领域被原生JavaScript
所局限的痛点问题,最终也会被更高效的语言所优化解决,当然这些工具投入生产使用也是值得商榷的,更多的是如何去学习和了解这些优秀的设计思路。
读到这里,相信各位小伙伴对文章最初提的几个问题也有了自己的答案,当然每个人的答案可能是不尽相同。有什么疑问,欢迎各位小伙伴一起交流学习。
本文由哈喽比特于2年以前收录,如有侵权请联系我们。
文章来源:https://mp.weixin.qq.com/s/4cZ3rJz4P5bSRSeXDbFoMQ
京东创始人刘强东和其妻子章泽天最近成为了互联网舆论关注的焦点。有关他们“移民美国”和在美国购买豪宅的传言在互联网上广泛传播。然而,京东官方通过微博发言人发布的消息澄清了这些传言,称这些言论纯属虚假信息和蓄意捏造。
日前,据博主“@超能数码君老周”爆料,国内三大运营商中国移动、中国电信和中国联通预计将集体采购百万台规模的华为Mate60系列手机。
据报道,荷兰半导体设备公司ASML正看到美国对华遏制政策的负面影响。阿斯麦(ASML)CEO彼得·温宁克在一档电视节目中分享了他对中国大陆问题以及该公司面临的出口管制和保护主义的看法。彼得曾在多个场合表达了他对出口管制以及中荷经济关系的担忧。
今年早些时候,抖音悄然上线了一款名为“青桃”的 App,Slogan 为“看见你的热爱”,根据应用介绍可知,“青桃”是一个属于年轻人的兴趣知识视频平台,由抖音官方出品的中长视频关联版本,整体风格有些类似B站。
日前,威马汽车首席数据官梅松林转发了一份“世界各国地区拥车率排行榜”,同时,他发文表示:中国汽车普及率低于非洲国家尼日利亚,每百户家庭仅17户有车。意大利世界排名第一,每十户中九户有车。
近日,一项新的研究发现,维生素 C 和 E 等抗氧化剂会激活一种机制,刺激癌症肿瘤中新血管的生长,帮助它们生长和扩散。
据媒体援引消息人士报道,苹果公司正在测试使用3D打印技术来生产其智能手表的钢质底盘。消息传出后,3D系统一度大涨超10%,不过截至周三收盘,该股涨幅回落至2%以内。
9月2日,坐拥千万粉丝的网红主播“秀才”账号被封禁,在社交媒体平台上引发热议。平台相关负责人表示,“秀才”账号违反平台相关规定,已封禁。据知情人士透露,秀才近期被举报存在违法行为,这可能是他被封禁的部分原因。据悉,“秀才”年龄39岁,是安徽省亳州市蒙城县人,抖音网红,粉丝数量超1200万。他曾被称为“中老年...
9月3日消息,亚马逊的一些股东,包括持有该公司股票的一家养老基金,日前对亚马逊、其创始人贝索斯和其董事会提起诉讼,指控他们在为 Project Kuiper 卫星星座项目购买发射服务时“违反了信义义务”。
据消息,为推广自家应用,苹果现推出了一个名为“Apps by Apple”的网站,展示了苹果为旗下产品(如 iPhone、iPad、Apple Watch、Mac 和 Apple TV)开发的各种应用程序。
特斯拉本周在美国大幅下调Model S和X售价,引发了该公司一些最坚定支持者的不满。知名特斯拉多头、未来基金(Future Fund)管理合伙人加里·布莱克发帖称,降价是一种“短期麻醉剂”,会让潜在客户等待进一步降价。
据外媒9月2日报道,荷兰半导体设备制造商阿斯麦称,尽管荷兰政府颁布的半导体设备出口管制新规9月正式生效,但该公司已获得在2023年底以前向中国运送受限制芯片制造机器的许可。
近日,根据美国证券交易委员会的文件显示,苹果卫星服务提供商 Globalstar 近期向马斯克旗下的 SpaceX 支付 6400 万美元(约 4.65 亿元人民币)。用于在 2023-2025 年期间,发射卫星,进一步扩展苹果 iPhone 系列的 SOS 卫星服务。
据报道,马斯克旗下社交平台𝕏(推特)日前调整了隐私政策,允许 𝕏 使用用户发布的信息来训练其人工智能(AI)模型。新的隐私政策将于 9 月 29 日生效。新政策规定,𝕏可能会使用所收集到的平台信息和公开可用的信息,来帮助训练 𝕏 的机器学习或人工智能模型。
9月2日,荣耀CEO赵明在采访中谈及华为手机回归时表示,替老同事们高兴,觉得手机行业,由于华为的回归,让竞争充满了更多的可能性和更多的魅力,对行业来说也是件好事。
《自然》30日发表的一篇论文报道了一个名为Swift的人工智能(AI)系统,该系统驾驶无人机的能力可在真实世界中一对一冠军赛里战胜人类对手。
近日,非营利组织纽约真菌学会(NYMS)发出警告,表示亚马逊为代表的电商平台上,充斥着各种AI生成的蘑菇觅食科普书籍,其中存在诸多错误。
社交媒体平台𝕏(原推特)新隐私政策提到:“在您同意的情况下,我们可能出于安全、安保和身份识别目的收集和使用您的生物识别信息。”
2023年德国柏林消费电子展上,各大企业都带来了最新的理念和产品,而高端化、本土化的中国产品正在不断吸引欧洲等国际市场的目光。
罗永浩日前在直播中吐槽苹果即将推出的 iPhone 新品,具体内容为:“以我对我‘子公司’的了解,我认为 iPhone 15 跟 iPhone 14 不会有什么区别的,除了序(列)号变了,这个‘不要脸’的东西,这个‘臭厨子’。