实时模板变量
当您展开 实时模板 缩写时,其变量要么显示为可输入值的字段,要么被值替换。 这些值可能是您可以修改的默认值,或者是使用 函数计算得出的值。
要在模板中声明变量,请使用以下格式: $VAR$。
在表达式中,请使用不带开头和结尾的美元字符的变量名 $ ,例如 lowercaseAndDash(ComponentName)。
通过表达式定义每个变量,并在表达式求值失败时提供默认值。
此表达式可能包含以下结构:
双引号中的字符串常量
在实时模板中定义的其他变量的名称
预定义函数及其可能的参数
配置模板变量
在 设置 对话框(Ctrl+Alt+S )中,转到 。
选择您想要配置变量的模板。
在模板文本中指定变量,然后点击 编辑变量(E)…。
在 编辑模板变量 对话框中,您可以对每个变量执行以下操作:
更改变量名。
使用 预定义函数定义表达式。
指定表达式评估失败时的默认值。 默认值应包含在双引号中。
指定在表达式成功评估后,您是否希望在提示用户输入时跳过该变量。

预定义模板变量
DataGrip 支持以下无法修改的预定义 实时模板 变量:
$END$表示代码段完成时文本光标的位置,您不能再按 Tab 跳到下一个变量。$SELECTION$用于环绕模板,表示要包装的代码片段。 模板展开后,会按照模板中的指定方式包装所选文本。 例如,如果您在代码中选择EXAMPLE并通过指定的缩写或按下 Ctrl+Alt+T 并从列表中选择所需的模板来调用"$SELECTION$"模板,DataGrip 将如下所示将所选内容用双引号括起来:"EXAMPLE"。
在实时模板变量中使用的函数
以下函数可用于定义 实时模板 变量:
函数 | 描述 |
|---|---|
| 返回指示当前语言上下文中块注释结束的字符。 |
| 返回指示当前语言环境下块注释开始的字符。 |
| 将字符串转换为 camelCase。 例如, |
| 将字符串的首字母大写。 例如, |
| 将字符串的所有字母大写,并在各部分之间插入下划线。 例如, |
| 返回系统剪贴板的内容。 |
| 返回当前语言环境中表示注释结束的字符。 对于带有行注释的语言,返回值为空。 |
| 返回当前语言上下文中表示注释开始的字符。 对于带有行注释的语言,返回值是行注释的起始,与 lineCommentStart() 相同。 |
| 在变量的位置调用 代码补全。 |
| 在变量的位置调用 智能类型补全。 |
| 返回所有作为参数传递给函数的字符串的拼接结果。 例如, |
| 返回当前系统日期。 默认情况下,没有参数时,它会以当前系统格式返回日期。 要使用不同的格式,请根据 SimpleDateFormat规范提供参数。 例如, |
| 返回表或视图的列列表。 上下文代码模板中使用了 |
| 返回表或视图的名称。 上下文代码模板中使用了 |
| 将字符串的首字母替换为相应的小写字母。 例如, |
| 返回模板扩展时建议的字符串列表。 例如, |
| 将特殊字符转义,以便结果可以在 Java 字符串中使用。 例如,它将制表符替换为 |
| 返回当前文件的名称及其扩展名。 |
| 返回当前文件的名称,但不包含其扩展名。 |
| 返回当前文件的绝对路径。 |
| 返回相对于当前项目的当前文件路径。 要检查某个给定文件的相对路径,右键点击并选择 复制引用 ,或按 Ctrl+Alt+Shift+C。 |
| 返回作为参数传递的字符串的第一个单词。 例如, |
| 执行传递为字符串的 Groovy 脚本。 第一个参数是一个字符串,其中包含脚本的文本或包含脚本的文件路径。 函数将其他可选参数作为 以下示例显示了一个
groovyScript("_1.toUpperCase()", MyVar)
以下示例显示了一个
groovyScript("def result = ''; _1.split().eachWithIndex { item, index -> result = result + index.next() + '. ' + item + System.lineSeparator() }; return result;", SELECTION)
最后一个示例使用 |
| 返回指示当前语言环境中行注释开始的字符。 |
| 返回当前行号。 |
| 将字符串转换为小写并插入短横线作为分隔符。 例如, |
| 找到所有在 例如, |
| 返回在向函数或语句添加参数时的参数详细信息。 |
| 将字符串转换为 snake_case。 例如, |
| 返回指定的字符串,并以空格作为分隔符。 例如, |
| 将传入参数中的空格替换为下划线。 例如, |
| 返回指定分隔符之前的子字符串。 这对于移除测试文件名中的扩展名很有帮助。 例如, |
| 返回当前系统时间。 默认情况下,无参数时,它会返回当前系统格式的时间。 要使用不同的格式,请根据 SimpleDateFormat规范提供参数。 例如, |
| 将带有下划线的字符串(如 snake_case )转换为 camelCase。 例如, |
| 将字符串中的下划线转换为空格。 例如, |
| 返回当前用户的名称。 |
示例
有关创建和使用包含变量和函数的简单实时模板的示例,请参阅 创建包含变量和函数的 live template 教程。