美文网首页
Symbol简单理解

Symbol简单理解

作者: Carmen_e69d | 来源:发表于2019-02-03 16:30 被阅读0次

    Symbol

    • 概述
    • 作为属性名的symbol
    • 属性名的遍历
    • Symbol的方法
    • 内置的symbol值

    概述

    Symbol的原理:保证每一个属性名都是独一无二的,从根本上防止属性名的冲突。
    symbol表示独一无二的值,是JavaScript的第七种数据类型。

    生成

    Symbol值通过Symbol函数,对象的属性名现在可以有两种类型,一种是原来就有的字符串,另一种就是新增的 Symbol 类型。而Symbol类型的属性名都是独一无二的,保证不会与其他属性名发生冲突。

    let s = Symbol();
    typeof s;//Symbol
    

    <mark>注意</mark>:Symbol函数前不能用new命令,这是因为生成的 Symbol 是一个原始类型的值,不是对象。

    Symbol函数接受参数

    字符串为参数(Symbol实例的描述,在打印时易于区分)

    let s1 = Symbol('foo');
    let s2 = Symbol('bar');
    s1 // Symbol(foo)
    s2 // Symbol(bar)
    s1.toString() // "Symbol(foo)"
    s2.toString() // "Symbol(bar)"
    

    对象为参数

    先调用对象的toString()方法将其转为字符串,然后再生成Symbol值。

    const obj = {
      toString() {
    return 'abc';
      }
    };
    const sym = Symbol(obj);
    sym // Symbol(abc)
    

    <mark>注意</mark>:
    1.Symbol函数的参数只是表示对当前 Symbol 值的描述,因此相同参数的Symbol函数的返回值是不相等的。
    2.Symbol值不能与其他类型的值进行运算
    3.Symbol值可以显式转为字符串
    4.Symbol值可以转为布尔型,但不能转为数值。

    作为属性名的Symbol值

    由于每一个 Symbol 值都是不相等的,这意味着 Symbol 值可以作为标识符,用于对象的属性名,就能保证不会出现同名的属性。这对于一个对象由多个模块构成的情况非常有用,能防止某一个键被不小心改写或覆盖。

    let mySymbol = Symbol();
    let a={};
    a[Symbol]='Hello'//写法一
    Object.defineProperty(a,mySymbol,{ value: 'Hello' });//写法二
    

    <mark>注意</mark>:
    1.Symbol作为对象属性名时,不能用点运算符。(点运算符后面总是字符串)
    2.在对象的内部,使用 Symbol 值定义属性时,Symbol 值必须放在方括号之中。方括号中的属性名代表了Symbol值。
    3.Symbol 值作为属性名时,该属性还是公开属性,不是私有属性。

    魔术字符串

    在代码之中多次出现、与代码形成强耦合的某一个具体的字符串或者数值。

    属性名的遍历

    Symbol 作为属性名,该属性不会出现在for...infor...of循环中,也不会被Object.keys()Object.getOwnPropertyNames()JSON.stringify()返回。但是,它也不是私有属性,有一个Object.getOwnPropertySymbols方法,可以获取指定对象的所有 Symbol 属性名。

    • Object.getOwnPropertySymbols():返回一个数组,成员是当前对象的所有用作属性名的 Symbol 值。
    • Reflect.ownKeys():返回所有类型的键名。
        let obj = {
          [Symbol('my_key')]: 1,
          enum: 2,
          nonEnum: 3
            };
        Reflect.ownKeys(obj)
        //  ["enum", "nonEnum", Symbol(my_key)]
    

    Symbol的方法

    Symbol.for()(重新使用同一个Symbol值)

    它接受一个字符串作为参数,然后搜索有没有以该参数作为名称的 Symbol 值。如果有,就返回这个 Symbol 值,否则就新建并返回一个以该字符串为名称的 Symbol 值。

    let s1 = Symbol.for('foo');
    let s2 = Symbol.for('foo');
    s1 === s2 // true
    

    Symbol.for()不会每次调用就返回一个新的Symbol类型的值,而是会先检查给定的key值是否已经存在,不存在的话才会新建一个值。而Symbol.()方法没有登记机制,所以每次调用都是不同的值。

    Symbol.Keyfor()

    返回一个已登记的Symbol类型的值Key。

    let s1 = Symbol.for("foo");
    Symbol.keyFor(s1) // "foo"
    let s2 = Symbol("foo");
    Symbol.keyFor(s2) // undefined
    

    Singleton 模式

    Singleton模式指的是调用一个类,任何时候返回的都是同一个实例。

    内置的Symbol对象

    Symbol.hasInstance

    对象的该属性指向一个内部方法。当其他对象使用instanceof运算符,判断是否为该对象的实例时,会调用这个方法。比如,foo instanceof Foo在语言内部,实际调用的是Foo[Symbol.hasInstance] (foo)

    Symbol.isConcatSpreadable(默认等于undefined)

    对象的Symbol.isConcatSpreadable属性等于一个布尔值,表示该对象用于Array.prototype.concat()时,是否可以展开。

    //数组的默认行为可以展开
    let arr1 = ['c', 'd'];
    ['a', 'b'].concat(arr1, 'e') // ['a', 'b', 'c', 'd', 'e']
    arr1[Symbol.isConcatSpreadable] // undefined
    
    let arr2 = ['c', 'd'];
    arr2[Symbol.isConcatSpreadable] = false;
    ['a', 'b'].concat(arr2, 'e') // ['a', 'b', ['c','d'], 'e']
    
    
    //数组的对象默认不展开
    let obj = {length: 2, 0: 'c', 1: 'd'};
    ['a', 'b'].concat(obj, 'e') // ['a', 'b', obj, 'e']
    
    obj[Symbol.isConcatSpreadable] = true;
    ['a', 'b'].concat(obj, 'e') // ['a', 'b', 'c', 'd', 'e']
    

    Symbol.species

    对象的Symbol.species属性,指向一个构造函数。创建衍生对象时,会使用该属性。

    class MyArray extends Array {
      static get [Symbol.species]() { return Array; }
    }
    
    const a = new MyArray();
    const b = a.map(x => x);
    
    b instanceof MyArray // false
    b instanceof Array // true
    

    Symbol.match

    对象的Symbol.match属性,指向一个函数。当执行str.match(myObject)时,如果该属性存在,会调用它,返回该方法的返回值。

    String.prototype.match(regexp)
    // 等同于
    regexp[Symbol.match](this)
    
    class MyMatcher {
      [Symbol.match](string) {
       return 'hello world'.indexOf(string);
      }
    }
    
    'e'.match(new MyMatcher()) // 1
    

    Symbol.replace

    对象的Symbol.replace属性,指向一个方法,当该对象被String.prototype.replace方法调用时,会返回该方法的返回值。

    • symbol.replace接受两个参数:第一个参数是replace方法正在作用的对象,第二个参数是替换后的值。

        String.prototype.replace(searchValue, replaceValue)
        // 等同于
        searchValue[Symbol.replace](this, replaceValue)
      

    Symbol.search

    对象的Symbol.search属性,指向一个方法,当该对象被String.prototype.search方法调用时,会返回该方法的返回值。

    String.prototype.search(regexp)
    // 等同于
    regexp[Symbol.search](this)
    
    class MySearch {
    constructor(value) {
    this.value = value;
      }
    [Symbol.search](string) {
    return string.indexOf(this.value);
      }
    }
    'foobar'.search(new MySearch('foo')) // 0
    

    Symbol.split

    对象的Symbol.split属性,指向一个方法,当该对象被String.prototype.split方法调用时,会返回该方法的返回值。

    String.prototype.split(separator, limit)
    // 等同于
    separator[Symbol.split](this, limit)
    
    class MySplitter {
    constructor(value) {
    this.value = value;
      }
    [Symbol.split](string) {
    let index = string.indexOf(this.value);
    if (index === -1) {
      return string;
    }
    return [
      string.substr(0, index),
      string.substr(index + this.value.length)
    ];
      }
    }
    
    'foobar'.split(new MySplitter('foo'))
    // ['', 'bar']
    
    'foobar'.split(new MySplitter('bar'))
    // ['foo', '']
    
    'foobar'.split(new MySplitter('baz'))
    // 'foobar'
    

    Symbol.iterator

    对象的Symbol.iterator属性,指向该对象的默认遍历器方法。
    对象进行for...of循环时,会调用Symbol.iterator方法,返回该对象的默认遍历器。

    class Collection {
      *[Symbol.iterator]() {
      let i = 0;
      while(this[i] !== undefined) {
      yield this[i];
      ++i;
    }
      }
    }
    
    let myCollection = new Collection();
    myCollection[0] = 1;
    myCollection[1] = 2;
    
    for(let value of myCollection) {
      console.log(value);
    }
    // 1
    // 2
    

    Symbol.toPrimitive

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

    • Number:该场合需要转成数值

    • String:该场合需要转成字符串

    • Default:该场合可以转成数值,也可以转成字符串

        let obj = {
        [Symbol.toPrimitive](hint) {
        switch (hint) {
        case 'number':
        return 123;
        case 'string':
        return 'str';
        case 'default':
        return 'default';
        default:
        throw new Error();
          }
           }
        };
      
        2 * obj // 246
        3 + obj // '3default'
        obj == 'default' // true
        String(obj) // 'str'
      

    Symbol.toStringTag

    对象的Symbol.toStringTag属性,指向一个方法。在该对象上面调用Object.prototype.toString方法时,如果这个属性存在,它的返回值会出现在toString方法返回的字符串之中,表示对象的类型。

    // 例一
    ({[Symbol.toStringTag]: 'Foo'}.toString())
    // "[object Foo]"
    
    // 例二
    class Collection {
    get [Symbol.toStringTag]() {
    return 'xxx';
      }
    }
    let x = new Collection();
    Object.prototype.toString.call(x) // "[object xxx]"
    

    Symbol.unscopables

    对象的Symbol.unscopables属性,指向一个对象。<mark>该对象指定了使用with关键字时,哪些属性会被with环境排除。</mark>

    Array.prototype[Symbol.unscopables]
    // {
    //   copyWithin: true,
    //   entries: true,
    //   fill: true,
    //   find: true,
    //   findIndex: true,
    //   includes: true,
    //   keys: true
    // }
    
    Object.keys(Array.prototype[Symbol.unscopables])
    // ['copyWithin', 'entries', 'fill', 'find', 'findIndex', 'includes', 'keys']
    

    <mark>上面代码说明,数组有 7 个属性,会被with命令排除。</mark>

    参考文献

    相关文章

      网友评论

          本文标题:Symbol简单理解

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