Чистый код. Создание, анализ и рефакторинг

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

Используйте исключения вместо кодов ошибок

В далеком прошлом многие языки программирования не поддерживали механизма обработки исключений. В таких языках возможности обработки и получения информации об ошибках были ограничены. Программа либо устанавливала флаг ошибки, либо возвращала код, который проверялся вызывающей стороной. Оба способа продемонстрированы в листинге 7.1.

Листинг 7.1. DeviceController.java

public class DeviceController {

  ...

  public void sendShutDown() {

    DeviceHandle handle = getHandle(DEV1);

    // Проверить состояние устройства

    if (handle != DeviceHandle.INVALID) {

      // Сохранить состояние устройства в поле записи

      retrieveDeviceRecord(handle);

      // Если устройство не приостановлено, отключить его

      if (record.getStatus() != DEVICE_SUSPENDED) {

        pauseDevice(handle);

        clearDeviceWorkQueue(handle);

        closeDevice(handle);

      } else {

        logger.log("Device suspended.  Unable to shut down");

      }

    } else {

      logger.log("Invalid handle for: " + DEV1.toString());

    }

  }

  ...

}

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

В листинге 7.2 представлен тот же код с выдачей исключений в методах, способных обнаруживать ошибки.

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

Листинг 7.2. DeviceController.java (с исключениями)

public class DeviceController {

  ...

  public void sendShutDown() {

    try {

      tryToShutDown();

    } catch (DeviceShutDownError e) {

      logger.log(e);

    }

  }

  private void tryToShutDown() throws DeviceShutDownError {

    DeviceHandle handle = getHandle(DEV1);

    DeviceRecord record = retrieveDeviceRecord(handle);

    pauseDevice(handle);

    clearDeviceWorkQueue(handle);

    closeDevice(handle);

  }

  private DeviceHandle getHandle(DeviceID id) {

    ...

    throw new DeviceShutDownError("Invalid handle for: " + id.toString());

    ...

  }

  ...

}

Начните с написания команды try-catch-finally

У исключений есть одна интересная особенность: они определяют область видимости в вашей программе. Размещая код в секции try команды try-catch-finally, вы утверждаете, что выполнение программы может прерваться в любой точке, а затем продолжиться в секции catch.

Блоки try в каком-то отношении напоминают транзакции. Секция catch должна оставить программу в целостном состоянии, что бы и произошло в секции try. По этой причине написание кода, который может инициировать исключения, рекомендуется начинать с конструкции try-catch-finally. Это поможет вам определить, чего должен ожидать пользователь кода, что бы ни произошло в коде try.

Допустим, требуется написать код, который открывает файл и читает из него сериализованные объекты.

Начнем с модульного теста, который проверяет, что при неудачном обращении к файлу будет выдано исключение:

@Test(expected = StorageException.class)

public void retrieveSectionShouldThrowOnInvalidFileName() {

  sectionStore.retrieveSection("invalid - file");

}

Для теста необходимо создать следующую программную заглушку:

public List retrieveSection(String sectionName) {

  // Пусто, пока не появится реальная реализация