Совершенный код: интерфейсы модулей

~2 минуты 91

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

Представим, что мы пишем веб-сервис, который умеет конвертировать валюты. В этом конвертере присутствует описание того, какая валюта в какую может конвертироваться, и по какому курсу:

// currency.js
export const rates = {
  eur: {
    usd: 1.3
    rub: 80.99
  },
  usd: {
    eur: 1.4
  },
  rub: {
    usd: 72.10
  },
};

Остальные части программы используют эту информацию для своих вычислений и проверок:

import rates from './currency.js';

// Обработчик, который возвращает страницу с указанием рейта
// по конкретной паре валют
const getRate = (req, res) => {
  // Параметры из адреса запрошенной страницы
  const { from, to } = req.query;
  const rate = rates[from][to];

  // Тут формируется HTML и отправляется пользователю в браузер
  res.render('rate.pug', { rate });
}

Код получился простой, но ненадежный. Если пользователь выполнит запрос на рейт валют, которых нет в системе, возникнет ошибка доступа к объекту:

// Boom! rates['gdr'] === undefined
const rate = rates['gbr']['usd'];

Даже если первая валюта есть, то при отсутствии второй в константе rate окажется undefined, что может быть неверным (зависит от приложения).

Перепишем код и избавимся от ошибки:

import rates from './currency.js';

const getRate = (req, res) => {
  const { from, to } = req.query;
  const rate = rates[from] ? rates[from][to] : null;
  // Версия с lodash
  // const rate = _.get(rates, [from, to], null);

  res.render('rate.pug', { rate });
}

Ошибка больше не возникнет, но решение все еще плохое. Работа с rates наверняка не ограничится одним обработчиком. С ростом приложения рейты начнут использоваться повсеместно, а это значит, что и обработку ошибок придется делать в каждом месте. Кроме того, любое изменение структуры данных также потребует переписывания всех мест, где они используются.

Подписывайтесь на канал Кирилла Мокевнина в Telegram — чтобы узнать больше о программировании и профессиональном пути разработчика

Указанные проблемы типичны для всех ситуаций, когда работа с данными идет напрямую без создания хотя бы минимальной абстракции (функций) для доступов к данным. Решается все очень просто, нужно лишь добавить функцию в модуль currency.js.

// currency.js
// Данные не экспортируются наружу
// к ним нельзя получить прямой доступ
const rates = {
  eur: {
    usd: 1.3
    rub: 80.99
  },
  usd: {
    eur: 1.4
  },
  rub: {
    usd: 72.10
  },
};

export const getRate = (from, to) => {
  if (!_.has(rates, [from, to])) {
    throw new Error(`Unknown rate: from '${from}', to '${to}'.`);
  }
  return rates[from][to];
}