live template是什么?

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

首先放下效果图

demonstrate.gif

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

一个完整的示范

1. 新建一个live template

   
   image.png

2. 填写缩写和说明

   
   image.png

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

image.png

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

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

4. 设置模板
   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;

5. 设置强大的预定义函数
   关于预定义函数参见官方文档
   进入编辑变量页面,对变量设置需要的函数(这里很坑,我还以为是在模板里直接使用预定义函数,结果是预定义函数要附在变量上),个人认为这个功能很强大
   image.png
   这里可以调整变量的填充顺序,设置需要的预定义函数,这里就简单介绍下用到的两个函数
   1. complete() 光标跳转到该变量位置时会打开智能补全,不确定要用什么就用它
2. methodReturnType() 使用当前方法的返回类型设置当前变量
   image.png

---

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