Android插件实战之MVP代码模板定制

  • 前言:MVP模式在Android开发越来普及了,尽管代码的具体实现上可能存在很大的不同,但大体上一个业务模块少不了三个文件(Activity,Presenter调度器,Contract约束)。每次新建一个业务模块都手动去新建这些文件是一个很头疼的问题,这篇文章就是介绍通过定制插件的方式,自动去新建这些文件。
    目前类似这种开源的插件有不少,例如我就一直在使用一款叫MVPPlugin的插件来帮助生成,但是问题也会有很多。

    1.原版是生成JAVA文件,而我想要写Kotlin
    2.必须要在包含mvp文件夹的module下才能生成文件
    3.mvp的基类在我的baseModule,包名等需要生成后我手动去改
    4.代码创建信息不符合我的要求(姓名,日期,联系方式等都是插件作者的)
    5.继承基类MVP添加一些东西后还需要自己去导入包。

相信大家使用其他插件的时候或多或少也会有类似的问题,总结就是:可以用,但不够优秀!

还好MVPPlugin的作者提供了插件的源码,在他的基础上本人做了一些修改,使之完全符合自己的需求,顺便梳理一下类似插件的定制流程

定制自己的文件生成插件:

为了解决上面用别人的插件存在无法定制的问题,下面就开始带大家从0开始,15分钟打造出自己的插件。
废话不多说,先看看效果:


操作交互

可以看到,插件使用的过程中进行了两次交互
1.选择code版本 (Java or Kotlin)
2.输入文件的业务逻辑名

并且生成文件后所有依赖已经添加好了,无需任何额外导入,已经完全实现了生成文件的定制。
文末放出源码,下载后结合你自己的业务需求改改就能用了

实现步骤:

1.安装IntelliJ IDEA

插件开发工具,具体可以参考:
https://blog.csdn.net/lmj623565791/article/details/51548272
大神的文章,示例的是个翻译器,而本篇介绍的是文件生成

2.代码导读

首先看一下插件工程目录


Android插件实战之MVP代码模板定制_第1张图片
主目录.png

所有的逻辑基本都在这个AndroidMvpAction内。

主方法:


Android插件实战之MVP代码模板定制_第2张图片
主方法.png

核心的逻辑:

1.通过一个对话框 获取 用户需要的code类型,Kotlin或者Java, 对应的codeType

2.输入业务逻辑名(比如要写一个新闻详情页,就填:NewsDetailFragment或者NewsDetailActivity)

3.根据代码类型,业务逻辑名 去生成文件(根据代码模板)

4.Project,VirtualFile,Messages这些类的作用就是提供api来让你获取交互数据,或者工程根目录等,都是现成的,用就完了。

在主目录的 template/code/下面有两套代码模板,我们以java的Compment.txt为例:

Android插件实战之MVP代码模板定制_第3张图片
模板.png

Compment意为组件,就是通过他来生成activity或者fragment,可以看到里面有很多占位符,例如
&mvp& ,&type& ,&placeholder1&,&placeholder2& , &time& 等,最终生成文件的时候其实就是替换掉这些占位符, 具体的文件生成代码可以下载源码来看,本质来讲 就是 new File()了

3.配置说明

image.png
Android插件实战之MVP代码模板定制_第4张图片
image.png

如图,当你的插件代码打包生成jar之后可以在android studio里面安装。
安装名,插件介绍,在快捷菜单里的命名这些都是可以在out-production-XXXX-plugin.xml里面配置的。

通过Build下面的prepare All Plugin Modules For Deployment按键去生成。

总结:

可以看到其实插件定制起来是很容易的,最难的地方在于获取 鼠标 选择的路径,用户交互的输入数据, 这些都是通过固定的API获取的,拿到这些之后,你可以像写代码一些去写定制的逻辑!
大神说的没错,Android studio插件!不要一直停留在使用的水平,定制起来吧!提高团队开发的效率!

大神引路的文章:
https://blog.csdn.net/lmj623565791/article/details/51548272

原MVPPlugin 插件源码:
https://github.com/yugai/MVPPlugin

本文兼容kotlin增强优化版示例源码:
https://gitee.com/lunguoguo/plugin_engineering

你可能感兴趣的:(Android插件实战之MVP代码模板定制)