Java Code Style: как правильно оформлять код Java

Форматирование на практике

Стиль не играет роли для компьютера, но важен для чтения кода человеком. Наше зрение устроено так, что сперва получает и анализирует образы, а только затем мы вдаёмся в детали. А если блоки исходного текста унифицированы, разработчик понимает, что перед ним за конструкция, даже не вникая в сам код.

Видя такую конструкцию, программист сразу же понимает, что это if … else. Он прочитает это мгновенно и пойдёт изучать код дальше. А если глазу попадается что-то отличающееся от привычного, чтение сразу переходит в медленный побуквенный режим. Вот здесь, например, потребуется детально изучить код, чтобы понять его смысл:

Если стиль форматирования меняется от конструкции к конструкции, это затрудняет считывание паттернов — мы спотыкаемся глазом на каждой нестандартно написанной строчке.

Подключение правил в IDE

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

Один из популярных наборов правил по оформлению кода для Java написала компания Google. Он называется Google Java Style Guide и доступен на GitHub. Вы можете без труда установить его в любимую IDE, с которой работаете. Для примера рассмотрим, как это сделать в среде разработки JetBrains IntelliJ IDEA:

• Скачайте файл intellij-java-google-style.xml c правилами форматирования с GitHub.
• Откройте IntelliJ IDEA, зайдите в настройки File → Settings… (Ctrl + Alt + S) и выберите загрузку файла в пункте Scheme, как на скриншоте:

• В диалоговом меню выберите скачанный файл и в поле Scheme выберите GoogleStyle. Затем сохраните изменения, нажав Apply/OK.

Теперь при форматировании будут использоваться правила Java Google Style.

Code Style на практике

Теперь разберём основные правила, которые есть в Code Style, и как их использовать в ваших рабочих проектах.

1. Название файла должно совпадать с именем главного класса в нём

Классы в java располагаются в отдельных файлах расширения.java, и название файла строго должно соответствовать имени класса, включая регистр.

2. Названия классов и интерфейсов

Классы и интерфейсы именуются с большой буквы. Если имя состоит из нескольких слов, то каждое слово также начинается с большой буквы. Подчёркивания, тире не используются. Такой стиль нейминга называется UpperCamelCase.

Класс принято называть существительным: Car, Bird, ArrayList, Book. Возможно добавлять уточняющее прилагательное ImmutableList.

Интерфейс, как и класс, может быть существительным: List, Set, Map. А также прилагательным, если указывает на свойство: Readable, Сomparable, Closable.

Отдельно стоить отметить классы тестов, к ним принято добавлять слово Test в окончании: HashTest, HashIntegrationTest

3. Названия методов

Методы именуются со строчной (маленькой) буквы; если имя состоит из нескольких слов, то каждое последующее слово начинается с большой буквы. Подчёркивания, тире не используются. Такой стиль нейминга называется lowerCamelCase.

Методы — это действия, поэтому их принято называть глаголами: sendMessage (), stop (), parse (), add ()

Отдельно можно отменить геттеры и сеттеры. Название метода геттера формируется из названия переменной и префикса get. Если переменная length, то геттер: getLength (). Если переменная типа boolean и названа isAlive, то геттер будет также называться isAlive (), являясь ответом на вопрос в названии метода.

Сеттеры формируются по такому же принципу, но с префиксом set. Продолжая примеры выше: для length сеттер будет setLength (). Для переменной типа boolean isAlive, сеттер будет без приставки setAlive ().

4. Названия переменных

Переменные именуются со строчной (маленькой) буквы; если имя состоит из нескольких слов, то каждое последующее слово начинается с большой буквы. Подчёркивания, тире не используются. Такой стиль нейминга называется lowerCamelCase.

Имена переменных в общем случае — это существительные либо составные существительные с добавлением прилагательных.

Данные правила относятся к локальным переменным (внутри методов), параметрам класса, а также к не статическим константам.

5. Названия констант

Константы именуются в стиле SNAKE_CASE, то есть слова разделены нижним подчёркиванием и все буквы прописные (большие)

Константами считаются static final поля, но не все. Поле должно быть примитивом, String или иммутабельным классом. То есть параметры класса константы не должны иметь возможности изменяться, а его методы — иметь побочные эффекты, влияющие на другие классы. Элементы Enum тоже являются константами.

static final int NUMBER = 5; //примитив
enum SomeEnum { ENUM_CONSTANT } // enum
static final ImmutableList<String> NAMES = ImmutableList.of("Ed", "Ann"); // неизменяемый список, с неизменяемыми элементами String
static final ImmutableMap<String, Integer> AGES = ImmutableMap.of("Ed", 35, "Ann", 32); // неизменяемый Map, с неизменяемыми элементами String

static String nonFinal = "non-final"; // не final
final String nonStatic = "non-static"; // не статична
static final Set<String> mutableCollection = new HashSet<String>(); // мы можем изменять содержимое Set
static final ImmutableSet<SomeMutableType> mutableElements = ImmutableSet.of(mutable); // изменить количество элементов в коллекции нет возможности, но менять состояние самих элементов коллекции есть возможность
static final String[] nonEmptyArray = {"these", "can", "change"}; // поменять элементы массива возможно

Как и у переменных, названия констант — это существительные либо составные существительные с добавлением прилагательных.

6. Не используйте транслитерацию

Для наименования методов, переменных, классов используйте только английский язык. Использование английского — это принятый стандарт, чтобы ваш код был всем понятен. Транслит намного хуже читается, а если кто-то не знаком с русским, он и вовсе не поймёт смысл наименования. Если затрудняетесь в выборе названия, воспользуйтесь гугл-переводчиком. Так, кстати, вы пополните свой словарный запас.

7. Фигурные скобки

Фигурная скобка открывается на той же строке, что и код перед ней.

public static void main(String[] args) {
 System.out.println("Hello, code style!");
}

Тело условного оператора или цикла всегда размещайте в {}, даже если это одна строка. Так можно избежать ошибок, если попробуете добавить вторую строчку, но забудете заключить её в фигурные скобки.

for (int i = 0; i < 10; i++)
 System.out.println(i);

for (int i = 0; i < 10; i++) {
 System.out.println(i);
}