5 月底我们正式对外开源了业内首个 React Native 转微信小程序引擎Alita项目。
这个项目的发起是因为团队内部有大量使用 React Native 开发的业务模块,而大部分业务都有移植到 H5 和微信小程序的需求。所以我们开始思考如何通过技术的方式来实现把React Native
代码转换微信小程序的。经过内部孵化和大量业务落地验证,最终我们对社区贡献了 Alita 引擎。她的定位非常明确,我们不造新框架,必须低侵入性并且只做好一件事情,就是把你的React Native
代码转换并运行在微信小程序端(未来可能覆盖更多端)。
开源社区其实也一直在致力于打通 React 和微信小程序,涌现出了很多优秀的框架(同是京东凹凸实验室出品的Taro就是非常出色的框架),但是我们发现大部分还是基于
React,并且提供了新的框架和新语法规则,而对
React Native的处理比较少。更重要的是大部分框架对
React语法采用的是编译时处理方案,对JSX语法限制比较大(后面文章会详细分析)。我们对
Alita的期望是不能对
JSX语法有太多限制,不能有侵入性,不给
React Native的开发者带来太多的负担。所以最终
Alita`引擎没有基于任何现有的编译时方案,而是另辟溪路,走了一条颇具开创性的运行期处理方案。
抛开技术细节,使用 Alita 转换工具有 2 点约定必须了解:
如果你打算转换复杂的
RN
应用,需要特别注意,微信小程序包有大小限制,不能超过 4M。Alita
不能直接把原生组件/第三方组件转换成小程序代码。不过,Alita
提供了扩展这些组件的方式,这点很像在 RN 上提供原生平台组件。另外,我们近期会推出alita-ui
,这个UI
库包含了社区常用的RN
组件,可以直接被Alita
转换引擎支持。
Talk is cheap. Show me the code
直接上干货!接下来我们从纯技术的角度剖析一下Alita
引擎的核心部分:如何实现运行期处理 JSX
现有社区方案 — 编译时
我们说社区现有方案无法满足我们的需求,尤其是在JSX
语法的支持上,那么现有社区方案是怎么做的?他们主要是通过在编译阶段把React
代码转换为等效的微信小程序代码,来把React
代码运行在微信小程序端。
举个例子,比如React
逻辑表达式:
将会被转换为等效的小程序wx:if
指令:
那么这种编译阶段处理的方式有什么问题呢,通过下面的React
代码看下。
这里声明了变量a
:const a = <Text>Hello</Text>
,变量b
:const b = a
。 我们看下编译方案(这里以Taro1.3
为例)对上面代码的转换过程。
这个例子不是特别复杂,却报错了。
要想理解上面的代码为什么报错,我们首先要理解编译阶段。本质上来说在编译阶段,代码其实就是‘字符串’,而编译阶段处理方案,就需要从这个‘字符串’中分析出必要的信息(通过AST
,正则等方式)然后做对应的等效转换处理。
而对于上面的例子,需要做什么等效处理呢?需要我们在编译阶段分析出b
是JSX
片段:b = a = <Text>Hello</Text>
,然后把<View>{b}</View>
中的{b}
等效替换为<Text>Hello</Text>
。然而在编译阶段要想确定b
的值是很困难的,有人说可以往前追溯来确定 b 的值,也不是不可以,但是考虑一下 由于b = a
,那么就先要确定a
的值,这个a
的值怎么确定呢?需要在b
可以访问到的作用域链中确定a
,然而a
可能又是由其他变量赋值而来,循环往复,期间一旦出现不是简单赋值的情况,比如函数调用,三元判断等运行时信息,追溯就宣告失败,要是a
本身就是挂在全局对象上的变量,追溯就更加无从谈起。
所以在编译阶段 是无法简单确定b
的值的。
我们再仔细看下上图的报错信息:a is not defined
。
为什么说a
未定义呢?这是涉及到另外一个问题,我们知道<Text>Hello</Text>
,其实等效于React.createElement(Text, null, 'Hello')
,而React.createElement
方法的返回值就是一个普通JS
对象,形如
但是,我们刚说了编译阶段需要对JSX
做等效处理,需要把JSX
转换为wxml
,所以<Text>Hello</Text>
这个JSX
片段被特殊处理了,a
不再是一个普通js
对象,这里我们看到a
变量甚至丢失了,这里暴露了一个很严重的问题:代码语义被破坏了,也就是说由于编译时方案对JSX
的特殊处理,真正运行在小程序上的代码语义并不是你的预期。这个是比较头疼。
另外不得不提编译时方案的 React 语法限制往往是和常识相违背的,因为大家是‘运行时’的思维方式,这就导致即使我们转换失败报错了,也很难定位到具体原因,你很难理解b = a
为啥报错。
Alita 处理方案 — 运行时
我们说Alita
处理 React 语法采用的是运行时方案。那接下来,我们就一步步揭秘运行时方案,沿着下面原理图。我们从两个方面说明:Alita 编译阶段,Alita 运行时。
编译阶段
概括的来说,静态编译阶段主要做两个事情:
转译
React
代码,使之可以被小程序识别,具体的比如用React.createElement
替换JSX
,比如async/await
语法处理等等。枚举并标识独立
JSX
片段,生成小程序wxml
文件。
为了直观的表明Alita
与社区其他编译时方案的不同,假定有一下JSX
片段,我们看下Alita
静态编译做的事情。
经过 Alita 编译阶段之后:
每一个独立 JSX 片段,都会被uuid
唯一标识。同时生成 wxml 文件
用小程序template
包裹独立 JSX 片段,其name
属性就是上文的uuid
。最后,需要在结尾生成一个占位模版:
[template is]
的动态性配合uuid
标识将是运行时处理 JSX 的关键,下文会继续提及。
编译阶段到这里就结束了。
Alita 运行时
关于Alita
运行时,核心是内嵌的mini-react
,这是一个适用微信小程序并且五脏俱全的React
。让我们先简单回顾一下React
的渲染过程:
递归(React16.x
引入Fiber
之后,不再使用递归的方式了)的构建组件树结构,创建组件实例,执行组件对应生命周期,context
计算,ref
等等。当state
有更新时,再次调用相应生命周期,判断节点是否复用(virtual-dom
)等。此外,在执行过程中会调用浏览器DOM API
(appendChild
, removeChild
, insertBefore
等等方法)不断操作原生节点,最终生成 UI 视图。
Alita mini-react
的执行过程基本和这一致,也会递归构建组件树,调用生命周期等等,区别在于Alita
无法调用DOM API
,熟悉微信小程序开发的同学都知道,微信小程序屏蔽了DOM API
。那么没有了DOM API
,只剩小程序的wxml
静态模版,怎么实现动态化处理React
语法呢?
还记得编译阶段生成的uuid
吗?每一个uuid
代表了一个独立的JSX
片段,在ReactDOM.render
递归执行阶段,Alita 会收集聚合JSX
片段的uuid
属性,生成并返回uiDes
数据结构,这个uiDes
数据包含了所有要渲染的片段信息,这份数据会传递给小程序,然后小程序把uiDes
设置给占位模版(如下所示),递归渲染出最终的视图。
下面我们看一段相对复杂的React
代码,我们将以这段代码,完整的说明Alita
的运行过程:
首先用uuid
标识独立JSX
片段,并用babel
转义以上代码,如下:
同时提取独立JSX
片段生成wxml
文件:
以上过程都是在编译阶段就处理完毕的,现在让我们考虑一下ReactDOM.render(<App/>, parent)
执行过程(这里使用ReactDOM.render
只是方便理解):
ReactDOM.render
判断出App
是自定义组件,创建其实例,执行componentWillMount
等生命周期。递归处理render
方法返回的ReactElement
对象,即:React.createElement(View, {uuid: "000003"}, this.getHeader(), b);
。处理最外层
View
,收集uuid
,生成UI
描述:uiDes = {name: "000003"}
遍历
children
处理第一个孩子节点:
this.getHeader()
,它的值是React.createElement(Text,{name: "000001"}, "Header")
,递归处理这个值,由于Text
是基本元素,递归终止,第一个孩子处理结束。此时uiDes
的值如下:
处理第二个孩子节点,
b
。当this.props.xx
为true
的时候b
就是null
,直接忽略。 这里并没有传递xx
属性,所以b = a = React.createElement(Text, {name: "000002"}, "Hello World")
。Text
是基本元素,递归终止,第二个孩子处理结束,此时uiDes
的值如下:
children
遍历结束。微信小程序获取到
uiDes
,设置到下面的占位模版,渲染对应视图,首先是外层000003
模版,然后是其两个孩子节点,分别是000001
模版,000002
模版,最终渲染出完整视图。
在这整个过程中,你的所有JS
代码都是运行在React过程
中的,语义完全一致,JSX
片段也不会被任何特殊处理,只是简单的React.createElement
调用。最终会输出一个uiDes
数据到小程序,小程序通过这个uiDes
渲染出视图。另外由于这里的React过程
只是纯js
运算,不涉及DOM
操作,执行是非常迅速的,通常只有几 ms,也就是说mini-react
的开销是很小的。
以上可见Alita
对JSX
片段的处理是动态的,你可以在任何地方,任何函数出现任何JSX
片段, 最终代码执行结果会确定渲染哪一个片段,只有执行结果的片段的uuid
会被写入uiDes
。这和编译时方案的静态识别有着本质的区别。
另外由于上层运行还是React
,所以Alita
在支持redux
等库上有天然的优势。
总结
我们需要一种更加React
的方式处理小程序。Alita
在这个方向上更进了一些,Alita
的源码是完全公开的,我们也会不断提供剖析Alita
原理的文章,希望给社区带来一个新的思路,也给开发者提供一个新的选择,另外让更多的的开发者理解Alita
的原理,也是希望更多的人能够参与进来, "The world needs more heroes!!”。
Alita
可以转换React
应用吗?基于我们内部需求,我们只处理了React Native
代码。但是React
语法处理是相通的,把Alita
扩展到转换React
应用并不是很困难,不过暂时我们还没有扩展的排期,我们下一步的计划是优化/重构内部在使用的 RN 转 H5 工具,最终的形态应该是基于 RN 开发生态,通过Alita
转换引擎支持实现全端的覆盖。
额外提一句,Flutter
也是可以运行在Web
端的,而微信小程序的运行环境就是web
,那么基于Alita
运行时方案,是不是可以幻想一下Flutter
与微信小程序的融合呢。
Github: https://github.com/areslabs/alita
评论