1.前言
有时,我们会使用一些重复的模板代码,通常都是使用CV大法来完成。但是,这样的搬砖效率并不高,因此,我们需要使用高级搬砖技能–自定义代码模板。
我们使用Android Studio创建新工程时,可以选择不同的模板,然后Android Studio就会自动生成相应的代码模板了。如下图:
这实际上是Android Studio内置的一些默认模板。我们先来研究一下内置的代码模板,然后再实现自定义代码模板。
2.初识代码模板
Android代码模板都位于Android Studio安装路径\plugins\android\lib\templates
目录下
- activities目录下都是一些Activity的模板。
- gradle-projects目录下则是一些创建Project和Module的模板。
- other目录下是其他类的模板。包括Fragment,BroadcastReceiver等等。
2.1 模板结构
我们来看下EmptyActivity这个模板,
路径为:Android Studio安装路径\plugins\android\lib\templates\activities\EmptyActivity
。如下:
- root文件夹:模板代码和资源存放在此目录下。
- globals.xml.ftl : 存放一些全局变量。
- template.xml : 模板的配置文件,包括面板显示内容,全局变量文件和指定执行文件等等。
- recipe.xml.ftl : 定义复制文件的规则,添加新的依赖等等。
- template_blank_activity.png:模板预览图。在选择界面展示使用。
2.2 ftl文件
上面的一些文件是以ftl后缀结尾的。那么ftl是什么呢?ftl全名FreeMarker Template Language,即FreeMarker模板语言。FreeMarker则是一款模板引擎,这里就不细说了。有兴趣的自行查找资料吧。
另外,${}
、<#if></#if>
和<#include>
等等都是FreeMarker的语法,后面会使用到。
3. 模板文件详解
下面来详细介绍涉及到文件里面包含的内容。
3.1 globals.xml.ftl
globals.xml.ftl是用来存放一些全局变量。
先来看下EmptyActivity模板里的globals.xml.ftl的内容:
<globals>
<global id="requireTheme" type="boolean" value="true" />
<#include "../common/common_globals.xml.ftl" />
<global id="simpleLayoutName" value="${contentLayoutName}" />
<global id="appBarLayoutName" value="${layoutName}" />
<global id="fragmentClass" value="${activityClass}Fragment"