想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

发布时间:2020-08-09 10:43:06 作者:yilian
来源:ITPUB博客 阅读:154

背景

我们知道,在Android开发中,官方提供了很多模板,可以直接创建成套的代码,很是方便开发

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

这种代码模板其实不是什么新鲜的技术,Google其实就是把Freemarker模板引擎整合到了Android Studio中。

下面我们研究一下Android Studio的模板,并自定义两个代码模板。

模板文件浅析

我们打开Android Studio的模板文件,分析一下这种文件的构成,文件地址为..\Android Studio\plugins\android\lib\templates\,我们在AS中使用的模板都在这里出现。

我们以..\Android Studio\plugins\android\lib\templates\activities\LoginActivity为例,分析一下模板文件是怎么运作的

文件夹中的文件及各文件的作用如下:

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

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

我们再看看根目录下的三个文件的文件内容

·template.xml

template.xml定义了使用模板时的界面,我们先看LoginActivity的模板界面

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

我们看看template.xml如何定义这个界面

定义模板类别

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

定义输入项:

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

容易看到,每个输入框的默认值、提示、类型等都是在xml中定义的。

需要注意的是,我们更改Activity Name时,Layout Name也会随之更改,这是通过“suggest=" 想要自己的专属代码模板?一文教你自定义Android Studio代码模板!{activityToLayout()是个函数,用于把Activity的类名XXXActivity转换成Layout名activity_XXX;而这个函数的入参“activityClass”就是“Activity Name”这个输入框对应的id“activityClass”。

最后是定义logo和包名

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

template的作用不止是定义模板的界面,事实上,通过在template里定义的id,其他ftl文件就可以获取我们在界面上输入的类名和文件名等,为自动生成文件和代码提供输入参数。

例如,在LoginActivity.java.ftl中,生成XXXActivity.java文件时,文件的名字,类的名字,都会根据template文件中activityClass的值进行赋值

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

·globals.xml.ftl

定义一些全局变量

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

如上图所示,在globals里定义了一个与API版本有关的boolean值,这个值将在生成LoginActivity的代码时,用来判断是否要添加部分代码

·recipe.xml.ftl

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

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

·其他模板代码文件

除了根目录下的globals.xml.ftl、recipe.xml.ftl、template.xml三个文件,其他模板都可以根据需要自由配置。

制作自定义的MVPActivity模板

模板文件结构如下:

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

核心就在于代码文件夹里的三个文件,分别是MVP的接口、Presenter和Activity,文件内容分别如下:

Contract的模板文件:

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

Presenter的模板文件:

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

Activity的模板文件:

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

在recipe.xml.ftl文件中把这几个文件初始化并复制到工程中

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

最后,把整个文件夹复制到..\Android Studio\plugins\android\lib\templates\activities\下, 重启Android Studio,就可以应用了。在Activity类别的模板中,多了一个 Empty MVP Activity

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

打开后,界面如下:

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

我们注意到,最前面有个Biz Name的输入参数,这个参数的作用不是生成文件,而是为后面的文件统一命名,因为Activity Name只能影响到Layout Name,我希望能一起设置接口和Presenter的名字,但是Freemarker没有和${activityToLayout()这个函数对应的生成接口和Presenter名字的函数,所以我在最前面增加了这样一个变量,专门用于统一命名。

具体在template.xml文件中,增加了一个id为“activityName”的变量,并为后续的变量赋值,如在“activityClass”中,把suggest的值设定为"${activityName}Activity",让它自己拼出XXXActivity的名字。

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

生成的文件结构如下:

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

生成的Activity文件:

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

生成的Presenter:

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

生成的Contract:

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

至此,我们完成了自定义代码模板的编写和使用。

最后

附上我的Android核心技术学习大纲,获取相关内容来我的GitHub一起玩耍: https://github.com/Meng997998/AndroidJX

你把你的时间投资在学习上,就意味着你可以收获技能,更有机会增加收入。

在这里分享我的Android学习PDF大全来学习,这份Android学习PDF大全真的包含了方方面面了,内含Java基础知识点、Android基础、Android进阶延伸、算法合集等等

想要自己的专属代码模板?一文教你自定义Android Studio代码模板!

我的这份学习合集,可以有效的帮助大家掌握知识点。

总之也是在这里帮助大家学习提升进阶,也节省大家在网上搜索资料的时间来学习,也可以分享给身边好友一起学习

获取方式:关注我看个人介绍,或直接  点击我免费领取

推荐阅读:
  1. 常用的php代码开发工具介绍
  2. linux c下log输出代码模板示例代码

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

android studio 专属

上一篇:mysql数据库迁移、多端口运行、innobackupex备份

下一篇:UI中的控件

相关阅读

您好,登录后才能下订单哦!

密码登录
登录注册
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》