symbol实现

(function() {
    //匿名函数的执行环境具有全局性 所以这里的this指向全局环境
    var root = this;
    console.log(this);
    var symbolPolyfill = function Symbol(description){
        // Symbol 函数前不能使用new命令 不然会报错
        if(this instanceof symbolPolyfill) throw new TypeError('Symbol is not a constructor');

        var descString = description === undefined? undefined: String(description)

        // 要创建一个干净的空对象,应该使用Object.create(null),显式指定null作为它的原型。
        //所以它绝对没有属性,甚至没有构造函数,toString、hasOwnProperty属性
        //注意:因为不是通过 new 的方式实现的,所以 instanceof 的结果自然是 false。
        var symbol = Object.create({
            //当调用 String 方法的时候,如果该对象有 toString 方法,就会调用该 toString 方法,将其转为字符串,然后才生成一个 Symbol 值。
            //这里有个问题 看下面
            toString: function() {
                return `Symbol(${this.__Description__})`;
            }
        });

        //返回一个新的唯一的 Symbol 值,它的内部属性 [[Description]] 值为 descString
        Object.defineProperties(symbol, {
            '__Description__': {
                value: descString,
                writable: false,
                enumerable: false,
                configurable: false
            }
        })

        return symbol;
    }

    root.symbolPolyfill = symbolPolyfill;
})();

Symbol 值可以作为标识符,用于对象的属性名,可以保证不会出现同名的属性。

看着好像没什么,这点其实和【Symbol值可以显式转为字符串】是冲突的,这是因为当我们模拟的所谓 Symbol 值其实是一个有着 toString 方法的 对象,当对象作为对象的属性名的时候,就会进行隐式类型转换,还是会调用我们添加的 toString 方法。

对于 Symbol('foo') 和 Symbol('foo')两个 Symbol 值,虽然描述一样,但是因为是两个对象,所以并不相等,但是当作为对象的属性名的时候,都会隐式转换为 Symbol(foo) 字符串,这个时候就会造成同名的属性。举个例子:

var a = SymbolPolyfill('foo');
var b = SymbolPolyfill('foo');

console.log(a ===  b); // false

var o = {};
o[a] = 'hello';
o[b] = 'hi';

// 第二次赋值会覆盖掉
console.log(o); // {Symbol(foo): 'hi'}

为了防止不会出现同名的属性,毕竟这是一个非常重要的特性,迫不得已,我们需要修改 toString 方法,让它返回一个唯一值,所以【Symbol值可以显式转为字符串】就无法实现了,而且我们还需要再写一个用来生成 唯一值的方法,就命名为 generateName,我们将该唯一值添加到返回对象的 __Name__ 属性中保存下来。

于是修改代码为:

(function() {
    //匿名函数的执行环境具有全局性 所以这里的this指向全局环境
    var root = this;
    
    var generateName = (function() {
        var postfix = 0;
        return function(descString) {
            postfix ++;
            return `@@${descString}_${postfix}`;
        }
    })()

    var symbolPolyfill = function Symbol(description){
        // Symbol 函数前不能使用new命令 不然会报错
        if(this instanceof symbolPolyfill) throw new TypeError('Symbol is not a constructor');

        var descString = description === undefined? undefined: String(description)

        // 要创建一个干净的空对象,应该使用Object.create(null),显式指定null作为它的原型。
        //所以它绝对没有属性,甚至没有构造函数,toString、hasOwnProperty属性
        //注意:因为不是通过 new 的方式实现的,所以 instanceof 的结果自然是 false。
        var symbol = Object.create({
            //当调用 String 方法的时候,如果该对象有 toString 方法,就会调用该 toString 方法,将其转为字符串,然后才生成一个 Symbol 值。
            toString: function() {
                return this.__Name__;
            }
        });

        //返回一个新的唯一的 Symbol 值,它的内部属性 [[Description]] 值为 descString
        Object.defineProperties(symbol, {
            '__Description__': {
                value: descString,
                writable: false,
                enumerable: false,
                configurable: false
            },
            '__Name__': {
                value: generateName(descString),
                writable: false,
                enumerable: false,
                configurable: false
            }
        })

        return symbol;
    }

    root.symbolPolyfill = symbolPolyfill;
})();

测试结果为:

var a = symbolPolyfill('foo');
var b = symbolPolyfill('foo');

console.log(a ===  b); // false

var o = {};
o[a] = 'hello';
o[b] = 'hi';

console.log(o); // Object { "@@foo_1": "hello", "@@foo_2": "hi" }

Symbol 值不能与其他类型的值进行运算,会报错。

+ 操作符为例,当进行隐式类型转换的时候,会先调用对象的 valueOf 方法,如果没有返回基本值,就会再调用 toString 方法,所以我们考虑在 valueOf 方法中进行报错,比如:

var symbol = Object.create({
    valueOf: function() {
        throw new Error('Cannot convert a Symbol value')
    }
})

console.log('1' + symbol); // 报错

看着很简单的解决了这个问题,可是如果我们是显式调用 valueOf 方法呢?对于一个原生的 Symbol 值:

var s1 = Symbol('foo')
console.log(s1.valueOf()); // Symbol(foo)

是的,对于原生 Symbol,显式调用 valueOf 方法,会直接返回该 Symbol 值,而我们又无法判断是显式还是隐式的调用,所以这个我们就只能实现一半,要不然实现隐式调用报错,要不然实现显式调用返回该值,那……我们选择不报错的那个吧,即后者。

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

嗯,无法实现。

有时,我们希望重新使用同一个Symbol值,Symbol.for方法可以做到这一点。它接受一个字符串作为参数,然后搜索有没有以该参数作为名称的Symbol值。如果有,就返回这个Symbol值,否则就新建并返回一个以该字符串为名称的Symbol值。

这个实现类似于函数记忆,我们建立一个对象,用来储存已经创建的 Symbol 值即可。

Symbol.keyFor 方法返回一个已登记的 Symbol 类型值的 key。

遍历 forMap,查找该值对应的键值即可。

完整版如下:

(function() {
    //匿名函数的执行环境具有全局性 所以这里的this指向全局环境
    var root = this;
    
    var generateName = (function() {
        var postfix = 0;
        return function(descString) {
            postfix ++;
            return `@@${descString}_${postfix}`;
        }
    })()

    var symbolPolyfill = function Symbol(description){
        // Symbol 函数前不能使用new命令 不然会报错
        if(this instanceof symbolPolyfill) throw new TypeError('Symbol is not a constructor');

        var descString = description === undefined? undefined: String(description)

        // 要创建一个干净的空对象,应该使用Object.create(null),显式指定null作为它的原型。
        //所以它绝对没有属性,甚至没有构造函数,toString、hasOwnProperty属性
        //注意:因为不是通过 new 的方式实现的,所以 instanceof 的结果自然是 false。
        var symbol = Object.create({
            //当调用 String 方法的时候,如果该对象有 toString 方法,就会调用该 toString 方法,将其转为字符串,然后才生成一个 Symbol 值。
            toString: function() {
                return this.__Name__;
            },
            valueOf: function() {
                return this;
            }
        });

        //返回一个新的唯一的 Symbol 值,它的内部属性 [[Description]] 值为 descString
        Object.defineProperties(symbol, {
            '__Description__': {
                value: descString,
                writable: false,
                enumerable: false,
                configurable: false
            },
            '__Name__': {
                value: generateName(descString),
                writable: false,
                enumerable: false,
                configurable: false
            }
        })

        return symbol;
    }

    var forMap = {};

    Object.defineProperties(symbolPolyfill, {
        'for': {
            value: function(description) {
                var descString = description===undefined? undefined: String(description);
                return forMap[descString]? forMap[descString]: forMap[descString] = symbolPolyfill(descString);
            },
            writable: true,
            enumerable: false,
            configurable: true
        },
        'keyFor': {
            value: function(symbol) {
                for(var key in forMap) {
                    if(forMap[key] === symbol) return key;
                }
            },
            writable: true,
            enumerable: false,
            configurable: true
        }
    })

    root.symbolPolyfill = symbolPolyfill;
})();

参考文章

https://segmentfault.com/a/1190000015262174

posted @ 2021-03-14 11:33  Hhhighway  阅读(154)  评论(0编辑  收藏  举报