idea中live template的详细使用教程

20200928更新 添加 预定义函数 groovyScript 的使用方式

live template是什么?

live template是一个预定义的代码模板,其中的内容能够根据上下文信息自动推断.
首先放下效果图


demonstrate.gif

相对于手动打出整块代码,很简洁有没有?如果这种毫无技术含量的代码都通过live template 来自动生成,有下面两个好处
1. 有更多的时间关注于业务逻辑,核心代码可以更优雅
2. 减少低级错误出现的可能,之前手写拼错和括号错位真是血和泪的教训
笔者很早之前就注意到这个功能,也查看过官方文档和博客,都不能尽如人意.本文会以上面为例,从头到尾完成一个live template,并介绍其大部分功能

一个完整的示范

  1. 新建一个live template


    image.png
  2. 填写缩写和说明


    image.png

这样使用时如果输入了对应的缩写,会有如下的提示


image.png
  1. 设置模板的作用范围
    刚创建模板时idea应该会提示设置作用范围,我这里是已经设置过了,所以提示更改, 这里应该相差不大

    image.png

    这里我只勾选了在表达式语句时输入会触发, 其他情况下不会触发.例如在方法外输入unq,ide不会给任何提示
    image.png

  2. 设置模板
    live template中模板变量使用$包裹的,并且是可复用的,下面的模板就是将会变动的字段提取为变量

Object result = $CACHE_NAME$.get(String.valueOf($PARAMETER$),
        x -> getSession().createCriteria($RETURN_TYPE$.class)
                .add(Restrictions.eq("$END$$PARAMETER$", $PARAMETER$)).setMaxResults(1)
                .uniqueResult());
return result == null ? null : ($RETURN_TYPE$) result;
  1. 设置强大的预定义函数
    关于预定义函数参见官方文档
    进入编辑变量页面,对变量设置需要的函数(这里很坑,我还以为是在模板里直接使用预定义函数,结果是预定义函数要附在变量上),个人认为这个功能很强大
    image.png

    这里可以调整变量的填充顺序,设置需要的预定义函数,这里就简单介绍下用到的两个函数
    1. complete() 光标跳转到该变量位置时会打开智能补全,不确定要用什么就用它
    2. methodReturnType() 使用当前方法的返回类型设置当前变量
    image.png

进阶篇: 使用预定义函数groovyScript

groovyScript使用Groovy提供更强大的能力,例如打印当前类中所有实例字段的名称.演示前说明几点

  • groovyScript的Expression可以是一段groovy代码,也可以是指向Groovy脚本文件的绝对位置,它执行后需要返回一个字符串表示结果
  • groovyScript中可以使用_editor,表示当前编辑器窗口,是EditorImpl的实例
    下面开始演示
  1. IDEA添加必备jar包
    IDEA安装路径/lib目录添加 qdox jar包,我们需要用它去读取源文件

  2. 定义 groovy脚本文件
    这段脚本读取当前编辑器窗口对应的java源文件,读取并返回所有实例字段的名称

//FieldPrinter.groovy
import com.thoughtworks.qdox.JavaProjectBuilder

import java.nio.charset.StandardCharsets
import java.util.stream.Collectors

def builder = new JavaProjectBuilder();
builder.setEncoding(StandardCharsets.UTF_8.toString())
def file = new File(_editor.getVirtualFile().getPath())
builder.addSource(file)
def clazz = builder.getClasses().iterator().next();
def fieldNames = clazz.getFields().stream().filter({f -> !f.isStatic()}).map({f -> f.getName()}).collect(Collectors.toList())
return fieldNames.stream().collect(Collectors.joining(","));
  1. 定义 live template


    image.png
  2. 运行结果


    image.png

  1. $END$是特殊的预定义变量,表示模板结束后的光标位置
  2. idea有很多预定义的live template.很值得参考

推荐阅读更多精彩内容