在 JavaScript 中定义只读属性

IT技术 javascript
2021-03-09 14:16:19

给定一个 object obj,我想定义一个只读属性'prop'并将其值设置为val这是正确的方法吗?

Object.defineProperty( obj, 'prop', {
    get: function () {
        return val;
    }
});

结果应该是(对于val = 'test'):

obj.prop; // 'test'
obj.prop = 'changed';
obj.prop; // still 'test' since it's read-only

顺便说一句,此方法有效:http : //jsfiddle.net/GHMjN/
我只是不确定这是否是最简单/最流畅/最正确的方法...

5个回答

您可以改为使用writable属性描述符的属性,这样就不需要get访问器了:

var obj = {};
Object.defineProperty(obj, "prop", {
    value: "test",
    writable: false
});

如评论中所述,该writable选项默认为,false因此在这种情况下您可以省略它:

Object.defineProperty(obj, "prop", {
    value: "test"
});

这是 ECMAScript 5,所以不能在旧浏览器中工作。

请注意,最终对象/数组的subProperties仍然可以修改在这种情况下,只有“prop”键不能重新分配。
2021-04-20 14:16:19
根据 MDN 文档,Object.defineProperty(obj, "prop", {value:"test"});相当于上面的代码,因为 writable 默认设置为 false。
2021-05-09 14:16:19
我不确定我的代码和你的代码是否在“外部”产生完全相同的结果,但你的方法无疑是更合适的方法。
2021-05-15 14:16:19

在新的浏览器或node.js 中,可以使用Proxy创建只读对象。

var obj = {
    prop: 'test'
}

obj = new Proxy(obj ,{
    setProperty: function(target, key, value){
        if(target.hasOwnProperty(key))
            return target[key];
        return target[key] = value;
    },
    get: function(target, key){
        return target[key];
    },
    set: function(target, key, value){
        return this.setProperty(target, key, value);
    },
    defineProperty: function (target, key, desc) {
        return this.setProperty(target, key, desc.value);
    },
    deleteProperty: function(target, key) {
        return false;
    }
});

您仍然可以为该对象分配新属性,并且它们也是只读的。

例子

obj.prop
// > 'test'

obj.prop = 'changed';
obj.prop
// > 'test'

// New value
obj.myValue = 'foo';
obj.myValue = 'bar';

obj.myValue
// > 'foo'

由于旧的浏览器(向后兼容性),我不得不为属性提出访问器函数。我把它作为bob.js 的一部分

var obj = { };
//declare read-only property.
bob.prop.namedProp(obj, 'name', 'Bob', true);
//declare read-write property.
bob.prop.namedProp(obj, 'age', 1);

//get values of properties.
console.log(bob.string.formatString('{0} is {1} years old.', obj.get_name(), obj.get_age()));
//set value of read-write property.
obj.set_age(2);
console.log(bob.string.formatString('Now {0} is {1} years old.', obj.get_name(), obj.get_age()));

//cannot set read-only property of obj. Next line would throw an error.
// obj.set_name('Rob');

//Output:
//========
// Bob is 1 years old.
// Now Bob is 2 years old.

我希望它有帮助。

澄清一下:我认为我们在谈论两件不同的事情。您可能希望在使用包装器的同时保持真实对象不变;但我建议更改真实对象并具有表示属性的函数。因为为了向后兼容,旧式 JavaScript 属性可能被视为字段。因此,您需要为它设置访问器(函数)(另外我建议从真实对象中删除传统的 JS 属性,从而完全控制这些属性)。至于包装器,这也不错,但与我的方法不同。
2021-04-25 14:16:19
等等,.namedProp(obj, 'foo'), 创建.get_foo(),/.set_foo()在对象本身上?那不是很有效率。我想我会使用包装器,例如X(obj).set('foo')/ X(obj).get('foo')
2021-05-09 14:16:19

我试过了,它有效......

element.readOnly = "readOnly"  (then .readonly-> true)
element.readOnly = ""  (then .readonly-> false)
在代码片段中提供您的答案。现在还不够清楚
2021-04-25 14:16:19

就我而言,我需要一个对象,我们只能在其中设置其属性一次。
所以当有人试图改变已经设置的值时,我让它抛出一个错误。

class SetOnlyOnce {
    #innerObj = {}; // private field, not accessible from outside

    getCurrentPropertyName(){
        const stack = new Error().stack; // probably not really performant method
        const name = stack.match(/\[as (\w+)\]/)[1];
        return name;
    }

    getValue(){
        const key = this.getCurrentPropertyName();

        if(this.#innerObj[key] === undefined){
            throw new Error('No global param value set for property: ' + key);
        }

        return this.#innerObj[key];
    }

    setValue(value){
        const key = this.getCurrentPropertyName();

        if(this.#innerObj[key] !== undefined){
            throw new Error('Changing global parameters is prohibited, as it easily leads to errors: ' + key)
        }

        this.#innerObj[key] = value;
    }
}


class GlobalParams extends SetOnlyOnce {
    get couchbaseBucket() { return this.getValue()}
    set couchbaseBucket(value){ this.setValue(value)}

    get elasticIndex() { return this.getValue()}
    set elasticIndex(value){ this.setValue(value)}   
}

const _globalParams = new GlobalParams();

_globalParams.couchbaseBucket = 'some-bucket';
_globalParams.elasticIndex = 'some-index';

console.log(_globalParams.couchbaseBucket)
console.log(_globalParams.elasticIndex)

_globalParams.elasticIndex = 'another-index'; // ERROR is thrown here
console.log(_globalParams.elasticIndex)