Работа в IntelliJ IDEA

В одном из прошлых постов я рассказывал о возможностях отладки Java кода в IDEA. Сегодня перечислю комбинации клавиш и тот функционал, который я использую регулярно. Ничего сверхъестественного, хитрого, заумного и неочевидного не будет. Пожалуй, даже отдельного примера с кодом для этого поста делать не буду. Однако IDEA непрерывно развивается и приятные мелочи появляются с каждым релизом и заслуживают упоминания. Я даже специально не отключаю подсказки на старте приложения и периодически открываю для себя что-то новое.

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

Генерация xsd по xml

JAXB - по моему мнению наиболее удобный и универсальный способ работы с XML в Java. Подробно описывать его сейчас я не буду, да и получилось бы практически ровно то же, что уже есть на отличном сайте Baeldung. JAXB требует от разработчика указать набор классов с аннотациями, а работу по операциям marshall / unmarshall библиотека берет на себя. Однако критически важным является абсолютная точность именования полей классов и значений параметров аннотаций. Ошибки приводят к тому, что часть данных при парсинге проигнорируется, будто бы пришли пустые значения. Чтобы избежать этих ошибок нужно минимизировать ручные операции, заменив их автогенерацией кода. Для этого классы JAXB создают не вручную, а с помощью maven плагина, входным параметром которого является xsd схема. В IDEA тоже есть такой функционал, но начиная с Java 9 он не работает из-за исключения соответствующей утилиты из состава JDK (по крайней мере, на момент публикации). В случае, если источник xml файлов не предоставил нам xsd схемы, можно составить её самостоятельно. Конечно, это потребует определённых предположений и допущений, но этого не избежать. Далее покажу как использовать для этого встроенный функционал IDEA.

• 1. Копируем пример xml файла в проект.

          <?xml version="1.0" encoding="UTF-8"?>
          <subtitles>
              <subtitle id="1">
                  <content>À la volonté du peuple</content>
                  <timecode value="seconds">
                      <start>1</start>
                      <end>5</end>
                  </timecode>
              </subtitle>
              <subtitle id="2">
                  <content>Et à la santé du progrès</content>
                  <timecode value="seconds">
                      <start>6</start>
                      <end>10</end>
                  </timecode>
              </subtitle>
          </subtitles>
          

  2. Далее правая кнопка мыши -> Generate XSD schema from XML file
• 
• Здесь стоит обратить внимание на параметр "Detect Enumeration Limit", из-за которого в схеме появятся типы enumeration из-за того, что в нашем xml файле слишком мало различных значений.

          <!-- subs.xsd -->
          ...
          <xs:element name="content">
              <xs:simpleType>
                  <xs:restriction base="xs:string">
                      <xs:enumeration value="À la volonté du peuple"/>
                      <xs:enumeration value="Et à la santé du progrès"/>
                  </xs:restriction>
              </xs:simpleType>
          </xs:element>
          

  Enumeration в xsd схеме зверь довольно редкий, поэтому этот параметр можно выставить в 0.
• 3. Схема сгенерированная с параметром Detect Enumeration Limit, равным 0

          <?xml version="1.0" encoding="UTF-8"?>
          <xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
                     xmlns:xs="http://www.w3.org/2001/XMLSchema">
              <xs:element name="subtitles" type="subtitlesType"/>
              <xs:complexType name="timecodeType">
                  <xs:sequence>
                      <xs:element type="xs:string" name="start"/>
                      <xs:element type="xs:string" name="end"/>
                  </xs:sequence>
                  <xs:attribute type="xs:string" name="value" use="optional"/>
              </xs:complexType>
              <xs:complexType name="subtitleType">
                  <xs:sequence>
                      <xs:element type="xs:string" name="content"/>
                      <xs:element type="timecodeType" name="timecode"/>
                  </xs:sequence>
                  <xs:attribute type="xs:string" name="id" use="optional"/>
              </xs:complexType>
              <xs:complexType name="subtitlesType">
                  <xs:sequence>
                      <xs:element type="subtitleType" name="subtitle" maxOccurs="unbounded" minOccurs="0"/>
                  </xs:sequence>
              </xs:complexType>
          </xs:schema>
          

  4. Обязательно проводим ревью полученной схемы. В нашем случае меняем типы данных для start, end и id на xs:integer, ведь по характеру данных мы знаем, что это числовые значения, и в классах JAXB нам бы не хотелось видеть полей наподобие "String start", чтобы потом осуществлять преобразования явно в коде приложения.

          <xs:sequence>
              <xs:element type="xs:integer" name="start"/>
              <xs:element type="xs:integer" name="end"/>
          </xs:sequence>
          

  5. В общем, схема готова, можно приступать к работе с JAXB. Мы минимизировали вероятность ошибок, вызванных опечатками или невнимательностью. Однако юнит тесты всё равно будут необходимы, потому что генерация схемы - не точная операция, а скорее обходной маневр (workaround) в условиях, когда поставщик данных не описал строго их формат.

Регулярные выражения

Небольшая, но исключительно полезная функциональность в IDEA - редактор регулярных выражений без запуска кода. До его появления приходилось либо запускать тест после каждого изменения регулярного выражения, либо пользоваться evaluate expression в отладчике, что намного эффективней, но всё равно не совсем удобно. Теперь же, стоит Вам в коде упомянуть класс Pattern, как слева появится всплывающая подсказка с опцией "Check RegExp", при выборе которой откроется мини редактор с двумя полями: регулярным выражением и произвольной строкой, которую мы хотим проверить. Теперь мы можем очень быстро менять выражение и строку, пока не получим нужный результат. Это важно, потому что пока Вы не станете гуру регулярных выражений, Вам потребуется много мелких исправлений и попыток, чтобы получить желаемый результат. Не просто так существует шутка, что если Вы стали решать проблему с помощью регулярного выражения, то теперь у Вас две проблемы. Отдельным приятным бонусом идёт то, что в окне этого редактора специальны конструкции, такие как "\S" (непробельный символ) используются точно так, как они описаны в документации javadoc, в то время как в коде нужно экранировать все обратные слэши ещё одним обратным слэшем (или слэшом). В последнем примере получилось восемь подряд.

Когда мне нужно написать сложное выражение, например чтобы разобрать строку из лога приложения, то с использованием этого помощника я могу скопировать строчку "снизу вверх" и поэтапно заменять части строки на паттерны регулярного выражения, следя за тем, чтобы выражение подходило (Matches). Нужно только сразу экранировать все специальные символы. Второй вариант - формировать выражение слева направо, постепенно добавляя новые конструкции к выражению и текст к проверяемой строке.

Диаграмма зависимостей

Комбинация клавиш Ctrl+Alt+Shift+U при открытом pom.xml файле показывает граф зависимостей. Очень часто использую его, чтобы найти как в проект попадают зависимости на библиотеки, которые я не ожидал. В окне работает поиск по Ctrl+F.

Диаграмма классов

Недавно была добавлена ещё и диаграмма классов по той же комбинации Ctrl+Alt+Shift+U. Трудно сказать, будет ли эта возможность часто использоваться, ведь всё-таки сложные иерархии наследования в приложениях используются довольно редко. Но как минимум при изучении определённых классов Java подобное наглядное представление не будет лишним.

Теперь расскажу о самых частых и полезных комбинациях клавиш. Рекомендую распечатать шпаргалку, которая находится в IDEA в меню Help -> Keymap Reference. Выглядит она так:

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

Ctrl+ALt+Right,Ctrl+Alt+Left

Переход вперед и назад между последними файлами и позициями в файле. Не представляю себе IDEA без этой штуки. Например, пишете основной код для работы с базой данных, тест и тестовый скрипт. Чтобы перемещаться между этими файлами иначе пришлось бы брать мышь и искать файл в верхней панели. А с этой комбинацией клавиш за пару секунд и несколько быстрых нажатий попадёте на нужный файл. И это лучше, чем просто навигация между файлами, это навигация между последними позициями в файлах. Осторожно! В некоторых драйверах видеокарт это сочетание клавиш вращает экран. К счастью, это несложно отключить.

Ctrl+Q

Открывает окно с документацией, обычно это Javadoc класса или метода. Этой возможностью нужно пользоваться как можно чаще, а не пользоваться ей совсем очень плохо. Никто никогда не запомнит всех нюансов использования всех библиотек, а такой способ всегда покажет самую правильную информацию (golden source). Часто хочется просто найти ответ или решение на Stackoverflow, а не вчитываться и разбираться с javadoc, но нужно стараться постепенно переходить к чтению оригинальной документации, потому что решение с форума может оказаться неверным или устаревшим. Примерчик для наглядности:

Создать тест

Чтобы создать JUnit тест на класс нужно перевести курсор на имя класса в заголовке, нажать комбинацию Alt+Enter, а в выпадающем списке выбрать "Create Test". Намного быстрее и удобнее, чем искать директорию с тестами, создавать пакет, а потом копировать или перепечатывать имя класса. Тест не должен располагаться где попало и иметь случайное название с добавкой "Test". Мы располагаем класс теста в том же пакете, чтобы были доступны поля и методы с модификаторами доступа default и protected, а называем по имени проверяемого класса - для порядка.

Ctrl+P

Часто используемая и достаточно очевидная возможность, показывает список сигнатур метода, а также подсвечивает те параметры, которые уже подходят по типу. Также, как и с javadoc документацией, следует использовать как можно чаще, чтобы всегда быть в курсе существования дополнительных неочевидных параметров. Например, кодировки или часового пояса. Почти всегда стоит выбирать тот вариант метода, который использует явное указание подобных аргументов. Или например, используя коллектор toMap, можно заметить параметр mergeFunction, который намекает на то, что нам следует сперва понять, возможны ли в коллекции повторяющиеся элементы и как они обрабатываются без этого параметра.

Ctrl+H

Показывает иерархию классов и интерфейсов, работает в противоположном направлении по сравнению с диаграммой классов. Пример для Collection и TreeSet.

Ctrl+Alt+F7

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

Ctrl+N, Ctrl+Shift+N

Первая команда ищет класс в проекте по имени, вторая произвольный файл по имени. Просто и понятно, но не все используют и поэтому иногда спрашивают где находится файл или в каком пакете класс.

Колесико

Нажатие на среднюю кнопку мыши создаёт многострочный курсор для редактирования текста, причём автодополнения тоже работают. Обожаю эту фишку.

Ctrl+Alt+L

Форматирование текста и кода. Прекрасно работает на файлах XML и JSON, чтобы привести их к структурированному читаемому виду (pretty print). Но в основном, конечно, применяется к коду, обычно после завершения каждого блока кода в 5-10 строк. В этом случае весь код всегда поддерживается в едином стиле отступов, пробелов и переносов строк. Эстетика! Важно, чтобы все разработчики в команде использовали одинаковые настройки форматирования, причём настройки по умолчанию меня полностью устраивают. В противном случае в репозитории код будет постоянно переформатироваться туда-сюда.

Шаблоны (Live Template)

Шаблоны работают так: в коде вводится несколько символов, потом нажимаем Tab. IDEA вставляет либо готовый код либо шаблон кода, в который нужно подставить переменную. Кто-то очень интенсивно использует этот функционал, создавая множество собственных шаблонов. Я пока что использую только 4 встроенных:

1. psvm Создаёт метод main.
   
2. iter Создаёт foreach цикл. Автоматически подставляет ближайшую коллекцию из контекста, но можно сразу поменять.
   
3. itar Создаёт классический for цикл по коллекции с использованием индексов элементов.
   
4. itco Создаёт for цикл по коллекции с использованием iterator.
   

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

Заключение

При обучении программированию в целом и Java в частности существуют подходы с написанием кода в текстовом редакторе или в форме на сайте. Таким образом оттачивается базовый синтаксис и конструкции. Якобы. Я не поддерживаю эту идею и считаю, что нужно сразу максимально приближать обучение к рабочим условиям. А в работе все стараются использовать IDE по максимуму. Тем более, что их возможности сегодня поражают воображение. Еще я не упомянул отдельно комбинации Alt+Enter и Ctrl+Space - это способы попросить подсказку у IDEA, либо закончить строчку кода за нас. Но думаю эти возможности используют все, ведь подсказки и помощь в IDEA повсюду и осваиваются первым делом.