美文网首页
es6 — Symbol - 2020-06-08

es6 — Symbol - 2020-06-08

作者: 勇敢的小拽马 | 来源:发表于2020-06-08 15:42 被阅读0次

    基础数据类型

    可通过调用Symbol()函数来创建一个Symbol实例:

    let s1 = Symbol()
    let s2 = Symbol('description')
    
    console.log(typeof s1)  // 'symbol'
    console.log(typeof s2)  // 'symbol'
    

    每个Symbol实例都是唯一的

    let s1 = Symbol()
    let s2 = Symbol('description')
    let s3 = Symbol('description')
    
    s1 === s2 // false
    s2 === s3 // false
    

    场景1:使用Symbol来作为对象属性名(key)

    在这之前,我们通常定义或访问对象的属性时都是使用字符串,比如下面的代码:

    let obj = {
      abc: 123,
      "hello": "world"
    }
    
    obj["abc"] // 123
    obj["hello"] // 'world'
    

    而现在,Symbol可同样用于对象属性的定义和访问:

    const PROP_NAME = Symbol()
    const PROP_AGE = Symbol()
    
    let obj = {
      [PROP_NAME]: "张三"
    }
    obj[PROP_AGE] = 18
    
    obj[PROP_NAME] // '张三'
    obj[PROP_AGE] // 18
    

    随之而来的是另一个非常值得注意的问题:就是当使用了Symbol作为对象的属性key后,在对该对象进行key的枚举时,会有什么不同?在实际应用中,我们经常会需要使用Object.keys()或者for...in来枚举对象的属性名,那在这方面,Symbol类型的key表现的会有什么不同之处呢?来看以下示例代码:

    let obj = {
       [Symbol('name')]: '李四',
       age: 18,
       title: 'Engineer'
    }
    
    Object.keys(obj)   // ['age', 'title']
    
    for (let p in obj) {
       console.log(p)   // 分别会输出:'age' 和 'title'
    }
    
    Object.getOwnPropertyNames(obj)   // ['age', 'title']
    

    由上代码可知,Symbol类型的key是不能通过Object.keys()或者for...in来枚举的,它未被包含在对象自身的属性名集合(property names)之中。所以,利用该特性,我们可以把一些不需要对外操作和访问的属性使用Symbol来定义。

    也正因为这样一个特性,当使用JSON.stringify()将对象转换成JSON字符串的时候,Symbol属性也会被排除在输出内容之外:

    JSON.stringify(obj)  // {"age":18,"title":"Engineer"}
    

    然而,这样的话,我们就没办法获取以Symbol方式定义的对象属性了么?非也。还是会有一些专门针对Symbol的API,比如:

    // 使用Object的API
    Object.getOwnPropertySymbols(obj) // [Symbol(name)]
    
    // 使用新增的反射API
    Reflect.ownKeys(obj) // [Symbol(name), 'age', 'title']
    

    场景2:使用Symbol来替代常量

    // const TYPE_AUDIO = 'AUDIO'
    // const TYPE_VIDEO = 'VIDEO'
    // const TYPE_IMAGE = 'IMAGE'
    
    const TYPE_AUDIO = Symbol()
    const TYPE_VIDEO = Symbol()
    const TYPE_IMAGE = Symbol()
    
    function handleFileResource(resource) {
      switch(resource.type) {
        case TYPE_AUDIO:
          playAudio(resource)
          break
        case TYPE_VIDEO:
          playVideo(resource)
          break
        case TYPE_IMAGE:
          previewImage(resource)
          break
        default:
          throw new Error('Unknown type of resource')
      }
    }
    

    场景3:使用Symbol定义类的私有属性/方法

    • a.js
    const PASSWORD = Symbol()
    
    class Login {
      constructor(username, password) {
        this.username = username
        this[PASSWORD] = password
      }
    
      checkPassword(pwd) {
          return this[PASSWORD] === pwd
      }
    }
    
    export default Login
    
    • b.js
    import Login from './a'
    
    const login = new Login('admin', '123456')
    
    login.checkPassword('123456')  // true
    
    login.PASSWORD  // oh!no!
    login[PASSWORD] // oh!no!
    login["PASSWORD"] // oh!no!
    

    由于Symbol常量PASSWORD被定义在a.js所在的模块中,外面的模块获取不到这个Symbol,也不可能再创建一个一模一样的Symbol出来(因为Symbol是唯一的),因此这个PASSWORD的Symbol只能被限制在a.js内部使用,所以使用它来定义的类属性是没有办法被模块外访问到的,达到了一个私有化的效果。

    注册和获取全局Symbol

    通常情况下,我们在一个浏览器窗口中(window),使用Symbol()函数来定义和Symbol实例就足够了。但是,如果你的应用涉及到多个window(最典型的就是页面中使用了<iframe>),并需要这些window中使用的某些Symbol是同一个,那就不能使用Symbol()函数了,因为用它在不同window中创建的Symbol实例总是唯一的,而我们需要的是在所有这些window环境下保持一个共享的Symbol。这种情况下,我们就需要使用另一个API来创建或获取Symbol,那就是Symbol.for(),它可以注册或获取一个window间全局的Symbol实例:

    let gs1 = Symbol.for('global_symbol_1')  //注册一个全局Symbol
    let gs2 = Symbol.for('global_symbol_1')  //获取全局Symbol
    
    gs1 === gs2  // true
    这样一个Symbol不光在单个window中是唯一的,在多个相关window间也是唯一的了。
    

    Symbol.toPrimitive

    对象的Symbol.toPrimitive属性。指向一个方法。该对象被转化为原始类型的值时,会调用这个办法,返回该对象对应的原始类型值。
    Symbol.toPrimitive被调用时,会接受一个字符串参数,表示当前运算的模式,一个有三种模式。

    • Number:该场合需要转成数值
    • String:该场合需要转成字符串
    • Default:该场合可以转成数值,也可以转成字符串。

    以上内容来自阮老师的ES6入门,下面我们结合几个例子,具体看下Symbol.toPrimitive是如何被调用的。

    // 没有 Symbol.toPrimitive 属性的对象
    var obj1 = {};
    console.log(+obj1);       //NaN
    console.log(`${obj1}`);   //"[object Object]"
    console.log(obj1 + "");   //"[object Object]"
    

    第一个,+符号。可以看成是是把数据转化为数字类型,由于obj是个空对象,所以结果是NaN
    第二个,是es6中的字符串的新语法,这里需要的结果是一个字符串,所以使用的是toString()方法,而toString()方法返回的是对象的类型。
    第三个,这里是连接符连接obj。实际上也是需要字符串的结果,所以同理。

    // 拥有 Symbol.toPrimitive 属性的对象
    var obj2 = {
      [Symbol.toPrimitive](hint) {
        if(hint == "number"){
            return 10;
        }
        if(hint == "string"){
            return "hello";
        }
        return true;
      }
    }
    
    console.log(+obj2);     //10    --hint in "number"
    console.log(`${obj2}`); //hello --hint is "string"
    console.log(obj2 + ""); //"true"
    
    // 拥有 Symbol.toPrimitive 属性的对象
    let obj = {
      [Symbol.toPrimitive](hint) {
        if(hint === 'number'){
          console.log('Number场景');
          return 123;
        }
        if(hint === 'string'){
          console.log('String场景');
          return 'str';
        }
        if(hint === 'default'){
          console.log('Default 场景');
          return 'default';
        }
      }
    }
    console.log(2*obj); // Number场景 246
    console.log(3+obj); // String场景 3default
    console.log(obj + "");  // Default场景 default
    console.log(String(obj)); //String场景 str
    

    由以上例子可以总结,一般情况下,+连接运算符传入的参数是default,而对于乘法等算数运算符传入的是number。对于String(str),${str}等情况,传入的参数是defalut。

    Symbol.toPrimitive和toString、valueOf
    当然,你也可以重写一个不做参数判断的Symbol.toPrimitive方法,结合上面提到的toString,可以有以下例子。

    let ab = {
        valueOf() {
            return 0;
        },
        toString() {
            return '1';
        },
        [Symbol.toPrimitive]() {
            return 2;
        }
    }
    console.log(1+ab);
    console.log('1'+ab);
    

    可以看到,Symbol.toPrimitive方法在转换基本类型的时候优先级最高。

    相关文章

      网友评论

          本文标题:es6 — Symbol - 2020-06-08

          本文链接:https://www.haomeiwen.com/subject/vujrtktx.html