Skip to content

一. Object.defineProperty监听对象的缺陷


  • 我们先来看一个需求:有一个对象,我们希望监听这个对象中的属性被设置或获取的过程

    • 通过我们前面所学的知识,能不能做到这一点呢?
    • 其实是可以的,我们可以通过之前的属性描述符中的存取属性描述符来做到
  • 下面这段代码就利用了前面讲过的 Object.defineProperty 的存取属性描述符来对属性的操作进行监听

    js
    const obj = {
      name: 'later',
      age: 18
    }
    
    Object.keys(obj).forEach(key => {
      let value = obj[key]
      Object.defineProperty(obj, key, {
        set: function(newValue) {
          console.log(`监听到给${key}设置值`)
          value = newValue
        },
        get: function() {
          console.log(`监听到获取${key}的值`)
          return value
        }
      })
    })
    
    obj.name = 'hhh' // 监听到给name设置值
    console.log(obj.name) // 监听到获取name的值 hhh
  • 但是这样做有什么缺点呢?

    • 首先,Object.defineProperty 设计的初衷,不是为了去监听截取一个对象中所有的属性的
      • 我们在定义某些属性的时候,初衷其实是定义普通的属性,但是后面我们强行将它变成了数据属性描述符
    • 其次,如果我们想监听更加丰富的操作,比如新增属性、删除属性,那么 Object.defineProperty 是无能为力的
  • 所以我们要知道,存取描述符设计的初衷并不是为了去监听一个完整的对象

二. Proxy 类基本使用


  • ES6 中,新增了一个 Proxy 类,这个类从名字就可以看出来,是用于帮助我们创建一个代理的:

    • 也就是说,如果我们希望监听一个对象的相关操作,那么我们可以先创建一个代理对象(Proxy 对象)
    • 之后对该对象的所有操作,都通过代理对象来完成,代理对象可以监听我们想要对原对象进行哪些操作
  • 我们可以将上面的案例用 Proxy 来实现一次:

    • 首先,我们需要 new Proxy 对象,并且传入需要侦听的对象以及一个处理对象,可以称之为 handler

      js
      new Proxy(target, handler)
    • 其次,我们之后的操作都是直接对 Proxy 对象的操作,而不是原有的对象,因为我们需要在 handler 里面进行侦听

      js
      const obj = {
        name: 'later',
        age: 18
      }
      
      const objProxy = new Proxy(obj, {})
      console.log(objProxy) // Proxy {name: 'later', age: 18}

三. Proxy 常见捕获器


1. Proxy 的 set/get 捕获器

  • 如果我们想要侦听某些具体的操作,那么就可以在 handler 中添加对应的捕捉器(Trap):

  • setget 分别对应的是函数类型:

    • set 函数有四个参数:
      • target:目标对象(侦听的对象)
      • property:将被设置的属性key
      • value:新属性值
      • receiver:调用的代理对象
    • get 函数有三个参数:
      • target:目标对象(侦听的对象)
      • property:被获取的属性 key
      • receiver:调用的代理对象
    js
    const obj = {
      name: 'later',
      age: 18
    }
    
    // 1.创建一个Proxy对象
    const objProxy = new Proxy(obj, {
      set: function(target, key, newValue) {
        console.log(`监听: 给${key}设置了新值: `, newValue)
        target[key] = newValue // 这里不会出现递归,因为是对objProxy对象进行的操作,里面修改的
      },
      get: function(target, key) {
        console.log(`监听: 获取了${key}`)
        return target[key]
      }
    })
    
    // 2.对obj的所有操作, 应该去操作objProxy
    objProxy.name // 监听: 获取了name
    objProxy.name = "kobe" // 监听: 给name设置了新值:  kobe
    objProxy.address = "深圳市" // 监听: 给address设置了新值:  深圳市
    console.log(objProxy.address) // 监听: 获取了address => 深圳市
    console.log(obj) // { name: 'kobe', age: 18, address: '深圳市' }

2. Proxy 所有捕获器

  • 13个捕获器分别是做什么的呢?

    js
    handler.getPrototypeOf() // Object.getPrototypeOf方法的捕捉器
    handler.setPrototypeOf() // Object.setPrototypeOf方法的捕捉器
    handler.isExtensible() // Object.isExtensible方法的捕捉器(判断是否可以新增属性)
    handler.preventExtensions() // Object.preventExtensions方法的捕捉器
    handler.getOwnPropertyDescriptor() // Object.getOwnPropertyDescriptor方法的捕捉器
    handler.defineProperty() // Object.defineProperty方法的捕捉器
    handler.ownKeys() // Object.getOwnPropertyNames方法和Object.getOwnPropertySymbols方法的捕捉器
    handler.has() // in操作符的捕捉器
    handler.get() // 属性读取操作的捕捉器
    handler.set() // 属性设置操作的捕捉器
    handler.deleteProperty() // delete操作符的捕捉器
    handler.apply() // 函数调用操作的捕捉器
    handler.construct() // new操作符的捕捉器
  • 看个示例:

    js
    const obj = {
      name: 'later',
      age: 18
    }
    
    // 1.创建一个Proxy对象
    const objProxy = new Proxy(obj, {
      deleteProperty: function(target, key) {
        console.log(`监听到: 删除${key}属性`)
        delete obj[key]
      },
      has: function(target, key) {
        console.log(`监听到: 使用in操作符判断${key}属性`)
        return key in target
      }
    })
    
    delete objProxy.name // 监听到: 删除name属性
    "age" in objProxy // 监听到: 使用in操作符判断age属性

3. Proxy 的 construct/apply 捕捉器

  • 当然,我们还会看到捕捉器中还有 constructapply,它们是应用于函数对象的:

    js
    function foo(num1, num2) {
      console.log(this, num1, num2)
    }
    
    const fooProxy = new Proxy(foo, {
      apply: function(target, thisArg, otherArgs) {
        console.log("执行了apply操作")
        target.apply(thisArg, otherArgs)
      },
      construct: function(target, argumentsList, newTarget) {
        console.log("执行了new操作")
        console.log(target == foo, argumentsList, newTarget == fooProxy)
        return new target(...argumentsList)
      }
    })
    
    fooProxy.apply("abc", [111, 222])
    new fooProxy("aaa", "bbb")
    // output:
    // 执行了apply操作
    // [String: 'abc'] 111 222
    // 执行了new操作
    // true [ 'aaa', 'bbb' ] true
    // foo {} aaa bbb

四. Reflect 介绍和作用


  • Reflect 也是 ES6 新增的一个 API,是一个内置对象,字面的意思是反射
  • 那么这个 Reflect 有什么用呢?
    • 它主要提供了很多操作 js 对象的方法,有点像 Object 中操作对象的方法
    • 比如 Reflect.getPrototypeOf() 类似于 Object.getPrototypeOf()
    • 比如 Reflect.defineProperty() 类似于 Object.defineProperty()
  • 我们有 Object 可以做这些操作,那么为什么还需要有 Reflect 这样的新增对象呢?
    • 这是因为在早期的 ECMA 规范中没有考虑到这种对对象本身的操作如何设计会更加规范,所以将这些 API 放到了 Object 上面
    • 但是 Object 作为一个构造函数,这些操作实际上放到它身上并不合适,会显得很重
    • 另外还包含一些类似于 indelete 操作符,让 js 看起来是会有一些奇怪的
    • 所以在 ES6 中新增了 Reflect,让我们这些操作都集中到了 Reflect 对象上
    • 另外在使用 Proxy 时,可以搭配 Reflect 做到不操作原对象
  • ObjectReflect 对象之间的 API 关系,可以参考 MDN 文档:
javascript
"use strict"

const obj = {
  name: 'later',
  age: 18
}

Object.defineProperty(obj, "name", {
  configurable: false
})

// 1.用以前的方式进行操作
// 严格模式下,name不可配置的前提下,下面的delete操作会报错,在js中报错,后果严重,后续代码将不会继续执行(if...else代码不会执行)
delete obj.name 
if (obj.name) {
  console.log("name没有删除成功")
} else {
  console.log("name删除成功")
}

// 2.Reflect的方式,不会报错,会正常执行
if (Reflect.deleteProperty(obj, "name")) {
  console.log("name删除成功")
} else {
  console.log("name没有删除成功")
}
// output:
// name没有删除成功

五. Reflect 的基本使用


1. Reflect 的常见方法

  • Reflect 中有哪些常见的方法呢?它和 Proxy 是一一对应的,也是13个:

    js
    Reflect.getPrototypeOf(target) // 类似于Object.getPrototypeOf()
    Reflect.setPrototypeOf(target, prototype) // 设置对象原型的函数,若更新成功返回true,否则false
    Reflect.isExtensible(target) // 类似于Object.isExtensible()
    Reflect.preventExtensions(target) // 类似于Object.preventExtensions(),返回一个Boolean
    Reflect.getOwnPropertyDescriptor(target, propertyKey) // 类似于Object.getOwnPropertyDescriptor(),如果对象中存在该属性,则返回对应的属性描述符, 否则返回undefined
    Reflect.defineProperty(target, propertyKey, attributes) // 和Object.defineProperty()类似。如果设置成功就会返回true
    Reflect.ownKeys(target) // 返回一个包含所有自身属性(不包含继承属性)的数组。类似于Object.keys(), 但不会受enumerable影响
    Reflect.has(target, propertyKey) // 判断一个对象是否存在某个属性,和in操作符的功能完全相同
    Reflect.get(target, propertyKey[, receiver]) // 获取对象身上某个属性的值,类似于target[name]
    Reflect.set(target, propertyKey, value[, receiver]) // 将值分配给属性的函数。返回一个Boolean,如果更新成功,则返回true
    Reflect.deleteProperty(target, propertyKey) // 作为函数的delete操作符,相当于执行delete target[name]
    Reflect.apply(target, thisArgument, argumentsList) // 对一个函数进行调用操作,同时可以传入一个数组作为调用参数。和Function.prototype.apply()功能类似
    Reflect.construct(target, argumentsList[, newTarget]) // 对构造函数进行new操作,相当于执行new target(...args)

2. Reflect 的使用

  • 那么我们可以将之前 Proxy 案例中对原对象的操作,都修改为 Reflect 来操作**:**

    js
    "use strict"
    
    const obj = {
      name: 'later',
      age: 18
    }
    
    const objProxy = new Proxy(obj, {
      set: function(target, key, newValue, receiver) {
        // target[key] = newValue
        // 1.好处一: 代理对象的目的: 不再直接操作原对象
        // 2.好处二: Reflect.set方法有返回Boolean值, 可以判断本次操作是否成功
        const isSuccess = Reflect.set(target, key, newValue)
        if (!isSuccess) {
          throw new Error(`set ${key} failure`)
        }
        // 这里为什么需要判断是否是严格模式?
        // 在严格模式下,如果set方法返回false,那么也会抛出一个TypeError异常
        if (isStrictMode()) 
          return isSuccess
      },
    })
    
    // 操作代理对象
    objProxy.name = "kobe"
    console.log(obj) // {name: 'kobe', age: 18}
    
    function isStrictMode() {
      return !this
    }

六. Reflect 的 receiver 参数


  • 我们发现在使用 gettersetter 的时候有一个 receiver 的参数,它的作用是什么呢?
    • 如果我们的源对象(obj)有 settergetter 的访问器属性,那么可以通过 receiver 来改变里面的 this

    • Reflect.set/get 最后一个参数 receiver,可以决定对象访问器 setter/getter 中的 this 指向

      js
      // "use strict"
      
      const obj = {
        _name: 'later',
        set name(newValue) {
          console.log("this:", this) // 默认是obj
          this._name = newValue // 如果这里this指向objProxy,则等价于objProxy._name = newValue操作,则又会触发一次objProxy中的set捕捉器,从而给objProxy代理对象设置_name属性 = newValue
        },
        get name() {
          return this._name
        }
      }
      
      // console.log(obj.name)
      // obj.name = "kobe"
      
      const objProxy = new Proxy(obj, {
        set: function(target, key, newValue, receiver) {
          // target[key] = newValue
          // 1.好处一: 代理对象的目的: 不再直接操作原对象
          // 2.好处二: Reflect.set方法有返回Boolean值, 可以判断本次操作是否成功
          /*
             3.好处三:
               > setter中的receiver为setter调用时this的值,本demo中就是objProxy对象,因为是objProxy.name = 'kobe'操作触发的
               > Reflect.set/get最后一个参数receiver, 可以决定对象访问器setter/getter中的this指向
          */
          console.log("proxy中设置方法被调用")
          const isSuccess = Reflect.set(target, key, newValue, receiver)
      
          // if (!isSuccess) {
          //   throw new Error(`set ${key} failure`)
          // }
          },
        get: function(target, key, receiver) {
          console.log("proxy中获取方法被调用")
          return Reflect.get(target, key, receiver)
        }
      })
      
      
      // 操作代理对象
      objProxy.name = "kobe"
      console.log(obj) // {_name: 'kobe', name: 'kobe'}

补充:

  • get 语法将对象属性绑定到查询该属性时将被调用的函数
  • 当尝试设置属性时,set 语法将对象属性绑定到要调用的函数。它还可以在类中应用

七. Reflect.construct()


  • Reflect.construct() 方法的行为有点像 new 操作符构造函数,相当于运行 new target(...args)

    js
    Reflect.construct(target, argumentsList[, newTarget])
    • target:被执行的构造函数
    • argumentsList:类数组,target 构造函数调用时的参数
    • newTarget:作为新创建对象的原型对象的 constructor 属性,参考 new.target 操作符,默认值为 target
    js
    function Person(name, age) {
      this.name = name
      this.age = age
    }
    
    // 写法一: 
    function Student(name, age) {
      Person.call(this, name. age)
      Person.apply(this, [name, age])
    }
    const stu1 = new Student('later', 18)
    console.log(stu1) // Student {name: 'later', age: 18}
    
    
    // 写法二:
    function Student(name, age) {
      const _this = Reflect.construct(Person, [name, age], Student)
      console.log(_this.__proto__.constructor === Student) // true
      return _this
    }
    const stu1 = new Student('later', 18)
    console.log(stu1) // Student {name: 'later', age: 18}
    
    
    // 写法三:
    function Student(name, age) {}
    const stu1 = Reflect.construct(Person, ['later', 18], Student)
    console.log(stu1.__proto__.constructor === Student) // true
    console.log(stu1.__proto__ === Student.prototype) // true
    console.log(stu1.__proto__.constructor === Student.prototype.constructor) // true
    console.log(Student.prototype.constructor === Student) // true
    console.log(stu1) // Student {name: 'later', age: 18}

Released under the MIT License.