Vue3設計思想及響應式原始碼剖析

京東雲開發者發表於2023-11-23

Vue原始碼

一、Vue3結構分析

1、Vue2與Vue3的對比

對TypeScript支援不友好（所有屬性都放在了this物件上，難以推倒元件的資料型別）
大量的API掛載在Vue物件的原型上，難以實現TreeShaking。
架構層面對跨平臺dom渲染開發支援不友好,vue3允許自定義渲染器，擴充套件能力強。
CompositionAPI。受ReactHook啟發
對虛擬DOM進行了重寫、對模板的編譯進行了最佳化操作...

2、Vue3設計思想

Vue3.0更注重模組上的拆分，在2.0中無法單獨使用部分模組。需要引入完整的Vuejs(例如只想使用使用響應式部分，但是需要引入完整的Vuejs)， Vue3中的模組之間耦合度低，模組可以獨立使用。拆分模組
Vue2中很多方法掛載到了例項中導致沒有使用也會被打包（還有很多元件也是一樣）。透過構建工具Tree-shaking機制實現按需引入，減少使用者打包後體積。重寫API
Vue3允許自定義渲染器，擴充套件能力強。不會發生以前的事情，改寫Vue原始碼改造渲染方式。擴充套件更方便

依然保留了Vue2的特點：

依舊是宣告式框架，底層渲染邏輯不關心（命令式比較關注過程，可以控制怎麼寫最優？編寫過程不同），如for和reduce

採用虛擬DOM

區分編譯時和執行時

內部區分了編譯時（模板？程式設計成js程式碼，一般在構建工具中使用）和執行時

簡單來說，Vue3 框架更小，擴充套件更加方便

3、monorepo管理專案

Monorepo 是管理專案程式碼的一個方式，指在一個專案倉庫(repo)中管理多個模組/包(package)。也就是說是一種將多個package放在一個repo中的程式碼管理模式。Vue3內部實現了一個模組的拆分， Vue3原始碼採用 Monorepo 方式進行管理，將模組拆分到package目錄中。

一個倉庫可維護多個模組，不用到處找倉庫
方便版本管理和依賴管理，模組之間的引用，呼叫都非常方便
每個包可以獨立釋出

早期使用yarn workspace + lerna來管理專案，後面是pnpm

pnpm介紹

快速，節省磁碟空間的包管理器，主要採用符號連結的方式管理模組

快速
高效利用磁碟空間

pnpm 內部使用基於內容定址的檔案系統來儲存磁碟上所有的檔案，這個檔案系統出色的地方在於:

不會重複安裝同一個包。用 npm/yarn 的時候，如果 100 個專案都依賴 lodash，那麼 lodash 很可能就被安裝了 100 次，磁碟中就有 100 個地方寫入了這部分程式碼。但在使用 pnpm 只會安裝一次，磁碟中只有一個地方寫入，後面再次使用都會直接使用hardlink(硬連結)
即使一個包的不同版本，pnpm 也會極大程度地複用之前版本的程式碼。比如 lodash 有 100 個檔案，更新版本之後多了一個檔案，那麼磁碟當中並不會重新寫入 101 個檔案，而是保留原來的 100 個檔案的hardlink，僅僅寫入那一個新增的檔案。

支援Monorepo

pnpm 與 npm/yarn 一個很大的不同就是支援了 monorepo

安全性高

之前在使用 npm/yarn 的時候，由於 node_module 的扁平結構，如果 A 依賴 B， B 依賴 C，那麼 A 當中是可以直接使用 C 的，但問題是 A 當中並沒有宣告 C 這個依賴。因此會出現這種非法訪問的情況。但 pnpm自創了一套依賴管理方式，很好地解決了這個問題，保證了安全性

預設情況下，pnpm 則是透過使用符號連結的方式僅將專案的直接依賴項新增到node_modules的根目錄下。

安裝和初始化

全域性安裝（node版本>16）

npm install pnpm -g

初始化

pnpm init

配置workspace

根目錄建立pnpm-workspace.yaml

packages:
  - 'packages/*'

將packages下所有的目錄都作為包進行管理。這樣我們的Monorepo就搭建好了。確實比 lerna + yarn workspace 更快捷

4、專案結構

packages

reactivity:響應式系統
runtime-core:與平臺無關的執行時核心 (可以建立針對特定平臺的執行時 - 自定義渲染器)
runtime-dom: 針對瀏覽器的執行時。包括DOM API，屬性，事件處理等
runtime-test:用於測試
server-renderer:用於伺服器端渲染
compiler-core:與平臺無關的編譯器核心
compiler-dom: 針對瀏覽器的編譯模組
compiler-ssr: 針對服務端渲染的編譯模組
template-explorer：用於除錯編譯器輸出的開發工具
shared：多個包之間共享的內容
vue:完整版本,包括執行時和編譯器

                                    +---------------------+
                                    |                     |
                                    |  @vue/compiler-sfc  |
                                    |                     |
                                    +-----+--------+------+
                                          |        |
                                          v        v
                      +---------------------+    +----------------------+
                      |                     |    |                      |
        +------------>|  @vue/compiler-dom  +--->|  @vue/compiler-core  |
        |             |                     |    |                      |
   +----+----+        +---------------------+    +----------------------+
   |         |
   |   vue   |
   |         |
   +----+----+        +---------------------+    +----------------------+    +-------------------+
        |             |                     |    |                      |    |                   |
        +------------>|  @vue/runtime-dom   +--->|  @vue/runtime-core   +--->|  @vue/reactivity  |
                      |                     |    |                      |    |                   |
                      +---------------------+    +----------------------+    +-------------------+

scripts

Vue3在開發環境使用esbuild打包，生產環境採用rollup打包

包的相互依賴

安裝

把packages/shared安裝到packages/reactivity

pnpm install @vue/shared@workspace --filter @vue/reactivity

使用

在reactivity/src/computed.ts中引入shared中相關方法

import { isFunction, NOOP } from '@vue/shared' // ts引入會報錯

const onlyGetter = isFunction(getterOrOptions)
  if (onlyGetter) {
    ...
  } else {
    ...
  }
...

tips：@vue/shared引入會報錯，需要在tsconfig.json中配置

{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@vue/compat": ["packages/vue-compat/src"],
      "@vue/*": ["packages/*/src"],
      "vue": ["packages/vue/src"]
    }
  },
}

5、打包

所有包的入口均為src/index.ts這樣可以實現統一打包.

• reactivity/package.json

{
  "name": "@vue/reactivity",
  "version": "3.2.45",
  "main": "index.js",
  "module":"dist/reactivity.esm-bundler.js",
  "unpkg": "dist/reactivity.global.js",
  "buildOptions": {
    "name": "VueReactivity",
    "formats": [
      "esm-bundler",
      "cjs",
      "global"
    ]
  }
}

• shared/package.json

{
    "name": "@vue/shared",
    "version": "3.2.45",
    "main": "index.js",
    "module": "dist/shared.esm-bundler.js",
    "buildOptions": {
        "formats": [
            "esm-bundler",
            "cjs"
        ]
    }
}

formats 為自定義的打包格式，有 esm-bundler 在構建工具中使用的格式、 esm-browser 在瀏覽器中使用的格式、 cjs 在node中使用的格式、 global 立即執行函式的格式

開發環境esbuild打包

開發時執行指令碼，引數為要打包的模組

"scripts": {
    "dev": "node scripts/dev.js reactivity -f global"
}

// Using esbuild for faster dev builds.
// We are still using Rollup for production builds because it generates
// smaller files w/ better tree-shaking.

// @ts-check
const { build } = require('esbuild')
const nodePolyfills = require('@esbuild-plugins/node-modules-polyfill')
const { resolve, relative } = require('path')
const args = require('minimist')(process.argv.slice(2))

const target = args._[0] || 'vue'
const format = args.f || 'global'
const inlineDeps = args.i || args.inline
const pkg = require(resolve(__dirname, `../packages/${target}/package.json`))

// resolve output
const outputFormat = format.startsWith('global')
  ? 'iife'
  : format === 'cjs'
  ? 'cjs'
  : 'esm'

const postfix = format.endsWith('-runtime')
  ? `runtime.${format.replace(/-runtime$/, '')}`
  : format

const outfile = resolve(
  __dirname,
  `../packages/${target}/dist/${
    target === 'vue-compat' ? `vue` : target
  }.${postfix}.js`
)
const relativeOutfile = relative(process.cwd(), outfile)

// resolve externals
// TODO this logic is largely duplicated from rollup.config.js
let external = []
if (!inlineDeps) {
  // cjs & esm-bundler: external all deps
  if (format === 'cjs' || format.includes('esm-bundler')) {
    external = [
      ...external,
      ...Object.keys(pkg.dependencies || {}),
      ...Object.keys(pkg.peerDependencies || {}),
      // for @vue/compiler-sfc / server-renderer
      'path',
      'url',
      'stream'
    ]
  }

  if (target === 'compiler-sfc') {
    const consolidateDeps = require.resolve('@vue/consolidate/package.json', {
      paths: [resolve(__dirname, `../packages/${target}/`)]
    })
    external = [
      ...external,
      ...Object.keys(require(consolidateDeps).devDependencies),
      'fs',
      'vm',
      'crypto',
      'react-dom/server',
      'teacup/lib/express',
      'arc-templates/dist/es5',
      'then-pug',
      'then-jade'
    ]
  }
}

build({
  entryPoints: [resolve(__dirname, `../packages/${target}/src/index.ts`)],
  outfile,
  bundle: true,
  external,
  sourcemap: true,
  format: outputFormat,
  globalName: pkg.buildOptions?.name,
  platform: format === 'cjs' ? 'node' : 'browser',
  plugins:
    format === 'cjs' || pkg.buildOptions?.enableNonBrowserBranches
      ? [nodePolyfills.default()]
      : undefined,
  define: {
    __COMMIT__: `"dev"`,
    __VERSION__: `"${pkg.version}"`,
    __DEV__: `true`,
    __TEST__: `false`,
    __BROWSER__: String(
      format !== 'cjs' && !pkg.buildOptions?.enableNonBrowserBranches
    ),
    __GLOBAL__: String(format === 'global'),
    __ESM_BUNDLER__: String(format.includes('esm-bundler')),
    __ESM_BROWSER__: String(format.includes('esm-browser')),
    __NODE_JS__: String(format === 'cjs'),
    __SSR__: String(format === 'cjs' || format.includes('esm-bundler')),
    __COMPAT__: String(target === 'vue-compat'),
    __FEATURE_SUSPENSE__: `true`,
    __FEATURE_OPTIONS_API__: `true`,
    __FEATURE_PROD_DEVTOOLS__: `false`
  },
  watch: {
    onRebuild(error) {
      if (!error) console.log(`rebuilt: ${relativeOutfile}`)
    }
  }
}).then(() => {
  console.log(`watching: ${relativeOutfile}`)
})

生產環境rollup打包

具體程式碼參考rollup.config.mjs

build.js

二、Vue3中Reactivity模組

1、vue3對比vue2的響應式變化

在Vue2的時候使用defineProperty來進行資料的劫持, 需要對屬性進行重寫新增getter及setter效能差。
當新增屬性和刪除屬性時無法監控變化。需要透過$set、$delete實現
陣列不採用defineProperty來進行劫持（浪費效能，對所有索引進行劫持會造成效能浪費）需要對陣列單獨進行處理

Vue3中使用Proxy來實現響應式資料變化。從而解決了上述問題

2、CompositionAPI

在Vue2中採用的是OptionsAPI, 使用者提供的data,props,methods,computed,watch等屬性 (使用者編寫複雜業務邏輯會出現反覆橫跳問題)
Vue2中所有的屬性都是透過this訪問，this存在指向明確問題
Vue2中很多未使用方法或屬性依舊會被打包，並且所有全域性API都在Vue物件上公開。Composition API對 tree-shaking 更加友好，程式碼也更容易壓縮。
元件邏輯共享問題， Vue2 採用mixins 實現元件之間的邏輯共享；但是會有資料來源不明確，命名衝突等問題。 Vue3採用CompositionAPI 提取公共邏輯非常方便

簡單的元件仍然可以採用OptionsAPI進行編寫，compositionAPI在複雜的邏輯中有著明顯的優勢~。 reactivity 模組中就包含了很多我們經常使用到的 API 例如：computed、reactive、ref、effect等

3、基本使用

const { effect, reactive } = VueReactivity
// console.log(effect, reactive);
const state = reactive({name: 'qpp', age:18, address: {city: '南京'}})
console.log(state.address);
effect(()=>{
    console.log(state.name)
})

4、reactive實現

import { mutableHandlers } from'./baseHandlers'; 
// 代理相關邏輯import{ isObject }from'./util';// 工具方法
export function reactive(target: object) {
  // if trying to observe a readonly proxy, return the readonly version.
  if (isReadonly(target)) {
    return target
  }
  return createReactiveObject(
    target,
    false,
    mutableHandlers,
    mutableCollectionHandlers,
    reactiveMap
  )
}
function createReactiveObject(target, baseHandler){
    if(!isObject(target)){
        return target;
    }
    ...
    const observed =new Proxy(target, baseHandler);
    return observed
}

baseHandlers

import { isObject, hasOwn, hasChanged } from"@vue/shared";
import { reactive } from"./reactive";
const get = createGetter();
const set = createSetter();
function createGetter(){
    return function get(target, key, receiver){
        // 對獲取的值進行放射
        const res = Reflect.get(target, key, receiver);
        console.log('屬性獲取',key)
        if(isObject(res)){// 如果獲取的值是物件型別，則返回當前物件的代理物件
            return reactive(res);
        }
        return res;
    }
}
function createSetter(){
    return function set(target, key, value, receiver){
        const oldValue = target[key];
        const hadKey =hasOwn(target, key);
        const result = Reflect.set(target, key, value, receiver);
        if(!hadKey){
            console.log('屬性新增',key,value)
        }else if(hasChanged(value, oldValue)){
            console.log('屬性值被修改',key,value)
        }
        return result;
    }
}
export const mutableHandlers ={
    get,// 當獲取屬性時呼叫此方法
    set// 當修改屬性時呼叫此方法
}

這裡我只選了對最常用到的get和set方法的程式碼，還應該有 has 、 deleteProperty 、 ownKeys 。這裡為了快速掌握核心流程就先暫且跳過這些程式碼

5、effect實現

我們再來看effect的程式碼，預設effect會立即執行，當依賴的值發生變化時effect會重新執行

export let activeEffect = undefined;
// 依賴收集的原理是 藉助js是單執行緒的特點， 預設呼叫effect的時候會去呼叫proxy的get，此時讓屬性記住
// 依賴的effect，同理也讓effect記住對應的屬性
// 靠的是資料結構 weakMap : {map:{key:new Set()}}
// 稍後資料變化的時候 找到對應的map 透過屬性出發set中effect
function cleanEffect(effect) {
    // 需要清理effect中存入屬性中的set中的effect 
    // 每次執行前都需要將effect只對應屬性的set集合都清理掉
    // 屬性中的set 依然存放effect
    let deps = effect.deps
    for (let i = 0; i < deps.length; i++) {
        deps[i].delete(effect)
    }
    effect.deps.length = 0;

}

// 建立effect時可以傳遞引數，computed也是基於effect來實現的，只是增加了一些引數條件而已
export function effect<T = any>(
    fn: () => T,
    options?: ReactiveEffectOptions    
){
    // 將使用者傳遞的函式程式設計響應式的effect
    const _effect = new ReactiveEffect(fn,options.scheduler);
    // 更改runner中的this
    _effect.run()
    const runner = _effect.run.bind(_effect);
    runner.effect = _effect; // 暴露effect的例項
    return runner// 使用者可以手動呼叫runner重新執行
}
export class ReactiveEffect {
    public active = true;
    public parent = null;
    public deps = []; // effect中用了哪些屬性，後續清理的時候要使用
    constructor(public fn,public scheduler?) { } // 你傳遞的fn我會幫你放到this上
    // effectScope 可以來實現讓所有的effect停止
    run() {
        // 依賴收集  讓熟悉和effect 產生關聯
        if (!this.active) {
            return this.fn();
        } else {
            try {
                this.parent = activeEffect
                activeEffect = this;
                cleanEffect(this); // vue2 和 vue3中都是要清理的 
                return this.fn(); // 去proxy物件上取值, 取之的時候 我要讓這個熟悉 和當前的effect函式關聯起來，稍後資料變化了 ，可以重新執行effect函式
            } finally {
                // 取消當前正在執行的effect
                activeEffect = this.parent;
                this.parent = null;
            }
        }
    }
    stop() {
        if (this.active) {
            this.active = false;
            cleanEffect(this);
        }
    }
}

在effect方法呼叫時會對屬性進行取值，此時可以進行依賴收集。

effect(()=>{
    console.log(state.name)
    // 執行使用者傳入的fn函式，會取到state.name,state.age... 會觸發reactive中的getter
    app.innerHTML = 'name:' + state.name + 'age:' + state.age + 'address' + state.address.city
    
})

6、依賴收集

核心程式碼

// 收集屬性對應的effect
export function track(target, type, key){}// 觸發屬性對應effect執行
export function trigger(target, type, key){}

function createGetter(){
    return function get(target, key, receiver){
        const res = Reflect.get(target, key, receiver);
        // 取值時依賴收集
        track(target, TrackOpTypes.GET, key);
        if(isObject(res)){
            return reactive(res);
        }
        return res;
    }
}

function createSetter(){
    return function set(target, key, value, receiver){
        const oldValue = target[key];
        const hadKey =hasOwn(target, key);
        const result = Reflect.set(target, key, value, receiver);
        if(!hadKey){
            // 設定值時觸發更新 - ADD
            trigger(target, TriggerOpTypes.ADD, key);
        }else if(hasChanged(value, oldValue)){
             // 設定值時觸發更新 - SET
            trigger(target, TriggerOpTypes.SET, key, value, oldValue);
        }
        return result;
    }
}

track的實現

const targetMap = new WeakMap();
export function track(target: object, type: TrackOpTypes, key: unknown){
    if (shouldTrack && activeEffect) { // 上下文 shouldTrack = true
        let depsMap = targetMap.get(target);
        if(!depsMap){// 如果沒有map，增加map
            targetMap.set(target,(depsMap =newMap()));
        }
        let dep = depsMap.get(key);// 取對應屬性的依賴表
        if(!dep){// 如果沒有則構建set
            depsMap.set(key,(dep =newSet()));
        }
    
        trackEffects(dep, eventInfo)
    }
}

export function trackEffects(
  dep: Dep,
  debuggerEventExtraInfo?: DebuggerEventExtraInfo
) {
  //let shouldTrack = false
  //if (effectTrackDepth <= maxMarkerBits) {
   // if (!newTracked(dep)) {
     // dep.n |= trackOpBit // set newly tracked
     // shouldTrack = !wasTracked(dep)
    //}
  //} else {
    // Full cleanup mode.
  //  shouldTrack = !dep.has(activeEffect!)
  } 

  if (!dep.has(activeEffect!) {
    dep.add(activeEffect!)
    activeEffect!.deps.push(dep)
    //if (__DEV__ && activeEffect!.onTrack) {
    //  activeEffect!.onTrack({
    //    effect: activeEffect!,
    //    ...debuggerEventExtraInfo!
    //  })
   // }
  }
}

trigger實現

export function trigger(target, type, key){
    const depsMap = targetMap.get(target);
    if(!depsMap){
        return;
    }
    const run=(effects)=>{
        if(effects){ effects.forEach(effect=>effect()); }
    }
    // 有key 就找到對應的key的依賴執行
    if(key !==void0){
        run(depsMap.get(key));
    }
    // 陣列新增屬性
    if(type == TriggerOpTypes.ADD){
        run(depsMap.get(isArray(target)?'length':'');
    }}

依賴關係

作者：京東物流喬盼盼

來源：京東雲開發者社群自猿其說Tech 轉載請註明來源

Vue3響應式原始碼分析 - reactive篇
2022-06-23
Vue原始碼React
【原始碼系列#01】vue3響應式原理（Proxy）
2023-11-20
原始碼Vue
【原始碼系列#02】Vue3響應式原理（Effect）
2023-11-28
原始碼Vue
【原始碼系列#05】Vue3響應式原理（Ref）
2024-01-04
原始碼Vue
Vue3響應式原始碼分析 - ref + ReactiveEffect篇
2022-06-30
Vue原始碼React
RxJava2 原始碼解析及設計思想
2019-01-03
RxJava原始碼
深入理解OkHttp原始碼及設計思想
2018-08-20
HTTP原始碼
vue面試題（vue2響應式原始碼剖析）
2024-03-18
Vue面試題原始碼
深入剖析Vue原始碼 - 響應式系統構建(中)
2019-07-08
Vue原始碼
深入剖析Vue原始碼 - 響應式系統構建(上)
2019-06-17
Vue原始碼
深入剖析Vue原始碼 - 響應式系統構建(下)
2019-07-11
Vue原始碼
Redux 原始碼剖析及應用
2018-05-23
Redux原始碼
Mobx 原始碼與設計思想
2022-04-06
原始碼
Vue3響應式
2024-09-03
Vue
vue3 響應式
2024-05-21
Vue
iOS框架·Masonry原始碼深度解析及學習啟示:設計模式與鏈式程式設計思想
2019-03-04
iOS框架原始碼設計模式程式設計
【原始碼&庫】Vue3 的響應式核心 reactive 和 effect 實現原理以及原始碼分析
2023-03-07
原始碼VueReact
徹底理解OkHttp - OkHttp 原始碼解析及OkHttp的設計思想
2018-12-20
HTTP原始碼
OkHttp 原始碼剖析系列（七）——請求的發起及響應的讀取
2020-01-03
HTTP原始碼
HikariPool原始碼（二）設計思想借鑑
2020-04-04
原始碼
元件 popup 設計和原始碼剖析
2020-08-31
元件原始碼
Vue 原始碼(一)：響應式原理
2018-12-02
Vue原始碼
vue3 ref響應式引用
2024-07-21
Vue
Vue3中的Ref與Reactive：深入理解響應式程式設計
2023-09-22
VueReact程式設計
原始碼解讀Dubbo分層設計思想
2021-09-14
原始碼
響應式WordPress STAR主題原始碼
2021-12-08
原始碼
vue響應式系統原始碼解析
2018-12-24
Vue原始碼
使用Reactor響應式程式設計
2020-04-28
React程式設計
併發程式設計之 LinkedBolckingQueue 原始碼剖析
2019-01-24
程式設計原始碼
併發程式設計之 ThreadLocal 原始碼剖析
2018-04-30
程式設計thread原始碼
併發程式設計之 ConcurrentLinkedQueue 原始碼剖析
2018-04-30
程式設計原始碼
函式響應式程式設計與RxSwift
2018-06-07
函式程式設計Swift
響應式設計？響應式設計的基本原理是什麼？如何做？
2021-04-16
Vue2 響應式原始碼解讀
2023-02-17
Vue原始碼
Vue 原始碼解讀（3）—— 響應式原理
2022-02-23
Vue原始碼
從原始碼看Vue的響應式原理
2019-04-10
原始碼Vue
vue3 jsx響應式渲染變數
2024-08-31
VueJS變數
【Vue3響應式原理#02】Proxy and Reflect
2023-11-06
Vue