// не помещается в кофеварку! coffeeMachine.waterAmount = 1000000;
Это ещё ничего, гораздо хуже, что можно наоборот — вылить больше, чем есть:
// и не волнует, было ли там столько воды вообще! coffeeMachine.waterAmount = 1000000;
Так происходит потому, что свойство полностью доступно снаружи.
Чтобы не было таких казусов, нам нужно ограничить контроль над свойством со стороны внешнего кода.
Для лучшего контроля над свойством его делают приватным, а запись значения осуществляется через специальный метод, который называют «сеттер» (setter method).
Типичное название для сеттера — setСвойство, например, в случае с кофеваркой таким сеттером будет метод setWaterAmount:
function CoffeeMachine(power, capacity) { // capacity ёмкость кофеварки var waterAmount = 0;
var WATER_HEAT_CAPACITY = 4200;
function getTimeToBoil() {
return waterAmount * WATER_HEAT_CAPACITY * 80 / power;
}
// "умная" установка свойства this.setWaterAmount = function(amount) {
if (amount < 0) {
throw new Error("Значение должно быть положительным");
}
if (amount > capacity) {
throw new Error("Нельзя залить воды больше, чем " + capacity);
}
waterAmount = amount; };
function onReady() { alert( 'Кофе готов!' );
}
this.run = function() { setTimeout(onReady, getTimeToBoil());
};
}
var coffeeMachine = new CoffeeMachine(1000, 500); coffeeMachine.setWaterAmount(600); // упс, ошибка!
Теперь waterAmount— внутреннее свойство, его можно записать (через сеттер), но, увы, нельзя прочитать.
Для того, чтобы дать возможность внешнему коду узнать его значение, создадим
специальную функцию — «геттер» (getter method).
Геттеры обычно имеют название вида getСвойство, в данном случае getWaterAmount:
function CoffeeMachine(power, capacity) { //...
this.setWaterAmount = function(amount) { if (amount < 0) {
throw new Error("Значение должно быть положительным");
}
if (amount > capacity) {
throw new Error("Нельзя залить воды больше, чем " + capacity);
}
waterAmount = amount; };
this.getWaterAmount = function() { return waterAmount;
};
}
var coffeeMachine = new CoffeeMachine(1000, 500); coffeeMachine.setWaterAmount(450);
alert( coffeeMachine.getWaterAmount() ); // 450
Единый геттер-сеттер
Для большего удобства иногда делают единый метод, который называется так же, как свойство и отвечает и за запись и за чтение.
При вызове без параметров такой метод возвращает свойство, а при передаче параметра — назначает его.
Выглядит это так:
function CoffeeMachine(power, capacity) { var waterAmount = 0;
this.waterAmount = function(amount) {
//вызов без параметра, значит режим геттера, возвращаем свойство if (!arguments.length) return waterAmount;
//иначе режим сеттера
if (amount < 0) {
throw new Error("Значение должно быть положительным");
}
if (amount > capacity) {
throw new Error("Нельзя залить воды больше, чем " + capacity);
}
waterAmount = amount; };
}
var coffeeMachine = new CoffeeMachine(1000, 500);
// пример использования coffeeMachine.waterAmount(450);
alert( coffeeMachine.waterAmount() ); // 450
Единый геттер-сеттер используется реже, чем две отдельные функции, но в некоторых
JavaScript-библиотеках, например jQuery и D3 подобный подход принят на уровне концепта.
Итого
●Для большего контроля над присвоением и чтением значения, вместо свойства делают «функцию-геттер» и «функцию-сеттер», геттер возвращает значение, сеттер — устанавливает.
●Если свойство предназначено только для чтения, то может быть только геттер, только для записи — только сеттер.
●В качестве альтернативы паре геттер/сеттер применяют единую функцию, которая без аргументов ведёт себя как геттер, а с аргументом — как сеттер.
Также можно организовать геттеры/сеттеры для свойства, не меняя структуры кода, через дескрипторы свойств.
Задачи
Написать объект с геттерами и сеттерами
важность: 4
Напишите конструктор Userдля создания объектов:
●С приватными свойствами имя firstNameи фамилия surname.
●С сеттерами для этих свойств.
●С геттером getFullName(), который возвращает полное имя.
Должен работать так:
function User() { /* ваш код */
}
var user = new User(); user.setFirstName("Петя"); user.setSurname("Иванов");
alert( user.getFullName() ); // Петя Иванов
К решению
Добавить геттер для power
важность: 5
Добавьте кофеварке геттер для приватного свойства power, чтобы внешний код мог узнать
мощность кофеварки.
Исходный код:
function CoffeeMachine(power, capacity) { //...
this.setWaterAmount = function(amount) { if (amount < 0) {
throw new Error("Значение должно быть положительным");
}
if (amount > capacity) {
throw new Error("Нельзя залить воды больше, чем " + capacity);
}
waterAmount = amount; };
this.getWaterAmount = function() { return waterAmount;
};
}
Обратим внимание, что ситуация, когда у свойства powerесть геттер, но нет сеттера — вполне обычна.
Здесь это означает, что мощность powerможно указать лишь при создании кофеварки и в дальнейшем её можно прочитать, но нельзя изменить.
К решению
Добавить публичный метод кофеварке
важность: 5
Добавьте кофеварке публичный метод addWater(amount), который будет добавлять воду.
При этом, конечно же, должны происходить все необходимые проверки — на положительность и превышение ёмкости.
Исходный код:
function CoffeeMachine(power, capacity) { var waterAmount = 0;
var WATER_HEAT_CAPACITY = 4200;
function getTimeToBoil() {
return waterAmount * WATER_HEAT_CAPACITY * 80 / power;
}
this.setWaterAmount = function(amount) { if (amount < 0) {
throw new Error("Значение должно быть положительным");
}
if (amount > capacity) {
throw new Error("Нельзя залить больше, чем " + capacity);
}
waterAmount = amount; };
function onReady() { alert( 'Кофе готов!' );
}
this.run = function() { setTimeout(onReady, getTimeToBoil());
};
}
Вот такой код должен приводить к ошибке:
var coffeeMachine = new CoffeeMachine(100000, 400); coffeeMachine.addWater(200); coffeeMachine.addWater(100);
coffeeMachine.addWater(300); // Нельзя залить больше, чем 400 coffeeMachine.run();
К решению
Создать сеттер для onReady
важность: 5
Обычно когда кофе готов, мы хотим что-то сделать, например выпить его.
Сейчас при готовности срабатывает функция onReady, но она жёстко задана в коде:
function CoffeeMachine(power, capacity) { var waterAmount = 0;
var WATER_HEAT_CAPACITY = 4200;
function getTimeToBoil() {
return waterAmount * WATER_HEAT_CAPACITY * 80 / power;
}
this.setWaterAmount = function(amount) { // ... проверки пропущены для краткости waterAmount = amount;
};
this.getWaterAmount = function(amount) { return waterAmount;
};
function onReady() { alert( 'Кофе готов!' );
}
this.run = function() { setTimeout(onReady, getTimeToBoil());
};
}
Создайте сеттер setOnReady, чтобы код снаружи мог назначить свой onReady, вот так:
var coffeeMachine = new CoffeeMachine(20000, 500); coffeeMachine.setWaterAmount(150);
coffeeMachine.setOnReady(function() {
var amount = coffeeMachine.getWaterAmount();
alert( 'Готов кофе: ' + amount + 'мл' ); // Кофе готов: 150 мл });
coffeeMachine.run();
P.S. Значение onReadyпо умолчанию должно быть таким же, как и раньше.
P.P.S. Постарайтесь сделать так, чтобы setOnReadyможно было вызвать не только до, но и после запуска кофеварки, то есть чтобы функцию onReadyможно было изменить в любой момент до её срабатывания.
К решению
Добавить метод isRunning
важность: 5
Из внешнего кода мы хотели бы иметь возможность понять — запущена кофеварка или нет.
Для этого добавьте кофеварке публичный метод isRunning(), который будет возвращать true, если она запущена и false, если нет.