idea 之 Live Template

深藏阁楼爱情的钟 2023-01-17 03:16 139阅读 0赞

### 一、新建Live Template 步骤 ###

Live Template是一个预定义的代码模板,其中的内容能够根据上下文信息自动推断

打开方式：File | Settings | Editor | Live Templates

快捷键：Ctrl+Alt+S

1.通过Template group 创建一个自定义组 mine

2.通过Live Templat 创建一个模板

3.Abbreviation  缩写（必填） Description  描述信息（可选的）

4.代码内容 可以自定义变量

5.Edit Variables 用什么内容替换自定义变量（功能强大 后续有详细解释）

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Z3azE5ODQwMzAx_size_16_color_FFFFFF_t_70][]

### 二、详细设置参数 ###

1.Define 选择Live Template 应用的语言和具体位置

2.置灰的原因：The Edit Variables button is enabled only if the template body contains at least one user-defined variable, that is, a variable different from `$END$` or `$SELECTION$`.

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Z3azE5ODQwMzAx_size_16_color_FFFFFF_t_70 1][]

1.Change 新增的时候出现Define ，修改时显示Change

2.选择Live Template 应用的语言和具体位置

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Z3azE5ODQwMzAx_size_16_color_FFFFFF_t_70 2][]

### 三、Edit Variables ###

Expression 这个字段`的目的是预定义函数要附在变量上（将变量的值替换为预定义变量代表的含义）`

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Z3azE5ODQwMzAx_size_16_color_FFFFFF_t_70 3][]

这个表达式可能包含以下结构:

1、双引号中的字符串常量

2、在活动模板中定义的其他变量的名称

3、带有可能参数的预定义函数

常用的预定义函数

`1. complete() 光标跳转到该变量位置时会打开智能补全,不确定要用什么就用它`  
`2. methodReturnType() 使用当前方法的返回类型设置当前变量`

3.$END$ 为自带变量，即最后光标停留位置

ps：var1,var2并不代表输入顺序，变量输入顺序在Edit variables 中，通过调整上下顺序改变

<table> 
 <tbody> 
 <tr> 
 <td><code>annotated(&lt;annotation&gt;)</code></td> 
 <td> Returns a class, method, or field annotated with the specified qualified name. If there is more than one program element with the specified annotation in your project, it shows a list from which you can choose. For example, <code>annotated("java.lang.Deprecated")</code> returns all program elements annotated with <code>@Deprecated</code>. Some predefined live templates in the RESTful Web Services and Web Services groups use the <code>annotated()</code> function. </td> 
 </tr> 
 <tr> 
 <td><code>arrayVariable()</code></td> 
 <td> Returns the most recently declared array in the current scope (as a method variable or class field). If there is more than one array declared in the current scope, it also shows a list from which you can choose. For example, if you have the following method and expand a template with a variable that uses the <code>arrayVariable()</code> function after both array declarations, it will return the <code>b</code> array by default and also suggest to choose <code>a</code>, along with other arrays defined as class fields: <pre><code>public String getCode() {

int a[] = new int[5];
    int b[] = new int[10];

return code;
}</code></pre> </td> 
 </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
 <tr> 
 <td> Copied! Some predefined live templates in the iterations group (<code>itar</code> and <code>ritar</code>) use the <code>arrayVariable()</code> function. </td> 
 </tr> 
 <tr> 
 <td><code>blockCommentEnd()</code></td> 
 <td> Returns the characters that indicate the end of a block comment in the current language context. For example, in Java files it returns <code>*/</code>. </td> 
 </tr> 
 <tr> 
 <td><code>blockCommentStart()</code></td> 
 <td> Returns the characters that indicate the start of a block comment in the current language context. For example, in Java files it returns <code>/*</code>. </td> 
 </tr> 
 <tr> 
 <td><code>camelCase(&lt;String&gt;)</code></td> 
 <td> Converts a string into camelCase. For example, <code>camelCase("my-text-file")</code>, <code>camelCase("my text file")</code>, and <code>camelCase("my_text_file")</code> all return <code>myTextFile</code>. </td> 
 </tr> 
 <tr> 
 <td><code>capitalize(&lt;String&gt;)</code></td> 
 <td> Capitalizes the first letter of a string. For example, <code>capitalize("name")</code> returns <code>Name</code>. Or you can combine it into <code>capitalize(camelCase("my awesome class"))</code> to get <code>MyAwesomeClass</code>. </td> 
 </tr> 
 <tr> 
 <td><code>capitalizeAndUnderscore(&lt;String&gt;)</code></td> 
 <td> Capitalizes all the letters of a string, and inserts an underscore between the parts. For example, <code>capitalizeAndUnderscore("FooBar")</code>, <code>capitalizeAndUnderscore("foo bar")</code>, and <code>capitalizeAndUnderscore("foo-bar")</code> all return <code>FOO_BAR</code>. </td> 
 </tr> 
 <tr> 
 <td><code>castToLeftSideType()</code></td> 
 <td> Casts the right-side expression to the left-side expression type if necessary. Some predefined templates in the iterations group use the <code>castToLeftSideType()</code> function to have a single template for both raw types and generic types. Compare to <a href="https://www.jetbrains.com/help/idea/edit-template-variables-dialog.html#rightSideType" rel="nofollow">rightSideType()</a>. </td> 
 </tr> 
 <tr> 
 <td><code>className()</code></td> 
 <td>Returns the name of the current class (where you expand the template). Can be useful for constructor templates.</td> 
 </tr> 
 <tr> 
 <td><code>clipboard()</code></td> 
 <td>Returns the contents of the system clipboard.</td> 
 </tr> 
 <tr> 
 <td><code>commentEnd()</code></td> 
 <td>Returns the characters that indicate the end of a comment in the current language context. For languages with line comments, the return value is empty.</td> 
 </tr> 
 <tr> 
 <td><code>commentStart()</code></td> 
 <td>Returns the characters that indicate the start of a comment in the current language context. For languages with line comments, the return value is the start of a line comment, same as <a href="https://www.jetbrains.com/help/idea/edit-template-variables-dialog.html#lineCommentStart" rel="nofollow">lineCommentStart()</a>.</td> 
 </tr> 
 <tr> 
 <td><code>complete()</code></td> 
 <td>Invokes <a href="https://www.jetbrains.com/help/idea/auto-completing-code.html#basic_completion" rel="nofollow">code completion</a> at the position of the variable.</td> 
 </tr> 
 <tr> 
 <td><code>completeSmart()</code></td> 
 <td>Invokes <a href="https://www.jetbrains.com/help/idea/auto-completing-code.html" rel="nofollow">smart type completion</a> at the position of the variable.</td> 
 </tr> 
 <tr> 
 <td><code>componentTypeOf(&lt;array&gt;)</code></td> 
 <td> Returns the component type of an array. For example, you can pass the return value of <a href="https://www.jetbrains.com/help/idea/edit-template-variables-dialog.html#arrayVariable" rel="nofollow">arrayVariable()</a> to the <code>componentTypeOf()</code> function. The <code>itar</code> template uses this logic to properly specify the iterated elements of an array. </td> 
 </tr> 
 <tr> 
 <td><code>concat(&lt;String&gt;, ...)</code></td> 
 <td> Returns a concatenation of all the strings passed to the function as parameters. For example, <code>concat(date()," ",user())</code> returns the current system date and username separated with a space. </td> 
 </tr> 
 <tr> 
 <td><code>currentPackage()</code></td> 
 <td>Returns the name of the current package (with the class where you expanded the template).</td> 
 </tr> 
 <tr> 
 <td><code>date([format])</code></td> 
 <td> Returns the current system date. By default, without a parameter, it returns the date in the current system format. To use a different format, provide a parameter according to the <a href="https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html" rel="nofollow">SimpleDateFormat</a> specification. For example, the <code>date("Y-MM-d, E, H:m")</code> returns the date formatted as <code>2020-02-27, Thu, 16:11</code>. </td> 
 </tr> 
 <tr> 
 <td><code>dbColumns()</code></td> 
 <td> Returns a list of columns for a table or a view. The <code>dbColumns()</code> is used in context live templates (for example, <code>ins</code> ). You can access context live templates by right-clicking an object and selecting SQL Scripts. </td> 
 </tr> 
 <tr> 
 <td><code>dbObjectName()</code></td> 
 <td> Returns a name of a table or a view. The <code>dbObjectName()</code> is used in context live templates (for example, <code>top</code> ). You can access context live templates by right-clicking an object and selecting SQL Scripts. </td> 
 </tr> 
 <tr> 
 <td><code>decapitalize(&lt;String&gt;)</code></td> 
 <td> Replaces the first letter of a string with the corresponding lowercase letter. For example, <code>decapitalize("Name")</code> returns <code>name</code>. </td> 
 </tr> 
 <tr> 
 <td><code>descendantClassEnum(&lt;String&gt;)</code></td> 
 <td> Returns the children of the specified class. If there is more than one child, it shows a list of subclasses from which you can choose. For example, <code>descendantClassEnum("java.lang.Number")</code> returns all the number type classes, such as, <code>java.lang.Float</code>, <code>java.math.BigDecimal</code>, and so on. </td> 
 </tr> 
 <tr> 
 <td><code>enum(&lt;String&gt;, ...)</code></td> 
 <td> Returns a list of strings suggested for completion when the template expands. For example, <code>enum("Foo","Bar","Baz")</code> shows a list from which you can choose one of the specified strings. </td> 
 </tr> 
 <tr> 
 <td><code>escapeString(&lt;String&gt;)</code></td> 
 <td> Escapes special characters so that the result can be used in a Java string. For example, it replaces the tab character with <code>\t</code>, the newline character with <code>\n</code>, escapes the backslash as <code>\\</code>, quotes as <code>\"</code>, and so on. </td> 
 </tr> 
 <tr> 
 <td><code>expectedType()</code></td> 
 <td>Returns the expected type of the expression where the template expands (in the right part of an assignment, after <code>return</code>, as a method parameter, and so on).</td> 
 </tr> 
 <tr> 
 <td><code>fileName()</code></td> 
 <td>Returns the name of the current file with its extension.</td> 
 </tr> 
 <tr> 
 <td><code>fileNameWithoutExtension()</code></td> 
 <td>Returns the name of the current file without its extension.</td> 
 </tr> 
 <tr> 
 <td><code>filePath()</code></td> 
 <td>Returns the absolute path to the current file.</td> 
 </tr> 
 <tr> 
 <td><code>fileRelativePath()</code></td> 
 <td>Returns the current file path relative to the current project. To check what the relative path is for a given file, right-click it and select Copy Reference, or press Ctrl+Alt+Shift+C.</td> 
 </tr> 
 <tr> 
 <td><code>firstWord(&lt;String&gt;)</code></td> 
 <td> Returns the first word of the string passed as the parameter. For example, <code>firstWord("one two three")</code> returns <code>one</code>. </td> 
 </tr> 
 <tr> 
 <td><code>groovyScript(&lt;String&gt;, [arg, ...])</code></td> 
 <td> Executes the Groovy script passed as a string. The first argument is a string with either the text of the script or the path to the file that contains the script. The function passes other optional arguments to the script as values for <code>_1</code>, <code>_2</code>, <code>_3</code>, ..., <code>_n</code> variables. Also, you can access the current editor from inside the script using the <code>_editor</code> variable. The following example shows a <code>groovyScript()</code> function that splits the selected text into words and displays them as a numbered list: <pre><code>groovyScript("def result = ''; _1.split().eachWithIndex { item, index -&gt; result = result + index.next() + '. ' + item + System.lineSeparator() }; return result;", SELECTION);</code></pre> </td> 
 </tr> 
 </tbody> 
</table>

<table> 
 <tbody> 
 <tr> 
 <td> Copied! </td> 
 </tr> 
 <tr> 
 <td><code>guessElementType(&lt;Collection&gt;)</code></td> 
 <td>Returns the likely type of elements stored in a <code>java.util.Collection</code>. IntelliJ IDEA looks for code that adds or extracts elements from a collection to define their type.</td> 
 </tr> 
 <tr> 
 <td><code>iterableComponentType(&lt;Iterable&gt;)</code></td> 
 <td>Returns the type of an iterable object, such as an array or a collection.</td> 
 </tr> 
 <tr> 
 <td><code>iterableVariable()</code></td> 
 <td> Returns the most recently declared iterable object in the current scope (like an array or a collection). If there is more than one iterable object in the current scope, it also shows a list from which you can choose. The predefined live template <code>iter</code> uses the <code>iterableVariable()</code> function. </td> 
 </tr> 
 <tr> 
 <td><code>lineCommentStart()</code></td> 
 <td>Returns the characters that indicate the start of a line comment in the current language context.</td> 
 </tr> 
 <tr> 
 <td><code>lineNumber()</code></td> 
 <td>Returns the current line number.</td> 
 </tr> 
 <tr> 
 <td><code>lowercaseAndDash(&lt;String&gt;)</code></td> 
 <td>Converts a string into lower case and inserts n-dashes as separators. For example, <code>lowercaseAndDash("MyExampleName")</code> and <code>lowercaseAndDash("my example name")</code> both return <code>my-example-name</code>.</td> 
 </tr> 
 <tr> 
 <td><code>methodName()</code></td> 
 <td>Returns the name of the method in which the template expands.</td> 
 </tr> 
 <tr> 
 <td><code>methodParameterTypes()</code></td> 
 <td>Returns the list of parameter types of the method in which the template expands.</td> 
 </tr> 
 <tr> 
 <td><code>methodParameters()</code></td> 
 <td>Returns the list of parameter names of the method in which the template expands.</td> 
 </tr> 
 <tr> 
 <td><code>methodReturnType()</code></td> 
 <td>Returns the type of the value returned by the current method in which the template expands.</td> 
 </tr> 
 <tr> 
 <td><code>qualifiedClassName()</code></td> 
 <td>Returns the fully qualified name of the current class in which the template expands.</td> 
 </tr> 
 <tr> 
 <td><code>regularExpression(&lt;String&gt;, &lt;Pattern&gt;, &lt;Replacement&gt;)</code></td> 
 <td>Finds all occurrences of <code>Pattern</code> in a <code>String</code> and replaces them with <code>Replacement</code>. You can specify the pattern as a regular expression to find everything that matches it in the string.</td> 
 </tr> 
 <tr> 
 <td><code>rightSideType()</code></td> 
 <td> Declares the left-side variable with a type of the right-side expression. Some predefined templates in the iterations group use the <code>rightSideType()</code> function to have a single template for both raw types and generic types. Compare to <a href="https://www.jetbrains.com/help/idea/edit-template-variables-dialog.html#castToLeftSideType" rel="nofollow">castToLeftSideType()</a>. </td> 
 </tr> 
 <tr> 
 <td><code>snakeCase(&lt;String&gt;)</code></td> 
 <td>Converts a string into snake_case. For example, <code>snakeCase("fooBar")</code> and <code>snakeCase("foo bar")</code> both return <code>foo_bar</code>.</td> 
 </tr> 
 <tr> 
 <td><code>spaceSeparated(&lt;String&gt;)</code></td> 
 <td>Returns the specified string with spaces as separators. For example, <code>spaceSeparated("fooBar")</code> returns <code>foo Bar</code> and <code>spaceSeparated("Foo_BAR")</code> returns <code>Foo BAR</code>.</td> 
 </tr> 
 <tr> 
 <td><code>spacesToUnderscores(&lt;String&gt;)</code></td> 
 <td>Replaces spaces with underscores in the string passed as the parameter. For example, <code>spacesToUnderscores("foo bar BAZ")</code> returns <code>foo_bar_BAZ</code>.</td> 
 </tr> 
 <tr> 
 <td><code>substringBefore(&lt;String&gt;, &lt;Delimeter&gt;)</code></td> 
 <td>Returns the substring up to the specified delimiter. This is helpful for removing the extensions in test file names. For example, <code>substringBefore(fileName(),".")</code> returns <code>component-test</code> if used in a file named component-test.js.</td> 
 </tr> 
 <tr> 
 <td><code>subtypes(&lt;String&gt;)</code></td> 
 <td> Returns the subtypes of the type passed as a string in the current scope. The predefined <code>lazy</code> live template uses the <code>subtypes(typeOfVariable(VAR))</code> function to perform lazy initialization of a variable with one of its subtypes. </td> 
 </tr> 
 <tr> 
 <td><code>suggestFirstVariableName(&lt;String&gt;)</code></td> 
 <td> Returns all variables that may be assigned to the type passed as the parameter. This is similar to <a href="https://www.jetbrains.com/help/idea/edit-template-variables-dialog.html#variableOfType" rel="nofollow">variableOfType()</a> but does not suggest <code>true</code>, <code>false</code>, <code>this</code>, and <code>super</code>. </td> 
 </tr> 
 <tr> 
 <td><code>suggestIndexName()</code></td> 
 <td> Returns a suggested name for the index variable in an iteration from most commonly used ones: <code>i</code>, <code>j</code>, <code>k</code>, and so on (the first one that is not used in the current scope). Some of the predefined templates in the iterations group (<code>fori</code>, <code>itar</code>, <code>ritar</code>) use the <code>suggestIndexName()</code> function to suggest a suitable index variable name. </td> 
 </tr> 
 <tr> 
 <td><code>suggestVariableName()</code></td> 
 <td> Suggests the name for a variable based on the variable type and its initializer expression, according to your code style settings that refer to the variable naming rules. For example, if it is a variable that holds an element within an iteration, IntelliJ IDEA makes a guess on the most reasonable name taking into account the name of the iterated container. Some of the predefined templates in the iterations group (<code>itar</code>, <code>itco</code>, <code>iten</code>) use the <code>suggestVariableName()</code> function to suggest a suitable variable name for iterated elements. </td> 
 </tr> 
 <tr> 
 <td><code>time([format])</code></td> 
 <td> Returns the current system time. By default, without a parameter, it returns the time in the current system format. To use a different format, provide a parameter according to the <a href="https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html" rel="nofollow">SimpleDateFormat</a> specification. For example, the <code>time("H:m z")</code> returns the time formatted as <code>13:10 UTC</code>. </td> 
 </tr> 
 <tr> 
 <td><code>typeOfVariable(&lt;String&gt;)</code></td> 
 <td>Returns the type of the variable passed as the parameter.</td> 
 </tr> 
 <tr> 
 <td><code>underscoresToCamelCase(&lt;String&gt;)</code></td> 
 <td>Transforms a string with underscores (like snake_case) into camelCase. For example, <code>underscoresToCamelCase(foo_bar_baz)</code> and <code>underscoresToCamelCase(FOO_BaR_baZ)</code> both return <code>fooBarBaz</code>.</td> 
 </tr> 
 <tr> 
 <td><code>underscoresToSpaces(&lt;String&gt;)</code></td> 
 <td>Transforms underscores in a string to spaces. For example, <code>underscoresToSpaces(foo_bar_baz)</code> returns <code>foo bar baz</code> and <code>underscoresToSpaces(FOO_BaR_baZ)</code> returns <code>FOO BaR baZ</code>.</td> 
 </tr> 
 <tr> 
 <td><code>user()</code></td> 
 <td>Returns the name of the current user.</td> 
 </tr> 
 <tr> 
 <td><code>variableOfType(&lt;String&gt;)</code></td> 
 <td> Returns all variables that may be assigned to the type passed as the parameter. For example, <code>variableOfType("double")</code>, <code>variableOfType("java.util.Vector")</code>, or <code>variableOfType(methodReturnType())</code>. If you pass an empty string <code>""</code> as the parameter, the function suggests all variables regardless of their types. Compare with <a href="https://www.jetbrains.com/help/idea/edit-template-variables-dialog.html#suggestFirstVariableName" rel="nofollow">suggestFirstVariableName()</a>. </td> 
 </tr> 
 </tbody> 
</table>

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Z3azE5ODQwMzAx_size_16_color_FFFFFF_t_70]: /images/20221022/813558515c7a4632933d8002ad6486a3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Z3azE5ODQwMzAx_size_16_color_FFFFFF_t_70 1]: /images/20221022/d5ed5cbbf87b48e0933ed7cba91e8da9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Z3azE5ODQwMzAx_size_16_color_FFFFFF_t_70 2]: /images/20221022/b8f358a8b56a451c8812cd1d98e8a2d3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Z3azE5ODQwMzAx_size_16_color_FFFFFF_t_70 3]: /images/20221022/3dda719d7a6948abaee6693ce2b9d49b.png