Vue實現computed(Vue原理之步驟六)

Vue實現computed計算屬性(Vue原理之步驟六)

基於上一篇(Vue中實現數組)

根據計算屬性幾個特點設計思路:

1.他的值是一個函數的運行結果;

2.函數裏用到的所有屬性都會引起計算屬性的變化;

計算屬性仍然屬於Vue響應式實現的一種,本質上還是一個watcher,但是又似乎與之前的watcher實現有所不 同,因爲之前的watcher是隻能監聽一個屬性;

​ 思路: 前幾篇中watcher第二個參數exp也可以傳一個函數,然後運行這個函數並獲取返回值,運行過 程中,函數裏所有的this.xxx屬性都會觸發setter,這樣一來就可以讓多個dep都能收集到這個 watcher

3.計算屬性不存在於data選項中,需要單獨進行初始化;

4.計算屬性只能取,不能存,也就是說計算屬性的setter無效;

5.計算屬性是惰性的:計算屬性依賴的其他屬性發生變化時,計算屬性不會立即重新計算,要等到對獲取計算屬性的值,也就是求值時纔會重新計算;

6.計算屬性是緩存的:如果計算屬性的依賴的其他屬性沒有發生變化,即使重新對計算屬性求值,也不會重新計算計算屬性;

​ 5和6思路 : 給computed相關的watcher打一個標記this.lazy = true,代表這是一個lazy.watcher, 當dep通知watcher進行更新時,如果是lazy watcher,則只會給自己一個標記 this.dirty = true 等到對計算屬性進行求值時,如果watcher的dirty === true 則 會對watcher進行求值,並且把得到的值保存在watcher實例上(watcher.value), 如果 watcher的dirty === false 則直接返回watcher.value

實現computed代碼

class Vue {
    //options是傳過來的參數類似一個對象
    constructor(options){
         //把options存起來,可能會在實例中用到
        this.$options = options
        //data可能會是函數
        this._data = options.data
        this.initData()
        this.initComputed()
        this.initWatch()
    }
    initData() {
        let data = this._data;
        //獲取到data對象中所有的鍵
        let keys = Object.keys(data)
        //循環遍歷  實現數據代理
        for(let i = 0 ; i < keys.length ; i++){
            Object.defineProperty(this,keys[i],{
                //設置爲true,表示可以被遍歷
                enumerable:true,
                //可以刪除屬性,或者修改其特性(writable,configurable,enumerable)
                configurable:true,
                //獲取值的時候觸發
                get:function proxyGetter(){
                    //獲取到的值返回出去
                    return data[keys[i]]
                },
                //修改值的時候觸發
                set:function proxySetter(value) {
                    //改變值的時候,給獲取到的值賦值新值value
                    data[keys[i]] = value
                }
            })
        }
        //調研判斷是基本類型還是複雜類型的數據  來實現數據劫持
        observe(data)
    }
    initWatch() {
        //$options參數對象中是否有watch這個屬性
        let watch = this.$options.watch
        if(watch) {
            let keys = Object.keys(watch)
            //遍歷watch屬性中的值
            for(let i = 0; i < keys.length; i++){
                //new一個Watcher的實例,
                new Watcher(this,keys[i],watch[keys[i]])
            }
        }
    }
    initComputed(){
        let computed = this.$options.computed
        //判斷如果存在計算屬性,進行遍歷
        if(computed){
            let keys = Object.keys(computed)
            for(let i = 0; i < keys.length; i++) {
                //傳入第四個參數,computed是惰性的
                const watcher = new Watcher(this,computed[keys[i]],function() {},{lazy:true})
                //把該屬性添加到vue實例上,並設置只能取,不能存
                Object.defineProperty(this,keys[i],{
                    enumerable:true,
                    configurable:true,
                    get : function computerGetter() {
                        if(watcher.dirty) {
                            watcher.get()
                            watcher.dirty = false
                        }
                        //返回出去
                        return watcher.value
                    },
                    set : function computedSetter() {
                        console.warn('請不要給計算屬性computed賦值')
                    }
                })
            }
        }
    }
    //實例對象上掛載一個和watch同樣的方法
    $watch(key,cb) {
        new Watcher(this,key,cb)
    }
    //實現$set方法
    $set(target,key,value){
        //新增的屬性也變成響應式的
        defineReactive(target,key,value)
        //執行
        target.__ob__.dep.notify()
    }
}
//判斷類型的函數observe
/**
 *
 *
 * @param {*} data 
 */
function observe(data) {
    //判斷data的數據類型
    let type = Object.prototype.toString.call(data)
    //如果是基本類型就直接返回
    if(type !== '[object Object]' && type !== '[object Array]'){
        return 
    }
    if(data.__ob__){
        return data.__ob__
    }
    //如果是複雜類型,new一個實例
    return  new Observer(data)
}

//創建一個觀察值類,觀察data中的數據變化
class Observer {
    constructor(data) {
        //數組不能使用Object.defineProperty,下標會亂 ,需要判斷一下
        if(Array.isArray(data)){
            data.__proto__ = ArrayMethods
            //初始化
            this.observeArray(data)
        }else{
            //調用函數
            this.walk(data)
        }
        //實現$set需要重新new一個Dep實例
        this.dep = new Dep()
        //在data中新增一個__ob__屬性,設置該屬性不可遍歷
        Object.defineProperty(data,'__ob__',{
            value:this,
            //不可遍歷
            enumerable:false,
            configurable:true,
            writable:true
        })
    }
    //walk函數
    walk(data) {
        let keys = Object.keys(data)
        for(let i = 0; i < keys.length; i++){
            //代用抽離出去的函數
            defineReactive(data,keys[i],data[keys[i]])
        }
    }
    //數組循環,變成響應式的
    observeArray(arr){
        for(let i = 0 ; i < arr.length; i++){
            //調用observe函數
            observe(arr[i])
        }
    }

}

//抽離函數
/**
 *
 *
 * @param {*} obj 傳進來的對象
 * @param {*} key 屬性
 * @param {*} value 之前的值
 */
function defineReactive(obj,key,value){
    //遞歸,判斷數據類型
    let childObj =  observe(obj[key])
    //new一個dep的實例
    let dep = new Dep()
    Object.defineProperty(obj,key,{
        enumerable:true,
        configurable:true,
        //獲取到屬性值時調用該函數
        get:function reactiveGetter(){
            //調用depend函數收集回調函數
            dep.depend()
            //也收集一份,先判斷是否存在
            if(childObj)            {
                childObj.dep.depend()
            }
            //或取到的值返回出去
            return value
        },
        //設置值的時候掉用該函數
        set:function reactiveSetter(val){
            //對比新設置的值和原來的值是否相同
            if(val === value){
                //相同的話直接返回
                return
            }
            //執行相應回調
            dep.notify()
            //否則,設置新值
            value = val
        }
    })
}


//新建一個dep的類
class Dep{
    constructor(){
        //收集的回調存放在數組中
        this.subs = []
    }
    //收集回調函數
    depend() {
        //把回調添加到數組中
        if(Dep.target) {
            //把含有不同屬性的Watcher實例添加到數組中
            this.subs.push(Dep.target)
        }
    }
    //執行相應的回調函數
    notify() {
        //循環遍歷數組,執行相應回調
        this.subs.forEach((watcher)=>{
            // watcher指的是數組中的每一項,每一項是Watcher實例,實例中包含run函數
            //一次執行回調函數
            watcher.update()
        })
    }
}

//每一個watcher的標識
let watcherId = 0;
//存放標識id的數組,用於檢查是否有相同的watch
let watcherQueue = [];
//把回調抽象成一個Watcher類
class Watcher {
    //參數1:vue實例,參數2:哪一個屬性,參數3:回調函數是什麼
    constructor(vm,exp,cb,options = {}){
        this.dirty = this.lazy = !!options.lazy
        this.vm = vm;
        this.exp = exp;
        this.cb = cb;
        this.id = ++watcherId;
        //如果不是惰性,執行get函數
        if(!this.lazy){
            this.get()
        }
    }
    //求值
    get(){
        //把Watcher類的this 掛載到Dep類的靜態屬性上,相當於把Watcher實例掛載到全局了
        Dep.target = this;
        //判斷第二個參數是函數的話
        if(typeof this.exp === 'function'){
            //定義一個實例下的value保存值,把函數exp的this改變爲vue實例
            this.value = this.exp.call(this.vm)
        }else {
            //調用下邊這個表達式,觸發數據劫持中get函數,從而調用depend函數
            this.value = this.vm[this.exp]
        }
        //然後清空
        Dep.target = null
    }
    update() {
        if(this.lazy) {
            this.dirty = true
        }else {
            this.run()
        }
    }
    //執行函數
    run() {
        //當存在於數組中
       if(watcherQueue.indexOf(this.id) !== -1){
            return
       }
       watcherQueue.push(this.id)
       let index = watcherQueue.length - 1
       //不存在的時候,異步執行
       Promise.resolve().then(()=>{
        //調用回調函數cb時,把this指向改變爲vue實例
        this.cb.call(this.vm)
        //然後把數組中刪掉
        watcherQueue.splice(index,1)
       })
    
    }
}
//創建一個對象
const ArrayMethods = {}
//把這個對象的原型對象指向數組的原型
ArrayMethods.__proto__ = Array.prototype
//把修改的方法名放在數組中
const methods = [
    'push',
    'pop',
    //其他攔截的方法
]
//循環要攔截的方法
methods.forEach(method => {
    //把傳遞過來的參數放在數組中,使用擴展運算符展開
    ArrayMethods[method] = function(...args){
        //如果是push方法,傳入的是一個數組的話
        if(method === 'push'){
            this.__ob__.observeArray(args)
        }
        //調用原來的方法  改變this指向,然後傳參
      const result =  Array.prototype[method].apply(this,args)
      //手動調用notify執行
     this.__ob__.dep.notify()
     //把結果返回出去
      return result
    }
})

1.上邊代碼和原版Vue比較有問題

使用以下代碼測試,分別測試原版vue.js和自己寫的vue.js

let vm = new Vue({
            data:{
                person:{
                    name:'zhangsan'
                }
            },
            watch:{
                x() {//2號watcher
                    console.log('x監聽')
                }
            },
            computed:{
                x() {//1號watcher
                    console.log('x計算')
                    return JSON.stringify(this.person)
                }
            }
        })

1.原版的vue.js,打印vm

2.自己寫的vue.js,打印vm

分析原因:

把computed中的watcher稱爲1號watcher,把watch中的watcher稱爲2號watcher,在代碼中initWatcher調用時,2號watcher上臺求值,觸發了person的getter,觸發1號watcher的get()方法,1號watcher也上臺,覆蓋了2號watcher,person的筐(前幾篇提到的存和取回調函數的數組)開始收集1號watcher,結束後清空舞臺,person並沒有收集到1號watcher

解決思路:

維護一個棧,有新的watcher上臺時入棧,下臺時出棧,臺上永遠是棧頂的watcher;

watcher被dep收集時,也收集dep,互相收集,這樣的話,計算屬性getter完成後,檢查舞臺上還有沒有watcher,有就把自己的watcher收集的dep拿出來通知,收集舞臺上的watcher

解決問題的版本

class Vue {
    //options是傳過來的參數類似一個對象
    constructor(options){
         //把options存起來,可能會在實例中用到
        this.$options = options
        //data可能會是函數
        this._data = options.data
        this.initData()
        this.initComputed()
        this.initWatch()
    }
    initData() {
        let data = this._data;
        //獲取到data對象中所有的鍵
        let keys = Object.keys(data)
        //循環遍歷  實現數據代理
        for(let i = 0 ; i < keys.length ; i++){
            Object.defineProperty(this,keys[i],{
                //設置爲true,表示可以被遍歷
                enumerable:true,
                //可以刪除屬性,或者修改其特性(writable,configurable,enumerable)
                configurable:true,
                //獲取值的時候觸發
                get:function proxyGetter(){
                    //獲取到的值返回出去
                    return data[keys[i]]
                },
                //修改值的時候觸發
                set:function proxySetter(value) {
                    //改變值的時候,給獲取到的值賦值新值value
                    data[keys[i]] = value
                }
            })
        }
        //調研判斷是基本類型還是複雜類型的數據  來實現數據劫持
        observe(data)
    }
    initWatch() {
        //$options參數對象中是否有watch這個屬性
        let watch = this.$options.watch
        if(watch) {
            let keys = Object.keys(watch)
            //遍歷watch屬性中的值
            for(let i = 0; i < keys.length; i++){
                //new一個Watcher的實例,
                new Watcher(this,keys[i],watch[keys[i]])
            }
        }
    }
    initComputed(){
        let computed = this.$options.computed
        //判斷如果存在計算屬性,進行遍歷
        if(computed){
            let keys = Object.keys(computed)
            for(let i = 0; i < keys.length; i++) {
                //傳入第四個參數,computed是惰性的
                const watcher = new Watcher(this,computed[keys[i]],function() {},{lazy:true})
                //把該屬性添加到vue實例上,並設置只能取,不能存
                Object.defineProperty(this,keys[i],{
                    enumerable:true,
                    configurable:true,
                    get : function computerGetter() {
                        if(watcher.dirty) {
                            watcher.get()
                            watcher.dirty = false
                        }
                        // 已經收集了1號watcher,此時1號watcher也記錄了person的dep
                        if(Dep.target) {
                            //1號watcher收集到的dep,把這些dep一個個的拿出來通知他們收集,現在仍然在2號watcher
                            for(let j = 0; j < watcher.deps.length; j++) {
                                watcher.deps[j].depend()
                            }
                        }
                        //返回出去
                        return watcher.value
                    },
                    set : function computedSetter() {
                        console.warn('請不要給計算屬性computed賦值')
                    }
                })
            }
        }
    }
    //實例對象上掛載一個和watch同樣的方法
    $watch(key,cb) {
        new Watcher(this,key,cb)
    }
    //實現$set方法
    $set(target,key,value){
        //新增的屬性也變成響應式的
        defineReactive(target,key,value)
        //執行
        target.__ob__.dep.notify()
    }
}
//判斷類型的函數observe
/**
 *
 *
 * @param {*} data 
 */
function observe(data) {
    //判斷data的數據類型
    let type = Object.prototype.toString.call(data)
    //如果是基本類型就直接返回
    if(type !== '[object Object]' && type !== '[object Array]'){
        return 
    }
    if(data.__ob__){
        return data.__ob__
    }
    //如果是複雜類型,new一個實例
    return  new Observer(data)
}

//創建一個觀察值類,觀察data中的數據變化
class Observer {
    constructor(data) {
        //數組不能使用Object.defineProperty,下標會亂 ,需要判斷一下
        if(Array.isArray(data)){
            data.__proto__ = ArrayMethods
            //初始化
            this.observeArray(data)
        }else{
            //調用函數
            this.walk(data)
        }
        //實現$set需要重新new一個Dep實例
        this.dep = new Dep()
        //在data中新增一個__ob__屬性,設置該屬性不可遍歷
        Object.defineProperty(data,'__ob__',{
            value:this,
            //不可遍歷
            enumerable:false,
            configurable:true,
            writable:true
        })
    }
    //walk函數
    walk(data) {
        let keys = Object.keys(data)
        for(let i = 0; i < keys.length; i++){
            //代用抽離出去的函數
            defineReactive(data,keys[i],data[keys[i]])
        }
    }
    //數組循環,變成響應式的
    observeArray(arr){
        for(let i = 0 ; i < arr.length; i++){
            //調用observe函數
            observe(arr[i])
        }
    }

}

//抽離函數
/**
 *
 *
 * @param {*} obj 傳進來的對象
 * @param {*} key 屬性
 * @param {*} value 之前的值
 */
function defineReactive(obj,key,value){
    //遞歸,判斷數據類型
    let childObj =  observe(obj[key])
    //new一個dep的實例
    let dep = new Dep()
    Object.defineProperty(obj,key,{
        enumerable:true,
        configurable:true,
        //獲取到屬性值時調用該函數
        get:function reactiveGetter(){
            //調用depend函數收集回調函數
            dep.depend()
            //也收集一份,先判斷是否存在
            if(childObj)            {
                childObj.dep.depend()
            }
            //或取到的值返回出去
            return value
        },
        //設置值的時候掉用該函數
        set:function reactiveSetter(val){
            //對比新設置的值和原來的值是否相同
            if(val === value){
                //相同的話直接返回
                return
            }
            //執行相應回調
            dep.notify()
            //否則,設置新值
            value = val
        }
    })
}

//新建一個棧,完成computed
let targetStack = []
//新建一個dep的類
class Dep{
    constructor(){
        //收集的回調存放在數組中
        this.subs = []
    }
    addSub(watcher) {
        //把含有不同屬性的Watcher實例添加到數組中
        this.subs.push(watcher)
    }
    //收集回調函數
    depend() {
        //把回調添加到數組中
        if(Dep.target) {
            Dep.target.addDep(this)
        }
    }
    //執行相應的回調函數
    notify() {
        //循環遍歷數組,執行相應回調
        this.subs.forEach((watcher)=>{
            // watcher指的是數組中的每一項,每一項是Watcher實例,實例中包含run函數
            //一次執行回調函數
            watcher.update()
        })
    }
}

//每一個watcher的標識
let watcherId = 0;
//存放標識id的數組,用於檢查是否有相同的watch
let watcherQueue = [];
//把回調抽象成一個Watcher類
class Watcher {
    //參數1:vue實例,參數2:哪一個屬性,參數3:回調函數是什麼
    constructor(vm,exp,cb,options = {}){
        this.dirty = this.lazy = !!options.lazy
        this.vm = vm;
        this.exp = exp;
        this.cb = cb;
        this.id = ++watcherId;
        this.deps = [];
        //如果不是惰性,執行get函數
        if(!this.lazy){
            this.get()
        }
    }
    addDep(dep) {
        //dep實例有可能被收集過,如果收集過,則直接返回
        if(this.deps.indexOf(dep) !== -1) {
            return
        }
        this.deps.push(dep)
        //進行互相收集
        dep.addSub(this)
    }
    //求值
    get(){
        //先把該實例推向棧中
        targetStack.push(this)
        //把Watcher類的this 掛載到Dep類的靜態屬性上,相當於把Watcher實例掛載到全局了
        Dep.target = this;
        //判斷第二個參數是函數的話
        if(typeof this.exp === 'function'){
            //定義一個實例下的value保存值,把函數exp的this改變爲vue實例
            this.value = this.exp.call(this.vm)
        }else {
            //調用下邊這個表達式,觸發數據劫持中get函數,從而調用depend函數
            this.value = this.vm[this.exp]
        }
        // 出棧的時候
        targetStack.pop()
        // 判斷棧內是否有元素
        if(targetStack.length > 0 ){
            //把棧頂的watcher拿出來放到舞臺上
            Dep.target = targetStack[targetStack.length - 1]
        }else {
            //然後清空
            Dep.target = null
        }
     
    }
    update() {
        if(this.lazy) {
            this.dirty = true
        }else {
            this.run()
        }
    }
    //執行函數
    run() {
        //當存在於數組中
       if(watcherQueue.indexOf(this.id) !== -1){
            return
       }
       watcherQueue.push(this.id)
       let index = watcherQueue.length - 1
       //不存在的時候,異步執行
       Promise.resolve().then(()=>{
        //computed添加的,都會收集一下
        this.get()
        //調用回調函數cb時,把this指向改變爲vue實例
        this.cb.call(this.vm)
        //然後把數組中刪掉
        watcherQueue.splice(index,1)
       })
    
    }
}
//創建一個對象
const ArrayMethods = {}
//把這個對象的原型對象指向數組的原型
ArrayMethods.__proto__ = Array.prototype
//把修改的方法名放在數組中
const methods = [
    'push',
    'pop',
    //其他攔截的方法
]
//循環要攔截的方法
methods.forEach(method => {
    //把傳遞過來的參數放在數組中,使用擴展運算符展開
    ArrayMethods[method] = function(...args){
        //如果是push方法,傳入的是一個數組的話
        if(method === 'push'){
            this.__ob__.observeArray(args)
        }
        //調用原來的方法  改變this指向,然後傳參
      const result =  Array.prototype[method].apply(this,args)
      //手動調用notify執行
     this.__ob__.dep.notify()
     //把結果返回出去
      return result
    }
})