Использование шаблонов реального времени

Введение в шаблоны реального времени

> * Вышеуказанное GIF-изображение является лучшим введением в Live Templates.

• Шаблоны реального времени требуют строкового префикса, как показано в GIF-изображении: при вводе sys генерируется определенная строка, где sys — это префикс, который я установил.
• Шаблоны реального времени поддерживают настройку переменных, как показано в GIF-изображении: при вводе temp1 автоматически генерируется temp1, так как оба используют одинаковое имя переменной, после того как я установил значение переменной, оно также появляется.
• Шаблоны реального времени поддерживают установку позиции курсора, как показано в GIF-изображении: после ввода temp1 и нажатия клавиши Enter курсор автоматически перемещается в конец строки. Хотя по умолчанию курсор находится в этой позиции, я настроил его для перемещения в конец строки.
• Шаблоны реального времени поддерживают получение имени текущего класса и имени текущего метода (в основе лежат встроенные функции), как показано в GIF-изображении: при генерации строки вывода автоматически добавляются имя текущего класса и имя текущего метода.
• В целом, шаблоны реального времени предназначены для повышения эффективности написания фиксированных шаблонов кода, что увеличивает скорость написания кода и позволяет добавлять персонализированные элементы.Например, в GIF-изображении, при необходимости вывода данных в процессе разработки, я использую префикс, состоящий из черты и доменного имени, чтобы отличать свои выводы от других, что облегчает полнотекстовый поиск.
• Официальное описание Live Templates: https://www.jetbrains.com/idea/help/live-templates.html

• Как показано на изображении выше, шаблоны реального времени хранятся в XML-файлах, поэтому распространение своих шаблонов реального времени можно осуществить путем распространения соответствующих файлов.
• Шаблоны реального времени IntelliJ IDEA сохраняются в директории /templates, расположенной в следующих директориях для различных систем:

• Windows: C:\Users\youmeek\.IntelliJIdea2017.2\config
• Linux: ~/.<имя продукта><номер версии>/config/templates
• OS X: ~/Library/Preferences/IdeaIC2017.2/templates

Вызов стандартного шаблона кода в реальном времени обычно осуществляется с помощью двух горячих клавиш: Tab и Ctrl + J. Хотя IntelliJ IDEA позволяет изменять эти горячие клавиши, по умолчанию большинство пользователей используют именно эти комбинации, поэтому без особой необходимости не стоит их менять.

Способ использования этих горячих клавиш: как показано на первом GIF-изображении, после ввода sys и нажатия клавиши Tab сразу генерируется предустановленное выражение. Если нажать Ctrl + J, сначала будет показано описание соответствующего шаблона кода в реальном времени, а затем необходимо нажать Enter, чтобы завершить генерацию предустановленного выражения.

Встроенные переменные и параметры шаблоновВ начале статьи мы уже упомянули, что шаблоны кода в реальном времени в IntelliJ IDEA имеют параметры переменных. В частности, IntelliJ IDEA включает два встроенных параметра переменных:> * $END$, который указывает положение курсора после расширения шаблона.

• $SELECTION$, который используется в шаблонах для обертки и представляет собой фрагмент кода, который нужно обернуть.
• Кроме этих двух встроенных параметров, все остальные параметры должны быть пользовательскими.
• Официальная документация: https://www.jetbrains.com/idea/help/live-template-variables.html

Настройка шаблонов кода в реальном времени

> * Как показано на рисунке 1, помимо встроенных шаблонов IntelliJ IDEA, можно создавать новые группы и шаблоны кода в реальном времени. Группы используются для хранения шаблонов кода.

• Как показано на рисунке 2, output — это имя группы, которое указывает разработчику, что все шаблоны кода в этой группе предназначены для вывода. serr — это сокращение для шаблонов кода, которые выводят System.err. Это не полное слово, его не нужно понимать, достаточно запомнить.
• Как показано на рисунке 3, содержимое шаблона кода в реальном времени, которое использует встроенный параметр переменной $END$.
• Как показано на рисунке 4, можно настроить область применения шаблона кода. Например, шаблон serr предназначен для Java-кода, поэтому его следует применять только к Java-файлам или файлам JSP. Применение к HTML или CSS файлам не имеет большого смысла.
• Как показано на рисунке 5, можно выбрать дополнительные функции:

• Reformat according to style — форматирование сгенерированного кода.
• Shorten FQ names — сокращение полного имени класса. Обычно этот параметр следует выбрать, чтобы импортировать классы с полным именем из шаблона и использовать их в сокращенном виде.

• Как показано на рисунке 1, можно перенести шаблон кода в реальном времени в другую группу.

Введение в переменные и функции

Как показано в демонстрационном GIF в начале статьи, содержимое шаблона кода в реальном времени выглядит так: System.out.println("-----------YouMeek.com-----------$VAR1$ значение=" + $VAR1$ + "," + "текущий класс=$CLASS_NAME$.$METHOD_NAME$()");$END$

• $VAR1$, $CLASS_NAME$, $METHOD_NAME$ — это переменные, которые определены нами. Для установки переменных достаточно обернуть их в два символа $.
• Каждая переменная представляет собой позицию курсора при выводе кода. Порядок перемещения курсора слева направо, каждый раз нажимая Enter.

> * Как показано на рисунке выше (красный круг), можно редактировать переменные, которые используются для кода.

• Как показано на рисунке выше (1), переменные $CLASS_NAME$ и $METHOD_NAME$ автоматически выводят текущее имя класса и метода, так как используются соответствующие функции className() и methodName().
• Как показано на рисунке выше (2), каждая переменная представляет собой позицию курсора, но переменные $CLASS_NAME$ и $METHOD_NAME$ не включаются в демонстрацию, так как выбрано значение Skip if defined.
• Как показано на рисунке выше (3), можно изменить порядок перемещения курсора для переменных.
• Описание встроенных функций: https://www.jetbrains.com/idea/help/live-template-variables.html

• Для этих функций на официальном сайте есть подробное описание, поэтому здесь не будем повторяться. Если вы всё ещё не понимаете, вы можете изучить предустановленные шаблоны кода в IntelliJ IDEA, где используются основные функции. Изучая эти шаблоны, вы сможете понять, как использовать эти функции.## Описание функции "Surround"

• Данное Gif-изображение является лучшим пояснением для "surround templates".
• Как показано на Gif-изображении выше, предпосылкой для использования шаблонов "surround" является выбор контента, который будет окружен.
• При настройке шаблонов кода, если шаблон содержит предустановленную переменную $SELECTION$, то этот шаблон кода является шаблоном "surround".
• Эта функция очень удобна для разработчиков фронтенда, так как IntelliJ IDEA по умолчанию включает функцию "surround" для HTML-тегов.