20 лютого 2024 р.

Нестандартні помилки, розширення Error

Коли ми щось розробляємо, нам часто потрібні власні класи помилок, щоб відображати конкретні речі, які можуть піти не так у наших програмах. Для помилок у мережевих операціях нам може знадобитися HttpError, для операцій з базою даних DbError, для пошуку операцій NotFoundError тощо.

Наші помилки повинні підтримувати основні властивості помилок, такі як message, name і, бажано, stack. Але вони також можуть мати інші властивості, наприклад, об’єкти HttpError можуть мати властивість statusCode зі значенням, як-от 404, 403 або 500.

JavaScript дозволяє використовувати throw з будь-яким аргументом, тому технічно наші спеціальні класи помилок не повинні успадковуватись від Error. Але якщо ми успадкуємо, то стає можливим використовувати obj instanceof Error для ідентифікації об’єктів помилки. Тому краще успадкувати від нього.

У міру розвитку програми наші власні помилки, природньо, утворюють ієрархію. Наприклад, HttpTimeoutError може успадковуватися від HttpError тощо.

Розширення Error

Як приклад, давайте розглянемо функцію readUser(json), яка повинна читати JSON з даними користувача.

Ось приклад того, як може виглядати валідний json:

let json = `{ "name": "Іван", "age": 30 }`;

Всередині ми будемо використовувати JSON.parse. Якщо він отримує неправильний json, він викидає SyntaxError. Але навіть якщо json синтаксично правильний, це не означає, що це валідний користувач, чи не так? У ньому може не бути необхідних нам даних. Наприклад, він може не мати властивостей name та age, які є важливими для наших користувачів.

Наша функція readUser(json) не тільки читатиме JSON, але й перевірятеме (“валідуватиме”) дані. Якщо немає обов’язкових полів або формат неправильний, це помилка. І це не SyntaxError, оскільки дані синтаксично правильні, а інший тип помилки. Ми назвемо його ValidationError і створимо для нього окремий клас. Подібна помилка також повинна містити інформацію про поле, що порушує правила.

Наш клас ValidationError має успадковуватись від класу Error.

Клас Error є вбудованим, але ось його приблизний код, щоб ми могли зрозуміти, що ми розширюємо:

// "Псевдокод" для вбудованого класу Error, визначеного самим JavaScript
class Error {
  constructor(message) {
    this.message = message;
    this.name = "Error"; // (різні назви для різних вбудованих класів помилок)
    this.stack = <call stack>; // нестандартна властивість, але більшість середовищ її підтримує
  }
}

Тепер давайте успадкуємо від нього наш ValidationError і спробуємо його в дії:

class ValidationError extends Error {
  constructor(message) {
    super(message); // (1)
    this.name = "ValidationError"; // (2)
  }
}

function test() {
  throw new ValidationError("Упс!");
}

try {
  test();
} catch(err) {
  alert(err.message); // Упс!
  alert(err.name); // ValidationError
  alert(err.stack); // список вкладених викликів з номерами рядків для кожного
}

Зверніть увагу: у рядку (1) ми викликаємо батьківський конструктор. JavaScript вимагає від нас викликати super у дочірньому конструкторі, це обов’язково. Батьківський конструктор встановлює властивість message.

Батьківський конструктор також встановлює для властивості name значення "Error", тому в рядку (2) ми скидаємо його до потрібного значення.

Давайте спробуємо використати його в readUser(json):

class ValidationError extends Error {
  constructor(message) {
    super(message);
    this.name = "ValidationError";
  }
}

// Usage
function readUser(json) {
  let user = JSON.parse(json);

  if (!user.age) {
    throw new ValidationError("No field: age");
  }
  if (!user.name) {
    throw new ValidationError("No field: name");
  }

  return user;
}

// Робочий приклад із try..catch

try {
  let user = readUser('{ "age": 25 }');
} catch (err) {
  if (err instanceof ValidationError) {
    alert("Invalid data: " + err.message); // Invalid data: No field: name
  } else if (err instanceof SyntaxError) { // (*)
    alert("JSON Syntax Error: " + err.message);
  } else {
    throw err; // невідома помилка, прокинемо її далі (**)
  }
}

Блок try..catch у коді вище обробляє як нашу ValidationError, так і вбудовану SyntaxError з JSON.parse.

Будь ласка, подивіться, як ми використовуємо instanceof для перевірки певного типу помилки в рядку (*).

Ми також можемо використати err.name, ось так: