Геттеры и сеттеры объектов

В ECMAScript 5 (2009) были добавлены, так называемые, геттеры и сеттеры.

Геттеры и сеттеры позволяют определять специальные методы для доступа к объекту (вычисляемые свойства).

Геттер JavaScript (Ключевое слово get)

В следующем примере используется свойство lang, чтобы получить значение свойства language:


// Создать объект
var person = {
   firstName: "John",
   lastName : "Doe",
   language : "en",
   get lang() {
      return this.language;
   }
};

// Вывести данные объекта при помощи геттера
document.getElementById("demo").innerHTML = person.lang; 

Сеттер JavaScript (Ключевое слово set)

В следующем примере используется свойство lang, чтобы установить значение для свойства language:


var person = {
   firstName: "John",
   lastName : "Doe",
   language : "",
   set lang(lang) {
      this.language = lang;
   }
};

// Установить свойство объекта при помощи сеттера
person.lang = "en";

// Вывести данные объекта
document.getElementById("demo").innerHTML = person.language; 

Функция или геттер?

В чем разница между следующими двумя примерами?

Пример 1


var person = {
   firstName: "John",
   lastName : "Doe",
   fullName : function() {
    return this.firstName + " " + this.lastName;
  }
};

// Вывести данные объекта при помощи метода
document.getElementById("demo").innerHTML = person.fullName(); 

Пример 2


var person = {
   firstName: "John",
   lastName : "Doe",
   get fullName() {
     return this.firstName + " " + this.lastName;
  }
};

// Вывести данные объекта при помощи геттера
document.getElementById("demo").innerHTML = person.fullName; 

В примере 1 доступ к методу fullName осуществляется как к функции: person.fullName().

В примере 2 доступ к методу fullName осуществляется как к свойству: person.fullName.

Таким образом, во втором примере используется более простой синтаксис.

Качество данных

При использовании геттеров и сеттеров JavaScript может обеспечить лучшее качество данных.

Использование свойства lang в следующем примере позволяет получить значение свойства language, преобразованное в верхний регистр:


// Создаем объект
var person = {
  firstName: "John",
  lastName : "Doe",
  language : "en",
  get lang() {
    return this.language.toUpperCase();
  }
};

// Выводим данные объекта при помощи геттера
document.getElementById("demo").innerHTML = person.lang; 

Использование свойства lang в следующем примере позволяет сохранить значение свойства language, предварительно преобразовав его в верхний регистр:


var person = {
   firstName: "John",
   lastName : "Doe",
   language : "",
   set lang(lang) {
     this.language = lang.toUpperCase();
   }
};

// Задаем значение свойства объекта при помощи сеттера
person.lang = "en";

// Выводим данные объекта
document.getElementById("demo").innerHTML = person.language; 

Зачем нужны геттеры и сеттеры?

  • Мы получаем более простой синтаксис
  • Мы можем использовать одинаковый синтаксис для свойств и методов
  • Мы можем обеспечить более качественные данные
  • Мы можем выполнять действия "за сценой"

Пример счетчика


var obj = {
  counter : 0,
  get reset() {
    this.counter = 0;
  },
   get increment() {
     this.counter++;
   },
   get decrement() {
    this.counter--;
  },
  set add(value) {
    this.counter += value;
  },
  set subtract(value) {
    this.counter -= value;
   }
};

// Поиграем со счетчиком
obj.reset;
obj.add = 5;
obj.subtract = 1;
obj.increment;
obj.decrement;

Object.defineProperty()

Метод Object.defineProperty() также можно использовать для добавления геттеров и сеттеров:


// Определяем объект
var obj = {counter : 0};

// Определяем геттеры и сеттеры
Object.defineProperty(obj, "reset", {
  get : function () {this.counter = 0;}
});
Object.defineProperty(obj, "increment", {
  get : function () {this.counter++;}
});
Object.defineProperty(obj, "decrement", {
  get : function () {this.counter--;}
});
Object.defineProperty(obj, "add", {
  set : function (value) {this.counter += value;}
});
Object.defineProperty(obj, "subtract", {
  set : function (value) {this.counter -= value;}
});

// Поиграем со счетчиком
obj.reset;
obj.add = 5;
obj.subtract = 1;
obj.increment;
obj.decrement;