Proxy代理資料攔截方法

叫我詹躲躲 發表於 2022-12-01

Proxy代理資料攔截方法

proxy

Proxy 物件用於建立一個物件的代理,從而實現基本操作的攔截和自定義(如屬性查詢、賦值、列舉、函式呼叫等)。

new Proxy(target,handler)

// target 是proxy 要包裝的物件 (可以是陣列、函式,也可以是另一個Proxy)
//handler 一個通常以函式作為屬性的物件,用來定製攔截行為

基本的語法是:

const p = new Proxy(target,handler)

主要的方法有:
handler.has() 是針對 in 運算子的代理方法
handler.set() 方法是設定屬性值操作的捕獲器。
handler.get() 方法用於攔截物件的讀取屬性操作。
handler.defineProperty() 用於攔截對物件的 Object.defineProperty() 操作。
handler.deleteProperty() 方法用於攔截對物件屬性的 delete 操作。

handler.has()方法

const obj = {
    name: '微芒不朽',
    occupation: '前端開發'
}

const handler = {
    has(target, key) {
        //判斷是否存在該屬性
        return key in target
    }
}


const p = new Proxy(obj, handler)
console.log(p.name) //微芒不朽
console.log(p.like) //undefined
console.log(p.occupation) //前端開發

handler.get()方法

const obj = {
    name: '微芒不朽',
    occupation: '前端開發'
}

const handler = {
    has(target, key) {
        //判斷是否存在該屬性
        return key in target
    },
    get(target, key) {
        if (key in target) {
            return target[key]
        } else {
            return new ReferenceError(key + '屬性不存在')
        }
    }
}

const p = new Proxy(obj, handler)
console.log(p.name) //微芒不朽
console.log(p.like) //ReferenceError: like屬性不存在
console.log(p.occupation) //前端開發

handler.set()方法

const obj = {
    name: '微芒不朽',
    occupation: '前端開發'
}

const handler = {
    set(target, key) {
        if (key in target) {
            return Reflect.set(...arguments)
        }
        throw new ReferenceError(key+'屬性不存在')
    }
}

const p = new Proxy(obj, handler)
p.like = '程式設計' //Uncaught ReferenceError: like屬性不存在
// console.log(p.like)
p.occupation = '測試'
console.log(p.occupation) //測試

handler.defineProperty() 方法

用於攔截對物件的 Object.defineProperty() 操作

const obj = {
    name: '微芒不朽',
    configurable: true,
    enumerable: true,
}

const handler = {
    defineProperty(target, key, descriptor) {
        console.log('屬性', key)
        return true;
    }
}

const p = new Proxy({}, handler)
Object.defineProperty(p, 'like', obj) //屬性 like

也可以使用 Reflect.defineProperty

const obj = {
    name: '微芒不朽',
    configurable: true,
    enumerable: true,
}

const handler1 = {
    defineProperty(target, key, descriptor) {
        console.log('屬性1', descriptor)
        return Reflect.defineProperty(target, key, descriptor)
    }
}

const p1 = new Proxy({}, handler)
Object.defineProperty(p1, 'like', obj) //屬性 like

handler.deleteProperty() 方法

主要攔截物件的 delete操作;

const obj = {
    name: '微芒不朽',
}

const handler = {
    deleteProperty(target, key) {
        console.log('刪除' + key)
    }
}

const p = new Proxy({}, handler)
delete p.name //刪除name

//也會攔截 Reflect.deleteProperty
Reflect.deleteProperty(obj,'name')

Proxy.revocable 撤銷代理

proxy有一個唯一的靜態方法,Proxy.revocable(target, handler)
Proxy.revocable()方法可以用來建立一個可撤銷的代理物件。 該方法的返回值是一個物件,其結構為: {"proxy": proxy, "revoke": revoke}

  • proxy 表示新生成的代理物件本身,和用一般方式 new Proxy(target, handler) 建立的代理物件沒什麼不同,只是它可以被撤銷掉。
  • revoke 撤銷方法,呼叫的時候不需要加任何引數,就可以撤銷掉和它一起生成的那個代理物件。
const obj = {
    name: '微芒不朽',
}
const handler = {}
const { proxy, revoke } = Proxy.revocable(obj, handler)
console.log(proxy.name) //微芒不朽
revoke() // 取值完成對proxy進行封閉,撤消代理
console.log(proxy.name) // Uncaught TypeError: illegal operation attempted on a revoked proxy

應用場景

Proxy實現一個格式檢驗器

場景:驗證身份證、電話、姓名和郵箱

const obj = {
    certno: '420101198101012964',
    name: '微芒不朽1',
    tel: '123456789',
    mail: '[email protected]',
}

const validators = {
    //校驗證件號碼
    certno(val) {
        return /(^\d{15}$)|(^\d{18}$)|(^\d{17}(\d|X|x)$)/.test(val)
    },
    //校驗姓名,只能為漢字
    name(val) {
        return /^[\u0391-\uFFE5]+$/.test(val)
    },
    //檢驗電話或手機號
    tel(val) {
        return /^1\d{10}$|^0\d{2,3}-?\d{7,8}$/.test(val)
    },
    //檢驗郵箱
    mail() {
        return /^[a-zA-Z0-9_.-][email protected][a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)*\.[a-zA-Z0-9]{2,6}$/.test(val)
    }
}

const validatorType = (target, validator) => {
   return new Proxy(target, {
        _validator: validator,
        set(target, key, value, proxy) {
            let validator = this._validator[key](value)
            if (validator) {
                return Reflect.set(target, key, value, proxy)
            } else {
                throw Error(`設定${key} 的值為 ${value},格式不正確`)
            }
        }
    })
}

const proxy = validatorType(obj, validators)
proxy.certno = '420101198101012964'
proxy.name = '微芒不朽1' //Uncaught Error: 設定name 的值為 微芒不朽1,格式不正確
proxy.tel = '123456789' //Uncaught Error: 設定tel 的值為 123456789,格式不正確
proxy.mail = '[email protected]'

proxy 攔截私有屬性

用proxy攔截日常定義的私有屬性,使其不能更改;一般以下劃線開頭;

let obj = {
    _id:'1234567890',
    name:'微芒不朽'
}
const p = new Proxy(obj,{
    set(target,prop){
        if(prop[0]==='_'){
            throw Error( `${prop}為私有屬性`)
        }
        return Reflect.set(target,prop)
    }
})

p.name = '加油啊'
console.log(p.name) //加油啊
p._id = '123'
console.log(p._id) //Uncaught Error: _id為私有屬性

Reactive函式

用來繫結引用資料型別, 例如物件和陣列等,實現響應式。 Proxy 本質上是對某個物件的劫持,這樣它不僅僅可以監聽物件某個屬性值的變化,還可以監聽物件屬性的新增和刪除 。而 reactive 是 vue3 中對資料進行劫持的核心 。

//判斷是否為物件
function isObject(value) {
    return value != null && (typeof value === 'object' || typeof value === 'function')
}

function reactive(obj) {
    if (!isObject(obj)) {
        return obj
    }
    return new Proxy(obj, {
        get(target, key) {
            // TODO:收集依賴
            return Reflect.get(target, key)
        },
        set(target, key, value) {
            // TODO:觸發依賴
            return Reflect.set(target, key, value)
        }
    })
}
const state = reactive({
    name: '微芒不朽'
})
console.log(state) //Proxy代理的物件
// Proxy { <target>: {…}, <handler>: {…} }
// <target>: Object { name: "微芒不朽" }
// name: "微芒不朽"
// <prototype>: Object { … }
// <handler>: Object { get: get(target, key), set: set(target, key, value)
//  }
// get: function get(target, key)
// set: function set(target, key, value)