Vue3架构分析(一)——从Vue单文件组件到浏览器中的DOM

时至今日,Vue3早已被广泛应用到各类线上业务项目。她能优雅地为我们解决数据流转、UI渲染和用户交互等前端数据和视图层的问题。

虽然,我们对Vue的使用已经非常熟练,并且也能使用她解决日常工作中的各种问题,但是我们可能从未看清她的全貌。

那么,今天我们就尝试站在远处,从宏观的角度来看看她的全貌。

提示: 为了抓住故事主线,我们忽略了很多细节。

一、整体流程

首先,我们先抛开SSR这种的情况,仅从.vue单文件组件,最终渲染成浏览器中的dom节点的整个过程进行一个宏观的分析。

大致流程应该是如下图所示的这样:

flowchart TD
  subgraph compile ["编译阶段(运行环境:node.js)"]
    subgraph vue ["单文件组件源码(.vue)"]
      A{{SomeComponent.vue}} -.- D(script) & C(template) & E(style)
    end
    subgraph compiler ["编译器"]
      direction LR
      subgraph compilerPkg ["单文件组件编译器"]
        B("@vue/compiler-sfc") -.- BA("@vue/compiler-core") & BB("@vue/compiler-dom")
      end
      subgraph compilerDetail ["编译三步曲"]
        direction TB
        B1("parse") --> B2("transform") --> B3("generate")
      end
      compilerPkg -.- compilerDetail
    end
    subgraph component ["组件脚本和样式(Component&style)"]
      F{{SomeComponent.js}} -.-  H("__name: 'SomeComponent'")  & I("props: {}") & J("setup(props): (ctx, cache) => VNode")
    end
    vue ----> compiler ----> component
  end

  subgraph run ["运行阶段(@vue/runtime-dom,@vue/runtime-core,@vue/reactivity)"]
     subgraph startup ["应用启动"]
      direction LR
      subgraph startupUserCode ["用户代码"]
        direction TB
        K("创建应用(createApp)") --> L("挂载到DOM中(mount)")
      end
      subgraph startupFramework ["框架内部"]
        subgraph createFramework ["创建应用"]
          direction TB
          K1("获取/新建渲染器(ensureRenderer)") --> K2("创建应用上下文(createAppContext)")
        end
        subgraph mountFramework ["挂载到DOM"]
          direction TB
          L1("创建根节点(createVNode)") --> L2("将根节点渲染到容器中(render)")
        end
        createFramework --> mountFramework
      end
      startupUserCode -.- startupFramework
    end
  end
  compile ----> run

根据上图,我们基于vue单文件组件的工作流程大致描述分为如下两大步:

  1. 编译: 编译阶段是在nodejs环境中执行的,vue单文件组件代码被输入到编译器中,经过三个步骤:①语法分析(parse)得到抽象语法书AST;②修改抽象语法树(transform);③重新生成代码(generate),最终输出两部分内容——脚本和样式,大体流程如下图:
flowchart LR
  oFile{{".vue文件"}} --> Parser["语法解析器(Parser)"]
  subgraph ast ["抽象语法树"]
    n0(((" "))) -.- n1(((" "))) & n2(((" ")))
    n1 -.- n11(((" "))) & n12(((" ")))
    n2 -.- n21(((" "))) & n22(((" ")))
  end
  Parser --> ast --> Transform["转换器(Transforms)"]
  subgraph ast2 ["新抽象语法树"]
    n200(((" "))) -.- n201(((" "))) & n202(((" ")))
    n201 -.- n211(((" "))) & n212(((" ")))
    n202 -.- n221(((" "))) & n222(((" ")))
  end
  Transform --> ast2 --> Generate["代码生成器"] --> dFile{{"JS 和 CSS"}}
  oFile -.-> dFile
  1. 运行: 运行阶段发生在浏览器上,我们通过执行createApp(SomeComponent).mount('#app')来将我们的组件渲染到id为app的DOM节点中。

二、源码分析

下面我们从用户侧代码入手,精简掉部分代码,试着捋出应用启动的主流程相关代码:

(一)用户侧代码

import { createApp } from 'vue'
import './style.css'
import SomeComponent from './SomeComponent.vue'

createApp(SomeComponent).mount('#app');

我们通过createApp(SomeComponent).mount('#app');这行代码创建应用,并将根节点生成的dom对象挂载(插入)到idapp的节点上(中)。

接下来,我们继续深入框架,看看上面的代码实际做了什么!

(二) 创建应用的入口函数

export const createApp = ((...args) => {
  // 通过ensureRenderer函数获得渲染器
  const app = ensureRenderer().createApp(...args)

  const { mount } = app
  app.mount = (containerOrSelector: Element | ShadowRoot | string): any => {
    ...
  }

  return app
}) as CreateAppFunction<Element>

createApp()函数会创建会通过渲染器创建一个应用(查看源码),而ensureRenderer()会获得渲染器,创建应用之后,还重写了app.mount函数,这里我们先跳过。

接下来,我们继续看渲染器是怎么获取的!

(三) 获取渲染器

ensureRenderer()函数首先判断闭包内是否存在renderer,如果存在则直接返回,不存在则新建renderer。这个renderer实例就是渲染器。查看源码

let renderer: Renderer<Element | ShadowRoot> | HydrationRenderer

function ensureRenderer() {
  return (
    renderer ||
    (renderer = createRenderer<Node, Element | ShadowRoot>(rendererOptions))
  )
}

如果点击源码链接,在下方还会看到createSSRApp函数,它会调用ensureHydrationRenderer返回一个渲染器。

这里,vue对渲染器进行了抽象,渲染器被抽象成了接口(查看源码),下面摘抄了相关源码:

export interface Renderer<HostElement = RendererElement> {
  render: RootRenderFunction<HostElement>
  createApp: CreateAppFunction<HostElement>
}

export interface HydrationRenderer extends Renderer<Element | ShadowRoot> {
  hydrate: RootHydrateFunction
}

那么,这么做有什么好处呢? 这样做,可以将渲染器与具体实现进行分离,渲染器只需要包含rendercreateApp两个方法,而对于HydrationRenderer接口,也就需要多实现一个hydrate方法。

对于 “可以将渲染器与具体实现进行分离” 我想再细致地说一下:

  1. Renderer接口很抽象地描述了一个渲染器,需要提供createApp方法和render来创建一个应用和执行渲染。
  2. 至于具体如何创建应用和渲染,并没有做细节规定,只要根据接口声明的方法签名进行实现即可。
  3. 这样一来,我们在dom运行环境的渲染器和SSR环境的渲染器就可以分别各自按照自己的需要实现即可,渲染器的设计和实现就完全解耦了。

拓展一下: 假设我们要基于vue3实现类似ReactNative那样的将vue3的组件渲染成NativeUI应该怎么做呢?没错,为它实现一个新的渲染器即可,实现之后前端应用入口代码大概会改成这样:

import { createNativeApp } from 'vue'
import './style.css'
import SomeComponent from './SomeComponent.vue'

createNativeApp(SomeComponent).mount('appContainer');

扯远了,我们继续回来看渲染器究竟是怎么被创建出来的呢?

(四) 创建渲染器

渲染器最终是通过baseCreateRenderer函数来实现的(查看源码),这个函数特别长,函数体就有600多行,那么这个函数究竟做了什么呢?

为了方便分析,我们将无关代码都先省略掉:

function baseCreateRenderer(
  options: RendererOptions,
  createHydrationFns?: typeof createHydrationFunctions,
): any {
  ... // 这里省略了几百行代码
  return {
    render,
    hydrate,
    createApp: createAppAPI(render, hydrate),
  }
}

虽然baseCreateRenderer函数很长,但是我们可以看到,最后只是返回了一个符合渲染器接口的对象,而这个对象就是最终的渲染器实例。

除了返回值,我们再看它的第一个入参options,其类型是RendererOptions,下面是其类型信息:

export interface RendererOptions<
  HostNode = RendererNode,
  HostElement = RendererElement,
> {
  patchProp(
    el: HostElement,
    key: string,
    prevValue: any,
    nextValue: any,
    namespace?: ElementNamespace,
    prevChildren?: VNode<HostNode, HostElement>[],
    parentComponent?: ComponentInternalInstance | null,
    parentSuspense?: SuspenseBoundary | null,
    unmountChildren?: UnmountChildrenFn,
  ): void
  insert(el: HostNode, parent: HostElement, anchor?: HostNode | null): void
  remove(el: HostNode): void
  createElement(
    type: string,
    namespace?: ElementNamespace,
    isCustomizedBuiltIn?: string,
    vnodeProps?: (VNodeProps & { [key: string]: any }) | null,
  ): HostElement
  createText(text: string): HostNode
  createComment(text: string): HostNode
  setText(node: HostNode, text: string): void
  setElementText(node: HostElement, text: string): void
  parentNode(node: HostNode): HostElement | null
  nextSibling(node: HostNode): HostNode | null
  querySelector?(selector: string): HostElement | null
  setScopeId?(el: HostElement, id: string): void
  cloneNode?(node: HostNode): HostNode
  insertStaticContent?(
    content: string,
    parent: HostElement,
    anchor: HostNode | null,
    namespace: ElementNamespace,
    start?: HostNode | null,
    end?: HostNode | null,
  ): [HostNode, HostNode]
}

初看起来可能有点不理解,但是仔细看接口中的这些方法签名就能明白这些函数描述的都是如何处理一个具体的节点,这些节点其实是抽象的本地节点,并未规定一定是dom节点。
比如,insert方法,描述的是如何插入一个元素,那么在实现不同平台的渲染器的时候,我们就可以根据不同的平台特性进行实现了。

这样的设计同样是为了让渲染器的设计与实现解耦。

(五) 创建App

之前我们看到ensureRenderer().createApp(...args)代码,而这里的createApp函数正是我们上面看到的通过createAppAPI(render, hydrate)函数创建出来的。查看源码

为了便于理解,精简后的代码如下:

export function createAppAPI<HostElement>(
  render: RootRenderFunction<HostElement>,
  hydrate?: RootHydrateFunction,
): CreateAppFunction<HostElement> {
  return function createApp(rootComponent, rootProps = null) {
    ...
    const context = createAppContext()
    const installedPlugins = new WeakSet()

    let isMounted = false

    const app: App = (context.app = {
      _uid: uid++,
      _component: rootComponent as ConcreteComponent,
      _props: rootProps,
      _container: null,
      _context: context,
      _instance: null,

      version,

      use(plugin: Plugin, ...options: any[]) {
        ...
        return app
      },

      mixin(mixin: ComponentOptions) {
        ...
        return app
      },

      component(name: string, component?: Component): any {
        ...
        return app
      },

      directive(name: string, directive?: Directive) {
        ...
        return app
      },

      mount(
        rootContainer: HostElement,
        isHydrate?: boolean,
        namespace?: boolean | ElementNamespace,
      ): any {
        ...
      },

      unmount() {
        ...
      },

      provide(key, value) {
        ...
        return app
      },

      runWithContext(fn) {
        ...
      },
    })

    return app
  }
}

从代码中可以看到,创建应用的时候经过如下两个步骤:

  1. 首先,通过const context = createAppContext()先创建了一个应用上下文
  2. 然后,再通过const app: App = (context.app = {...,_context: context,...});将应用上下文和我们新建的app对象关联起来

同时,我们还看到上面的很多方法都是比较常用的,比如:mountcomponentdirective等。

下面我们来分析一下createAppContext函数(查看源码)做了什么!

其实很简单,就是创建了一个空的App上下文,这个上下文的主要作用是维护App的运行时状态,包括运行时的配置、混入的信息,可用的组件、指令等等,源码如下:

export function createAppContext(): AppContext {
  return {
    app: null as any,
    config: {
      isNativeTag: NO,
      performance: false,
      globalProperties: {},
      optionMergeStrategies: {},
      errorHandler: undefined,
      warnHandler: undefined,
      compilerOptions: {},
    },
    mixins: [],
    components: {},
    directives: {},
    provides: Object.create(null),
    optionsCache: new WeakMap(),
    propsCache: new WeakMap(),
    emitsCache: new WeakMap(),
  }
}

(六) 挂载

我们省略掉很多代码之后,挂载方法如下:

mount(
  rootContainer: HostElement,
  isHydrate?: boolean,
  namespace?: boolean | ElementNamespace,
): any {
  if (!isMounted) {
    const vnode = createVNode(rootComponent, rootProps)
    // store app context on the root VNode.
    // this will be set on the root instance on initial mount.
    vnode.appContext = context

    if (namespace === true) {
      namespace = 'svg'
    } else if (namespace === false) {
      namespace = undefined
    }

    if (isHydrate && hydrate) {
      hydrate(vnode as VNode<Node, Element>, rootContainer as any)
    } else {
      render(vnode, rootContainer, namespace)
    }
    isMounted = true
    app._container = rootContainer
    // for devtools and telemetry
    ;(rootContainer as any).__vue_app__ = app

    return getExposeProxy(vnode.component!) || vnode.component!.proxy
  }
},

我们可以看出,mount函数主要做了以下几件事:

  1. 根据应用根组件创建应用的VNode根节点
  2. 给根节点加上应用上下文
  3. 将根节点渲染到rootContainer容器中,这个rootContainer容器也就是我们应用的挂载点

首先,值得注意的是,在将节点渲染到容器的时候有一个判断条件,isHydrate && hydrate,这个是当我们的页面是通过SSR初始化的时候,这时候,应用已经在服务端渲染过了,因此我们需要将虚拟节点与DOM节点水合,这个水合的过程以及渲染的核心逻辑我们就留着后续再分析吧。

另外,值得注意的是,我们的在第二步处忽略的代码app.mount = (containerOrSelector: Element | ShadowRoot | string): any => {...},这里重写了createAppAPI函数返回的app实例上的mount方法。

下面我们来看看之前被我们省略掉的代码:

 app.mount = (containerOrSelector: Element | ShadowRoot | string): any => {
    const container = normalizeContainer(containerOrSelector)
    if (!container) return

    const component = app._component
    if (!isFunction(component) && !component.render && !component.template) {
      component.template = container.innerHTML
    }

    // clear content before mounting
    container.innerHTML = ''
    const proxy = mount(container, false, resolveRootNamespace(container))
    if (container instanceof Element) {
      container.removeAttribute('v-cloak')
      container.setAttribute('data-v-app', '')
    }
    return proxy
  }

可以看到,这里主要是在挂载之前对目标容器做了处理,最后还是调用了createAppAPI函数生成的mount函数将根节点渲染到目标容器中。

三、总结

vue单文件组件经过vue编译器编译成js和css文件,并通过vue运行时提供的渲染器创建应用,执行渲染并挂载到dom容器中。

原文链接:https://juejin.cn/post/7344259970522136616 作者:原心

(0)
上一篇 2024年3月10日 下午4:42
下一篇 2024年3月10日 下午4:52

相关推荐

发表评论

登录后才能评论