Составление полных операторов switch

Операторы switch рекомендуется делать полными, то есть предусматривать все варианты выполнения оператора. Эта задача не такая простая:

Кроме того, в спецификации языка Java предусмотрен обязательный анализ потока выполнения для оператора switch по перечислению, который может приводить к непредвиденным ошибкам во время компиляции:

    enum Colors { RED, GREEN, BLUE }
    String colorString(Color c) {
        switch(c) {
            case RED: return "red";
            case GREEN: return "green";
            case BLUE: return "blue";
        }
    }

Компилятор сообщает:

"Этот метод должен возвращать результат типа String. Обратите внимание, что сообщение об ошибке с отсутствующим вариантом 'default:' в 'switch' не выводится, что может служить причиной данной неполадки".

Это сообщение предупреждает о различных условиях полноты оператора. В спецификации языка Java указано, что оператор switch будет неполным без варианта default, даже если все константы перечисления, известные на данный момент, упомянуты в вариантах case. Это относится к операторам return, а также к окончательному присвоению значений локальным переменным или пустым полям с типом final. Однако при выполнении нижеприведенных рекомендаций это сообщение об ошибке никогда не будет показано.

В параметрах компилятора доступны различные уровни сообщений о неполноте оператора. Далее мы обсудим различные ситуации проектирования, в которых компилятор Java Eclipse использует эти уровни проверки.

Применение варианта "default:"

В идеале все операторы switch должны иметь полезную ветвь default, которая с применением "разумной" стратегии обрабатывает все варианты, не перечисленные явным образом. Конечно, часто такую стратегию трудно или даже невозможно найти, но разумная реализация default будет наилучшим решением.

Рекомендация: предупреждения компилятора о том, что в операторе switch отсутствует вариант default, напоминают о том, что реализация default по умолчанию улучшает код.

Если компилятор предупреждает о том, что отсутствует вариант default, но по умолчанию как раз требуется ничего не делать, это следует отразить в документации.

Рекомендация: : если стратегия по умолчанию как раз подразумевает, что никаких действий не требуется, добавьте метку default:, в которой в комментарии указано, почему в этом операторе switch это оправдано. Тем самым компилятору сообщается, что вариант default не был забыт.

Если никакая разумная реализация невозможна, то оптимальным вариантом будет предотвращение ошибок далее по ходу выполнения программы из-за непредвиденного значения, то есть требуется как можно раньше сообщить об ошибке во время выполнения.

Рекомендация: если невозможна разумная реализация и если стратегия "ничего не делать" тоже приводит к ошибкам, добавьте блок default:, который генерирует исключительную ситуации и (или) сообщает об ошибке.

Все операторы switch можно отнести к одной из трех перечисленных категорий. Это означает, что предупреждения компилятора об отсутствии варианта default - это во всех случаях хорошая стратегия.

Обработка всех констант перечисления

Выполнение оператора switch по перечислению желательно реализовать так, чтобы для каждой константы перечисления был соответствующий вариант case.

Рекомендация: предупредить об отсутствии в операторе switch варианта case для какой-либо константы перечисления позволяет опция Сообщать даже при наличии варианта 'default'.

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

Рекомендация: для того чтобы включить предупреждение для части операторов switch, включите это предупреждение глобально и затем найдите те операторы, где некоторые константы перечисления можно пропустить, поскольку они обрабатываются блоком default. Для таких операторов switch используйте комментарий с тегом '//$CASES-OMITTED$' для документирования своего решения:
    String colorString2(Color c) {
        switch(c) {
        case RED: return "red";
        case GREEN: return "green";
            //$CASES-OMITTED$
        default:
        	return "unknown color";
        }
    }

Совет: если компилятор выдает сообщение: "Константа перечисления BLUE должна иметь соответствующую метку case в операторе switch по перечислению Color", то будет доступно быстрое исправление для вставки комментария с тегом.

Сводка

Эти замечания показывают, что лучше всего включить все необязательные предупреждения компилятора о неполных операторах switch, а там, где неполный оператор подразумевается по смыслу задачи, задокументировать пустой блок default и добавить комментарий с тегом //$CASES-OMITTED$. При выполнении этих рекомендаций будут показываться предупреждения (или ошибки), если какая-то ветвь случайно упущена, в том числе и когда в перечисление добавляются новые константы. Все исключения из этого правила будут задокументированы в коде и не будут вызывать предупреждения.

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

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