在 JavaScript 中定义只读属性

Question

给定一个对象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/
我只是不确定这是否是最简单/最顺畅/最合适的方法......

Answer 1

您可以改用属性描述符的writable 属性，这样就不需要get 访问器：

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

如 cmets 中所述，writable 选项默认为 false，因此在这种情况下您可以省略它：

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

这是 ECMAScript 5，因此无法在旧版浏览器中运行。

Answer 2

在新浏览器或 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'

Answer 3

由于旧浏览器（向后兼容），我不得不想出属性的访问器函数。我使它成为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.

希望对你有帮助。

Answer 4

我试过了，效果很好……

element.readOnly = "readOnly"  (then .readonly-> true)
element.readOnly = ""  (then .readonly-> false)

Answer 5

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

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)