@loadable/components是如何实现懒加载的

先看下官方文档是如何使用@loadable/component

import loadable from '@loadable/component'
const OtherComponent = loadable(() => import('./OtherComponent'))
function MyComponent() {
  return (
    <div>
      <OtherComponent />
    </div>
  )
}

loadable(() => import('./OtherComponent')) 的返回值是一个React组件。那究竟是如何做到懒加载的?

本文不会讲解import('./OtherComponent')如何分包,如果想了解请自行查阅资料。

createLoadable

源码中loadablecreateLoadable生成。createLoadble接受defaultResolveComponentrender两个参数,执行后返回loadable

import React from 'react'
import createLoadable from './createLoadable'
import { defaultResolveComponent } from './resolvers'

export const { loadable, lazy } = createLoadable({
  defaultResolveComponent,
  render({ result: Component, props }) {
    return <Component {...props} />
  },
})

至于defaultResolveComponent这里先不用管,下文使用到会介绍。

接下来就是最核心的createLoadable ,它的代码框架如下:

image.png

createLoadable内部定义并返回了loadablelazy两个函数。其中我们的关注重点是官方文档提到的loadable

loadable

loadable有2个参数:

  1. 构造函数,
  2. options选项。

首先,loadable会先执行resolveConstructor,对构造函数包装:

const ctor = resolveConstructor(loadableConstructor); 

包装后,ctor的值如下:

const ctor = {
    requireAsync: () => import('./OtherComponent'),
    resolve() {
        return undefined
    },
    chunkName() {
        return undefined
    }
}

编译后的ctor值:


loadable:component.png

InnerLoadable

loadable内部还定义了一个类组件InnerLoadable

  class InnerLoadable extends React.Component {
      constructor(props) {
        super(props)

        this.state = {
          result: null,
          error: null,
          loading: true,
          cacheKey: getCacheKey(props),
        }
      }  
      // ........  
   }

    const EnhancedInnerLoadable = withChunkExtractor(InnerLoadable)
    const Loadable = React.forwardRef((props, ref) => (
      <EnhancedInnerLoadable forwardedRef={ref} {...props} />
    ))
    
    Loadable.displayName = 'Loadable';
    return Loadable;

其中withChunkExtractor是一个高阶组件,InnerLoadable经过HOC withChunkExtractor包装后再由React.forwardRef包装一次。
因此,Loadable实质上也是一个高阶组件,至于具体是如何加载bundle的请继续往下阅读。

组件加载阶段请求bundle

在生命周期componentDidMount执行loadAsync

    componentDidMount() {
       this.mounted = true
    
       // .....
       
       // component might be resolved synchronously in the constructor
       if (this.state.loading) {
            this.loadAsync()
        }
      }
 

loadAsync中去加载bundle(实际上源码内部调用了多个方法,为了阅读方便,我把方法拆开简化后都写到loadAsync中),加载成功后bundle存到result,同时loading变为false。

  loadAsync() {
      const { __chunkExtractor, forwardedRef, ...props } = this.props;
        
        /**
        *  这一步会请求需要懒加载的包, 对应代码import('./OtherComponent')
        */
       let promise = ctor.requireAsync(props);  
        
        promise
          .then(loadedModule => {
            const result = resolve(loadedModule, this.props);
            if(this.mounted) {
               this.setState({
                 result,
                 loading: false,
               })
            }            
          })
          .catch(error => this.safeSetState({ error, loading: false }))

        return promise
   }

resolve中判断使用者是否传入resolveComponent,如果有就用resolveComponent去处理module和props,如果没有则使用defaultResolveComponent返回module。

   function resolve(module, props) {
      const Component = options.resolveComponent
        ? options.resolveComponent(module, props)
        : defaultResolveComponent(module)

      return Component
   }

defaultResolveComponent也是一个函数,传入一个module作为参数,如果是esModule则返回module.default ,否则返回 module.default || module:

export function defaultResolveComponent(loadedModule) {
  return loadedModule.__esModule
    ? loadedModule.default
    : loadedModule.default || loadedModule
}

componentDidMount加载bundle后,loading变为false,在render中执行createLoadable的参数render后返回:

    render() {
        const {
          forwardedRef,
          fallback: propFallback,
          __chunkExtractor,
          ...props
        } = this.props
        const { loading, result } = this.state
    
        const fallback = propFallback || options.fallback || null

        if (loading) {
          return fallback
        }

        return render({
          fallback,
          result,
          options,
          props: { ...props, ref: forwardedRef },
        })
      }

代码中执行的render如下:


render.png

总结

loadable是一个高阶组件,在componentDidMount加载 bundle (() => import('./xxx')被打包后的bundle),如果没有加载或者加载未完成则在render中渲染fallback,加载完成则渲染组件。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,951评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,606评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,601评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,478评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,565评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,587评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,590评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,337评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,785评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,096评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,273评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,935评论 5 339
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,578评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,199评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,440评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,163评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,133评论 2 352

推荐阅读更多精彩内容