setter

基线广泛可用

自 2015年7月起，此特性已在主流浏览器中得到支持，可在大多数设备和浏览器版本中正常使用。

当尝试设置属性时，set 语法将对象属性绑定到要调用的函数。它还可以在类中应用。

本文内容

尝试一下

const language = {
  set current(name) {
    this.log.push(name);
  },
  log: [],
};

language.current = "EN";
language.current = "FA";

console.log(language.log);
// Expected output: Array ["EN", "FA"]

语法

js
{ set prop(val) { /* … */ } }
{ set [expression](val) { /* … */ } }

参数

prop

要绑定到给定函数的属性名。

val

用于保存尝试分配给prop的值的变量的一个别名。

表达式

从 ECMAScript 2015 开始，还可以使用一个计算属性名的表达式绑定到给定的函数。

描述

在 javascript 中，如果试着改变一个属性的值，那么对应的 setter 将被执行。setter 经常和 getter 连用以创建一个伪属性。不可能在具有真实值的属性上同时拥有一个 setter 器。

使用 set 语法时请注意：

它的标识符可以是数字或字符串；
它必须有一个明确的参数（详见 Incompatible ES5 change: literal getter and setter functions must now have exactly zero or one arguments）；
在对象字面量中，不能为一个已有真实值的变量使用 set，也不能为一个属性设置多个 set。 ( { set x(v) { }, set x(v) { } } 和 { x: ..., set x(v) { } } 是不允许的 )

示例

在对象初始化时定义 setter

这将定义一个对象 language 的伪属性current，当current被分配一个值时，将使用该值更新log：

js
const language = {
  set current(name) {
    this.log.push(name);
  },
  log: [],
};

language.current = "EN";
console.log(language.log); // ['EN']

language.current = "FA";
console.log(language.log); // ['EN', 'FA']

请注意，current属性是未定义的，访问它时将会返回 undefined。

用 delete 操作符移除一个 setter

我们可以使用delete操作符移除 setter。

delete language.current;

使用 defineProperty 为当前对象定义 setter

我们可以随时使用 Object.defineProperty() 给一个已经存在的对象添加一个 setter。

js
const o = { a: 0 };

Object.defineProperty(o, "b", {
  set: function (x) {
    this.a = x / 2;
  },
});

o.b = 10; // Runs the setter, which assigns 10 / 2 (5) to the 'a' property
console.log(o.a); // 5

使用计算属性名

js
const expr = "foo";

const obj = {
  baz: "bar",
  set [expr](v) {
    this.baz = v;
  },
};

console.log(obj.baz); // "bar"
obj.foo = "baz"; // run the setter
console.log(obj.baz); // "baz"

规范

ECMAScript® 2027 Language Specification
# sec-method-definitions

浏览器兼容性

启用 JavaScript 以查看此浏览器兼容性表。

参见

帮助改进 MDN

此页面对您有帮助吗？

是否

了解如何参与贡献

此页面最后更新于 2025年7月16日，由 MDN 贡献者更新。

在 GitHub 上查看此页面 • 报告此内容的问题