Android Studio自定义Activity代码模板

Android开发中经常碰到创建Activity,Android Studio本身自带了几个模板,创建的时候可以看到:
Android Studio自带的模板

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

举例自定义MVPActivity模板:
MVPActivity

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

对应的文件分别如下:


HomeActivity
HomeContract
HomeModel
HomePresenter

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

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

1.Android studio自带的模板存在于AndroidStudio.app/Contents/plugins/android/lib/templates/activities文件夹下,里面可以看到有很多我们熟悉的activity模板了:
自带模板

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

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

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


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

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


模板界面

对应的代码

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

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


image.png

从EmptyActivity模板中将所有文件复制进来,并根据自己的需求添加如下文件
image.png

其中每个文件代码如下:
IContract.java.ftl
Model.java.ftl
Presenter.java.ftl
MVPActivity.java.ftl

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

接下来是编辑内联规则,如下图:
内联规则

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


template.xml
这样生成的Java文件名字就可以按照创建Activity时输入的名字来统一命名。这里我在第一个输入项单独写了一个控件来统一命名:
image.png
它的id为activityName:
activityName
要想使用它来统一命名就要通过suggest属性统一引用它的id:
template.xml

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

提示两点:

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

(2). .java.ftl模板文件中命名需要使用变量,如IContract.java.ftl文件中:
image.png
此处的contractName就是template.xml文件中的控件id:
template.xml
,每个文件中变量名与template.xml中的id对应上才能实现统一命名。

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

5.重启Android Studio,打开Activity模板就能看见自定义的模板了:
image.png

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

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,233评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,013评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,030评论 0 241
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,827评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,221评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,542评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,814评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,513评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,225评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,497评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,998评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,342评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,986评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,055评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,812评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,560评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,461评论 2 266

推荐阅读更多精彩内容