Android Studio自定义Activity代码模板

Android开发中经常碰到创建Activity,Android Studio本身自带了几个模板,创建的时候可以看到:
Android Studio自定义Activity代码模板_第1张图片
Android Studio自带的模板

但未必符合我们需要的模板样式,所以我们要自定义代码模板。

举例自定义MVPActivity模板:
Android Studio自定义Activity代码模板_第2张图片
MVPActivity

点击界面后看到的界面如下:
Android Studio自定义Activity代码模板_第3张图片
自定义模板举例
可以看到其中标记的部分都是自定义的,其中通过MVP Name来为后面的Activity、布局文件、Contract、Model和Presenter统一命名,由Generate MVP File选择框决定是否在生成activity的同时生成Contract、Model和Presenter等Java类。
点击完成后模板如下:
Android Studio自定义Activity代码模板_第4张图片
image.png

对应的文件分别如下:


Android Studio自定义Activity代码模板_第5张图片
HomeActivity
Android Studio自定义Activity代码模板_第6张图片
HomeContract
Android Studio自定义Activity代码模板_第7张图片
HomeModel
Android Studio自定义Activity代码模板_第8张图片
HomePresenter

以上代码都是自动生成的,是不是很方便?
注:每个人心中的MVP模式或许都有些差异,我习惯这样写,如有不足还请指正。

下面开始讲解自定义模板步骤:

1.Android studio自带的模板存在于AndroidStudio.app/Contents/plugins/android/lib/templates/activities文件夹下,里面可以看到有很多我们熟悉的activity模板了:
Android Studio自定义Activity代码模板_第9张图片
自带模板

在写自定义模板之前我们需要分析一下一个模板的文件结构和用法,之后可以照猫画虎写出我们需要的模板来。

2.就以比较简单的EmptyActivity来分析:
Android Studio自定义Activity代码模板_第10张图片
EmptyActivity目录结构
可以看到每一个模板存在于root文件夹下,其中:
src:代码文件
globals.xml.ftl:可存储全局变量以供其他模板文件统一引用,.ftl文件是freemarker模板引擎,它是一个Java类库,主要用于创建模板。

recipe.xml.ftl:用于组合生成我们实际需要的代码文件和布局文件等。
template.xml:相当于Android中的布局文件,用于提供参数,布局等。
下面一一打开文件进行简单介绍:


Android Studio自定义Activity代码模板_第11张图片
globals.xml.ftl
globals文件中可以看到每一个变量的定义形式,id作为唯一标识,type标识变量类型,value表示变量值。
Android Studio自定义Activity代码模板_第12张图片
recipe.xml.ftl
recipe.xml.ftl文件即使不懂freemarker引擎应该也可以大概看懂,instantiate标签用于将.ftl文件转换成实际的Java类文件,open标签用于在转换完成时在项目中对应的包下生成该Activity文件。
这里if判断可以轻松看出是根据用户选择生成的文件类型来生成Java文件或者kotlin文件,即
Android Studio自定义Activity代码模板_第13张图片
template.xml
Android Studio自定义Activity代码模板_第14张图片
template.xml
Android Studio自定义Activity代码模板_第15张图片
image.png

template.xml文件就是模板界面了,主要由parameter标签获取用户输入的参数:
id:唯一标识符,也用于其他文件变量查找引用
name:该标签的名称,同时将展示给用户
type:参数类型,如boolean 、string等


Android Studio自定义Activity代码模板_第16张图片
模板界面

Android Studio自定义Activity代码模板_第17张图片
对应的代码

很类似Android写布局文件的形式吧!每个parameter标签就相当于一个控件,这样就好理解了。

3.定义MVPActivity代码模板
经过以上简单介绍基本足够我们写自定义模板了,雨里雾里的童鞋们可以再打开其他模板研究一下,加深印象。
首先创建MVPActivity文件夹:


Android Studio自定义Activity代码模板_第18张图片
image.png

从EmptyActivity模板中将所有文件复制进来,并根据自己的需求添加如下文件
Android Studio自定义Activity代码模板_第19张图片
image.png

其中每个文件代码如下:
Android Studio自定义Activity代码模板_第20张图片
IContract.java.ftl
Android Studio自定义Activity代码模板_第21张图片
Model.java.ftl
Android Studio自定义Activity代码模板_第22张图片
Presenter.java.ftl
Android Studio自定义Activity代码模板_第23张图片
MVPActivity.java.ftl

编辑好Java文件后,根据自己的需要编辑template.xml文件来自定义界面,还是不会编辑界面的童鞋可以仿照其他界面代码研究一下。

接下来是编辑内联规则,如下图:
Android Studio自定义Activity代码模板_第24张图片
内联规则

需要注意的是箭头标记的地方,这里根据模板生成Java文件的时候我们希望文件名字是创建的时候已经命名好的,因此这里要引用template.xml文件中各自控件的变量id:


Android Studio自定义Activity代码模板_第25张图片
template.xml
这样生成的Java文件名字就可以按照创建Activity时输入的名字来统一命名。这里我在第一个输入项单独写了一个控件来统一命名:
Android Studio自定义Activity代码模板_第26张图片
image.png
它的id为activityName:
Android Studio自定义Activity代码模板_第27张图片
activityName
要想使用它来统一命名就要通过suggest属性统一引用它的id:
Android Studio自定义Activity代码模板_第28张图片
template.xml

${ID名}为变量前缀,后面可以加上Contract,Model,Presenter等自己想要的后缀名。

提示两点:

(1).回到内联文件recipe.xml.ftl中,内联的顺序在代码中是从上往下执行的,因此要想生成文件后焦点窗口定位在新的Activity内,则要把Activity的内联代码放在最下面:
Android Studio自定义Activity代码模板_第29张图片
recipe.xml.ftl
这样所有文件生成完毕后才会优先定位到Activity窗口:
Android Studio自定义Activity代码模板_第30张图片
image

(2). .java.ftl模板文件中命名需要使用变量,如IContract.java.ftl文件中:
Android Studio自定义Activity代码模板_第31张图片
image.png
此处的contractName就是template.xml文件中的控件id:
Android Studio自定义Activity代码模板_第32张图片
template.xml
,每个文件中变量名与template.xml中的id对应上才能实现统一命名。

4.以上步骤都做完以后编码部分就完成了,最后需要把整个MVP Activity文件夹都复制到/Applications/Android Studio.app/Contents/plugins/android/lib/templates/activities目录下即可:
Android Studio自定义Activity代码模板_第33张图片
image.png

5.重启Android Studio,打开Activity模板就能看见自定义的模板了:
Android Studio自定义Activity代码模板_第34张图片
image.png

注意,若编码的时候出现语法错误,那么在Android studio中点击finish生成Activity的时候会直接报错,查看点击log可以看到详细的报错位置,自己再进行修改就可以了。

最近发现了一款编辑模板的插件,使用起来可以更方便些:https://puke3615.github.io/2017/03/06/TemplateBuilder[Chinese]/
最后附上模板文件:activity模板下载地址

你可能感兴趣的:(Android Studio自定义Activity代码模板)