提升开发效率之自定义Android Studio代码模板

1.前言

有时，我们会使用一些重复的模板代码，通常都是使用CV大法来完成。但是，这样的搬砖效率并不高，因此，我们需要使用高级搬砖技能--自定义代码模板。

我们使用Android Studio创建新工程时，可以选择不同的模板，然后Android Studio就会自动生成相应的代码模板了。如下图：

Android Studio内置代码模板.png

这实际上是Android Studio内置的一些默认模板。我们先来研究一下内置的代码模板，然后再实现自定义代码模板。

2.初识代码模板

Android代码模板都位于Android Studio安装路径\plugins\android\lib\templates目录下

templates目录.png

• activities目录下都是一些Activity的模板。
• gradle-projects目录下则是一些创建Project和Module的模板。
• other目录下是其他类的模板。包括Fragment，BroadcastReceiver等等。

2.1 模板结构

我们来看下EmptyActivity这个模板，
路径为：Android Studio安装路径\plugins\android\lib\templates\activities\EmptyActivity。如下：

EmptyActivity模板.png

• 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" />
</globals>

• id:存放变量名。我们可以在其他ftl文件中通过${ 变量 }来访问定义在这里的变量的值，如：${requireTheme}。
• type:变量的类型。有string，boolean，integer等类型。默认是string类型，可以省略不写。
• value:变量值。

另外，可以通过<#include "../common/common_globals.xml.ftl" />来导入其他文件中定义好的变量。

除了以上这些，还可以使用<#if 条件><#else>，如下：

<#if !appCompat>
    <global id="superClass" type="string" value="Activity"/>
<#elseif appCompatActivity>
  ...
<#else>
  ...
</#if>

根据条件可以定义不同的变量值。

3.2 template.xml

template.xml就是模板的配置文件，用来配置面板显示的内容，指定全局变量文件和指定执行文件等等。

<template
    format="5"
    revision="5"
    name="Empty Activity"
    minApi="9"
    minBuildApi="14"
    description="Creates a new empty activity">

    <category value="Activity" />
    <formfactor value="Mobile" />

    <parameter
        id="activityClass"
        name="Activity Name"
        type="string"
        constraints="class|unique|nonempty"
        suggest="${layoutToActivity(layoutName)}"
        default="MainActivity"
        help="The name of the activity class to create" />

    <!-- 省略部分内容 -->

    <!-- 128x128 thumbnails relative to template.xml -->
    <thumbs>
        <!-- default thumbnail is required -->
        <thumb>template_blank_activity.png</thumb>
    </thumbs>

    <globals file="globals.xml.ftl" />
    <execute file="recipe.xml.ftl" />

</template>

template属性解释：

• format:固定值
• revision:版本号
• name:模板名
• minApi:对应minSdkVersion
• minBuildApi:最小编译API
• description:模板描述

再来看看其子节点，主要有以下几种： category、formfactor、parameter、thumbs、globals、 execute。下面分别来看下:

3.2.1 category

 <category value="Activity" />

category可以设置成Activity、Folder、Fragment等等值。设置完之后可以在相应的目录下看到这个模板，如下图所示：

4.category.png

3.2.2 formfactor

<formfactor value="Mobile" />

formfactor可以设置以下值：Mobile、Wear、TV、Car、Things，分别对应如下图。也可以不设置该节点。

5.formfactor.png

如果我们想在新建工程时可以看到我们自己定义的模板，可以设置该节点。否则可以不设置。

ps:在我的Android studio上，设置成TV或其他值的话可以看到有模板，但是设置成Mobile的却看不到，有知道原因的吗？可以回复一下~

3.2.3 parameter

    <parameter
        id="activityClass"
        name="Activity Name"
        type="string"
        constraints="class|unique|nonempty"
        suggest="${layoutToActivity(layoutName)}"
        default="MainActivity"
        help="The name of the activity class to create" />

parameter节点主要就是用来显示可修改的变量，如下图所示:

6.parameter.png

再来看看各个参数的意思：

• id:变量名
• name:展示出来的名字
• type:变量类型，有string、boolean、enum等等值
• constraints:约束类型，有class、unique、nonempty、apilevel、package、activity、layout、drawable、string、id、exists等等值，可以组合在一起使用
• suggest:提示值，未修改变量时根据其他变量生成
• default:默认值
• help:帮助提示
• visibility:是否可见

上面这些参数是比较常用的一些，另外还有一些比较少用的，可以参考内置模板去使用。

3.2.4 thumbs

    <!-- 128x128 thumbnails relative to template.xml -->
    <thumbs>
        <!-- default thumbnail is required -->
        <thumb>template_blank_activity.png</thumb>
    </thumbs>

显示一个缩略图。

3.2.5 globals

<globals file="globals.xml.ftl" />

指定全局变量的文件，一般不用改此值。

3.2.6 execute

<execute file="recipe.xml.ftl" />

指定执行操作的文件，一般不用改此值。

3.3 recipe.xml.ftl

recipe.xml.ftl主要是用来定义复制文件的规则，添加新的依赖等等。

<#import "root://activities/common/kotlin_macros.ftl" as kt>
<recipe>
    <#include "../common/recipe_manifest.xml.ftl" />
    <@kt.addAllKotlinDependencies />

<#if generateLayout>
    <#include "../common/recipe_simple.xml.ftl" />
    <open file="${escapeXmlAttribute(resOut)}/layout/${layoutName}.xml" />
</#if>

    <instantiate from="root/src/app_package/SimpleActivity.${ktOrJavaExt}.ftl"
                   to="${escapeXmlAttribute(srcOut)}/${activityClass}.${ktOrJavaExt}" />
    <open file="${escapeXmlAttribute(srcOut)}/${activityClass}.${ktOrJavaExt}" />

</recipe>

先来看下一些会用到的操作：

• copy:复制文件。将from指定的文件或文件夹复制到to中的位置。如果是.ftl后缀的话，复制后会去掉.ftl后缀。
• merge:合并文件。一般用于对AndroidManifest.xml等文件进行合并操作。
• instantiate:实例化文件。完成模板中的命令，生成符合要求的文件。比如：我们在新建Activity时输入了Activity的类名，那么就可以通过instantiate来生成一个指定类名的Activity类了。
• open:打开文件。完成操作后在Android Studio的标签栏打开指定文件。
• dependency:添加依赖。一般配合hasDependency函数来使用。

除了上面这些操作以外，还可以通过 #import导入其他的文件，或者配合使用#if等等。

recipe.xml.ftl中一些常用的路径：

• ${escapeXmlAttribute(resOut)} ：当前Module的res 文件夹
• ${escapeXmlAttribute(topOut)} ：整个工程的根目录
• ${escapeXmlAttribute(projectOut)} ：当前Module 的根目录
• ${escapeXmlAttribute(manifestOut)} ：AndroidManifest.xml所在的文件夹
• ${escapeXmlAttribute(testOut)} ：测试文件的文件夹
• ${escapeXmlAttribute(srcOut)} ：包名下的路径

4. 实战演练

目前没想到比较合适的例子，先略过了~~

反正Android Studio已经内置了一大堆模板了，有啥问题翻翻已有模板基本都可以解决了。

熟悉了模板之后，我们也可以对系统内置的模板进行修改，这篇是一些常用的修改，有兴趣的可以看看：提升开发效率之修改Android Studio默认的project和module模板