【原始碼系列#05】Vue3響應式原理（Ref）

柏成發表於2024-01-04
原始碼Vue

Ref & ShallowRef

ref：接受一個引數值並返回一個響應式且可改變的 ref 物件。ref 物件擁有一個指向內部值的單一屬性 .value

可以將 ref 看成 reactive 的一個變形版本，這是由於 reactive 內部採用 Proxy 來實現，而 Proxy 只接受物件作為入參，這才有了 ref 來解決值型別的資料響應，如果傳入 ref 的是一個物件，內部也會呼叫 reactive 方法進行深層響應轉換

const count = ref(0)
console.log(count.value) // 0

count.value++
console.log(count.value) // 1

shallowRef：ref() 的淺層作用形式。和 ref() 不同，淺層 ref 的內部值將會原樣儲存和暴露，並且不會被深層遞迴地轉為響應式。只有對 .value 的訪問是響應式的。

const state = shallowRef({ count: 1 })

// 不會觸發更改
state.value.count = 2

// 會觸發更改
state.value = { count: 2 }

原始碼實現

  • @issue1 如果是物件和陣列，則呼叫 reactive方法 轉化為響應式物件（ref會轉換，shallowRef不會轉換）
  • @issue2 getter 取值的時候收集依賴
  • @issue3 setter 設定值的時候觸發依賴
/**
 * @desc 如果是物件和陣列，則轉化為響應式物件
 */
function toReactive(value) {
  return isObject(value) ? reactive(value) : value
}

/**
 * @desc RefImpl
 * @issue1 如果是物件和陣列，則轉化為響應式物件
 */
class RefImpl {
  // ref標識
  public __v_isRef = true
  // 儲存effect
  public dep = new Set()
  public _value
  constructor(public rawValue, public _shallow) {
    // @issue1
    this._value = _shallow ? rawValue : toReactive(rawValue)
  }
  get value() {
    // 取值的時候收集依賴
    trackEffects(this.dep)
    return this._value
  }
  set value(newValue) {
    // 新舊值不相等
    if (newValue !== this.rawValue) {
      // @issue1
      this._value = this._shallow ? newValue : toReactive(newValue)
      this.rawValue = newValue
      // 設定值的時候觸發依賴
      triggerEffects(this.dep)
    }
  }
}


// 接受一個內部值，返回一個響應式的、可更改的 ref 物件，此物件只有一個指向其內部值的屬性 .value。
export function ref(value) {
  return new RefImpl(value)
}

測試程式碼

/**
 * 1. Ref
 **/
const person = ref({
  name: '柏成',
  age: 25,
})
effect(() => {
  app.innerHTML = person.value.name
})

setTimeout(() => {
  person.value.name = '柏成2號' // 會觸發更改
}, 1000)

/**
 * 2. shallowRef
 */
const person = shallowRef({
  name: '柏成',
  age: 25,
})
effect(() => {
  app.innerHTML = person.value.name
})

setTimeout(() => {
  person.value.name = '柏成2號' // 不會觸發更改
}, 1000)

setTimeout(() => {
  person.value = {
    name: '柏成9號' // 會觸發更改
  }
}, 2000)

toRef & toRefs

toRef：基於響應式物件上的一個屬性，建立一個對應的 ref。這樣建立的 ref 與其源屬性保持同步：改變源屬性的值將更新 ref 的值，反之亦然。

const state = reactive({
  foo: 1,
  bar: 2
})

const fooRef = toRef(state, 'foo')

// 更改該 ref 會更新源屬性
fooRef.value++
console.log(state.foo) // 2

// 更改源屬性也會更新該 ref
state.foo++
console.log(fooRef.value) // 3

toRefs：將一個響應式物件轉換為一個普通物件，這個普通物件的每個屬性都是指向源物件相應屬性的 ref。每個單獨的 ref 都是使用 toRef() 建立的。

const state = reactive({
  foo: 1,
  bar: 2
})

const stateAsRefs = toRefs(state)

// 這個 ref 和源屬性已經 “連結上了”
state.foo++
console.log(stateAsRefs.foo.value) // 2

stateAsRefs.foo.value++
console.log(state.foo) // 3

原始碼實現

class ObjectRefImpl {
  // 只是將.value屬性代理到原始型別上
  constructor(public object, public key) {}
  
  get value() {
    return this.object[this.key]
  }
  
  set value(newValue) {
    this.object[this.key] = newValue
  }
}

// 基於響應式物件上的一個屬性，建立一個對應的 ref。這樣建立的 ref 與其源屬性保持同步：改變源屬性的值將更新 ref 的值，反之亦然。
export function toRef(object, key) {
  return new ObjectRefImpl(object, key)
}

// 將一個響應式物件轉換為一個普通物件，這個普通物件的每個屬性都是指向源物件相應屬性的 ref。每個單獨的 ref 都是使用 toRef() 建立的。
export function toRefs(object) {
  const result = isArray(object) ? new Array(object.length) : {}

  for (let key in object) {
    result[key] = toRef(object, key)
  }

  return result
}

測試程式碼

// 物件
const person = reactive({
  name: '柏成',
  age: 18
})
// 陣列
const numbers = reactive([1, 2, 3, 4, 5])

// 注意！直接解構後會丟失響應性的特點！！！
// let { name, age } = person

const {
  name,
  age
} = toRefs(person)
const [first] = toRefs(numbers)

effect(() => {
  app.innerHTML = `${name.value}，${age.value}歲。第一個數字為${first.value}。`
})

setTimeout(() => {
  name.value = '柏成9號'
  first.value = 999
}, 1000)

自動脫ref

在js中訪問ref時需要.value獲取，但是在模版中卻可以直接取值，不需要加.value！這裡就用到了 proxyRefs 自動脫ref方法

原始碼實現

export function proxyRefs(object) {
  return new Proxy(object, {
    // 代理的思想，如果是ref 則取ref.value
    get(target, key, recevier) {
      let r = Reflect.get(target, key, recevier)
      return r.__v_isRef ? r.value : r
    },
    // 設定的時候如果是ref,則給ref.value賦值
    set(target, key, value, recevier) {
      let oldValue = target[key]
      if (oldValue.__v_isRef) {
        oldValue.value = value
        return true
      } else {
        return Reflect.set(target, key, value, recevier)
      }
    },
  })
}

測試程式碼

const name = ref('柏成')
const age = ref('24')

const person = proxyRefs({
  name,
  age,
  sex: '男'
})

effect(() => {
  app.innerHTML = `${person.name}，${person.age}歲。性別${person.sex}。`
})

setTimeout(() => {
  name.value = '柏成9號'
}, 1000)

相關文章