模板开发

什么是模板

Android Studio Templates其实不是什么新鲜的技术,Google其实就是把Freemarker模板引擎整合到了Android Studio中。通过配置一些属性和预制一些代码,达到一键生成代码,简化开发的目的。

模板开发_第1张图片
新建模板

模板的组织结构

  • 模板统一放在{androidStudio安装目录}\plugins\android\lib\templates\下
  • 涉及界面的模板一般放在activities文件夹下,其它放在other文件夹下
模板开发_第2张图片
activities里的一个模板组织结构

在上图中,出现了三种文件,ftl、xml和png

  • ftl是Freemarker文件,跟模板文件操作相关的操作都在ftl文件中定义
  • xml有两个,根目录下的template.xml定义了我们在使用模板时显示的界面;另一个res文件夹下的xml文件没有逻辑功能,将直接被复制到我们的工程中
  • png只有根目录下的那个文件,其实就显示在我们使用模板时显示的界面里,作为该模板的logo使用

模板的定义

  1. template.xml定义了使用模板时的界面,我们先看LoginActivity的模板界面
模板开发_第3张图片
LoginActivity模板
  • 定义类别
模板开发_第4张图片
定义类别
  • 定义输入项
模板开发_第5张图片
定义输入项
  • 定义logo和包名

模板开发_第6张图片
定义logo和包名

每个输入框的默认值、提示、类型等都是在xml中定义的。
需要注意的是,我们更改 Activity Name时, Layout Name也会随之更改,这是通过 “suggest="${activityToLayout(activityClass)}"”实现的,其中 ${activityToLayout()是个函数,用于把Activity的类名 XXXActivity转换成Layout名 activity_XXX;而这个函数的入参 “activityClass”就是 “Activity Name”这个输入框对应的id “activityClass”
template的作用不止是定义模板的界面,事实上,通过在template里定义的id,其他ftl文件就可以获取我们在界面上输入的类名和文件名等,为自动生成文件和代码提供输入参数。
例如,在LoginActivity.java.ftl中,生成XXXActivity.java文件时,文件的名字,类的名字,都会根据template文件中activityClass的值进行赋值

模板开发_第7张图片
变量的使用

2.globals.xml.ftl
定义一些全局变量

模板开发_第8张图片
全局变量

3.recipe.xml.ftl
recipe.xml.ftl用来定义如何生成代码和文件

模板开发_第9张图片
生成代码
  • copy :从root中copy文件到我们的目标目录,比如我们的模板Activity需要使用一些图标,那么可能就需要使用copy标签将这些图标拷贝到我们的项目对应文件夹
  • merge : 合并的意思,比如将我们使用到的strings.xml合并到我们的项目的stirngs.xml中
  • instantiate : 和copy类似,但是可以看到上例试将ftl->java文件的,也就是说中间会通过一个步骤,将ftl中的变量都换成对应的值,那么完整的流程是ftl->freemarker process -> java
  • open:在代码生成后,打开指定的文件,比如我们新建一个Activity后,默认就会将该Activity打开

新建一个模板

我们来手动写一个简单模板,生成多种类型单例的java类。
1.编写template.xml文件

模板开发_第10张图片
template

2.编写globals.xml文件

globals

3.编写Singleton.java.ftl模板文件


模板开发_第11张图片
Singleton.java.ftl

4.编写recipe.xml.ftl文件

模板开发_第12张图片
recipe.xml.ftl

最后的目录组织如下

模板开发_第13张图片
模板目录

一些坑

  • 导入模板如果有问题,androidstudio直接就卡死了,看不见eventLog
  • FreeMaker的循环语法用的会报错
  • 不知道怎么定义int型的变量

鸣谢

蓝灰_q
Hongyang

你可能感兴趣的:(模板开发)