Книга: JavaScript. Подробное руководство, 6-е издание

9.8.2. Определение неизменяемых классов

9.8.2. Определение неизменяемых классов

Помимо возможности делать свойства неперечислимыми, стандарт ECMAScript 5 позволяет делать свойства доступными только для чтения, что может быть довольно удобно при создании классов, экземпляры которых не должны изменяться. В примере 9.18 приводится неизменяемая версия класса Range, который использует эту возможность, применяя функции Object.defineProperties() и Object.create(). Кроме того, функция Object.defineProperties() используется в нем также для добавления свойств в объект-прототип класса, что делает методы экземпляров недоступными для перечисления, подобно методам встроенных классов. Но и это еще не все: определяемые в примере методы экземпляров создаются доступными только для чтения и не могут быть удалены, что исключает возможность динамического изменения класса. Наконец, в примере 9.18 использован один интересный трюк - при вызове без ключевого слова new функция-конструктор класса действует как фабричная функция.

Пример 9.18. Неизменяемый класс со свойствами и методами, доступными только для чтения

// Эта функция может работать и без ключевого слова 'new': она одновременно
// является и конструктором, и фабричной функцией
function Range(from,to) {
  // Дескрипторы свойств from и to, доступных только для чтения,
  var props = {
    from: {value:from, enumerable:true,writable:false,configurable:false},
    to: {value:to, enumerable:true, writable:false, configurable:false}
  };
  if (this instanceof Range) // Если вызвана как конструктор
    Object.defineProperties(this, props): // Определить свойства
  else // Иначе как фабричная функция
    return Object.create(Range.prototype, // Создать и вернуть новый
                                  props): // объект Range со свойствами
}
// Если добавлять свойства в объект Range.prototype тем же способом, можно будет
// определить атрибуты этих свойств. Поскольку мы не указываем атрибуты enumerable,
// writable и configurable, они по умолчанию получают значение false.
Object.defineProperties(Range.prototype, {
  includes: {
    value: function(x) { return this.from <= x && x <= this.to: }
  ),
  foreach: {
    value: function(f) {
    for(var x = Math.ceil(this.from); x <= this.to; x++) f(x);
    }
  },
  toString: {
    value: function() { return "(” + this, from + "..." + this, to + }
  }
});

Для определения неизменяемых и неперечислимых свойств в примере 9.18 используются функции Object.defineProperties() и Object.create(). Они предоставляют широкие возможности, но необходимость определять для них объекты дескрипторов свойств может сделать программный код более сложным для чтения. Чтобы избежать этого, можно определить вспомогательные функции для изменения атрибутов свойств, которые уже были определены. Две такие вспомогательные функции демонстрируются в примере 9.19.

Пример 9.19/ Вспомогательные функции для работы с дескрипторами свойств

// Делает указанные (или все) свойства объекта о
// недоступным для записи и настройки,
function freezeProps(o) {
  var props = (arguments.length == 1) // Если один аргумент,
     ? Object.getOwnPropertyNames(o) // изменить все свойства,
     : Array.prototype.splice.call(arguments, 1);  // иначе только указанные
  props.forEach(function(n) { // Делает каждое свойство ненастраиваемым
    // и доступным только для чтения
    // Пропустить ненастраиваемые свойства
    if (!Object.getOwnPropertyDescriptor(o,n).configurable) return:
    Object.defineProperty(o, n, { writable: false, configurable: false });
  }):
  return о; // Чтобы можно было продолжить работу с объектом о
}
// Делает неперечислимыми указанные (или все) свойства объекта о,
// если они доступны для настройки,
function hideProps(o) {
  var props = (arguments.length == 1) // Если один аргумент,
    ? Object.getOwnPropertyNames(o) // изменить все свойства,
    : Array.prototype.splice.call(arguments, 1);
  // иначе только указанные
  props.forEach(function(n) { // Скрыть каждое от цикла for/in
    // Пропустить ненастраиваемые свойства
    if (!Object.getOwnPropertyDescriptor(o,n).configurable) return:
    Object.defineProperty(o, n, { enumerable: false });
  }):
  return o;
}

Функции Object.defineProperty() и Object.defineProperties() могут использоваться и для создания новых свойств, и для изменения атрибутов уже существующих свойств. При создании новых свойств все опущенные атрибуты по умолчанию принимают значение false. Однако при изменении атрибутов уже существующих свойств опущенные атрибуты не изменяются. Например, в функции hideProps() выше указывается только атрибут enumerable, потому что функция должна изменять только его.

С помощью этих двух функций можно писать определения классов с использованием преимуществ ECMAScript 5, без существенного изменения привычного стиля определения классов. В примере 9.20 приводится определение неизменяемого класса Range, в котором используются наши вспомогательные функции.

Пример 9.20. Более простое определение неизменяемого класса

function Range(from, to) { // Конструктор неизменяемого класса Range
  this.from = from;
  this.to = to;
  freezeProps(this); // Сделать свойства неизменяемыми
}
Range.prototype = hideProps({ // Определить неперечислимые свойства прототипа
  constructor: Range,
  includes: function(x) { return this.from <= x && x <= this.to; },
  foreach: function(f) {for(var x=Math.ceil(this.from);x<=this.to;x++) f(x);},
  toString: function() { return "(" + this.from + "..." + this.to + ")"; }
});

Оглавление книги