文档章节

Android Studio的Model代码插件开发

叶大侠
 叶大侠
发布于 2016/12/25 17:01
字数 1881
阅读 93
收藏 0
点赞 0
评论 0

源码地址

背景

码工们做的很多工作,很多时候是为了减少这个世界上的重复工作。在为这个世界带来便捷的时候,当然也要不忘给自己的工作减负,提高工作的效率啦。在对接API的时候,我们要根据出来的字段定义相关的数据模型,在复制粘贴几次之后,我开始厌倦这种没有半点技术含量的重复性工作,所以开始思考怎么把这个工作自动化,砍柴不误磨刀工,我相信额外的一点付出会带来效率的提升。

当前我们开发用的IDE是Android Studio, 大家都只都这个是基于intellij开发的,所以能集成在intellij里面就最好了。

目前我们的api文档有两种格式(规范不好的原因),一种是表格,字段名和类型信息都有了,如下:

字段类型描述
pkgFileString包链接
gameIdlong游戏id
channelNameString渠道名

另外一种就是偷懒的写法,直接把返回的Json贴上去:

{
    "id": 1,
    "gameName": "这是游戏标题",
    "gameRecommendText": "游戏一句话推荐",
    "cover": "封面图片",
    "ugcTime": "一天前",
    "gameIcon": "这是游戏图标",
    "gameDownloadUrl": "这是游戏下载链接",
    "ugcTitle": "这是资讯标题",
    "style": 1,
    "ugcViewCount": 333,
    "ugcSource": "咨询来源",
    "videoLength": "12'33''"
}

这里当然两种格式都要很好的支持啦,笔者发现表格直接在网页上复制,然后粘贴到文本输入框中的格式是非常整齐的空格隔开的,格式如下:

pkgFile	String	包链接
gameId	long	游戏id
channelName	String	渠道名

因此我们的数据源就很好确定了,而且也很方便。根据这两种数据源,我们约定:

  • 基本类型比如int,long和对应的类类型Integer则返回基本类型。
  • 没有类型信息或者其他类型用String类型。

下面我们就开始开始这个插件的开发探索吧,笔者希望能抛砖引玉,大家能在平时的工作中有意识根据自己的需要做出更多好用的工具,优化开发流程和开发效率。

intellij插件开发基础知识

开发准备

这里我建议大家看官方的文档,已经介绍很详细了,我在下面也会简单介绍,传送门

  1. 下载安装intellij社区版: 下载地址
  2. 配置IntelliJ Platform Plugin SDK
  3. 创建一个Plugin Project
  4. 运行和调试
  5. 发布插件,这里我建议大家配置Ant来构建,我发现在引入libs包的时候生成的插件主工程会少很多文件,导致无法正常运行,用Ant打包就正常了。

懒人版:

  1. 配置Intellij SDK: 打开Project Structure对话框[Ctrl+Shift+Alt+S],选择Intellij的目录:

2. 新建Plugin Project:

3. 新建完成工程目录结构:

其中plugin.xml文件就是我们注册AnAction的地方。

AnAction介绍

AnAction就是IDE相关位置的事件触发处理的地方,要创建一个Action,只需要简单的两个步骤:

  1. 定义一个AnAction,你通常需要继承AnAction类,然后在actionPerformed方法里面实现你的操作。
  2. 在plugin.xml里面注册这个AnAction

intellij社区版里面创建Action非常方便,你可以通过图像界面很容易找到自己想要放置的Action位置,比如我们要在Code菜单下的Generate..下面放置我们的Action,那么只需要在Groups中找到相应的位置即可:

  • Action ID: 每个Action都需要一个唯一的ID.
  • Class Name: Action的类名,我们是在ithub.yedaxia.plugin.actions下面建的。
  • Name: 名字,就是在界面上我们看到的名字。
  • Description: 描述信息,鼠标放在上面一小段时间可以看到的描述信息。
  • Groups: 可以理解为Action集合。
  • Keyboard Shortcuts: 快捷键设置,这里我们暂时不需要了。

生成之后我们可以看到在plugin.xml里面就有对应的Action了:

<action id="CodeGenerationPlugin.EntryAction" class="github.yedaxia.plugin.actions.EntryAction"
            text="EntryGenerator..." description="Entry Code Generator">
      <add-to-group group-id="CodeMenu" anchor="after" relative-to-action="Generate"/>
</action>

对应的AnAction代码:

public class EntryAction extends AnAction {
    @Override
    public void actionPerformed(AnActionEvent e) {
        //点击EntryGenerator...按钮之后调用这个方法
    }
}

代码生成界面:

代码生成的逻辑并不复杂,我们把这个放到最后,本文还是着重介绍intellij插件的编写,现在我们已经有了程序的入口了,我们还需要一些简单的UI元素,一个对话框,一个简单的输入框[类名],比较大的文本框[数据源和生成的最终代码]。

先看最后的效果:

intellij本身运行在Java上面,所以java swing库支持肯定是没问题的,这个对话框我主要参考了android-codegenerator-plugin-intellij里面的实现。

里面用到了com.intellij.openapi.ui.DialogBuilder,相关api文档没有找到,通过源码也不难发现其用法:

  • setTitle: 标题
  • setCenterPanel(JComponent centerPanel): 对话框中间面板,JComponent对于Java程序员应该就不陌生了。
  • addAction: 添加底部的按钮和相关事件。

具体的代码可以看: CodeDialogBuilder.java

生成代码

代码生成主要包括两个步骤:

  1. 代码模板设计。
  2. 代码构建。

模板的设计也是参考了android-codegenerator-plugin-intellij项目,根据Model数据模板的特点,我分成了以下四个代码模板:

  1. Entry_template: 目标代码模板。
  2. Entry_Field_template: 类字段模板。
  3. Entry_Setter_template: setter方法模板。
  4. Entry_Setter_template: getter方法模板。

Json解析我用的是alibaba的fastjson,所以模板就是长下面的样子了,大家可以根据自己的需要去修改:

Entry:
public class ${CLASS_NAME} implements Serializable{

${FIELDS}
${METHODS}
}

Field:
private ${FIELD_TYPE} ${FIELD_NAME};

Getter:
@JSONField(name="${REMOTE_FIELD_NAME}")
public ${FIELD_TYPE} get${CASE_FIELD_NAME}(){
    return ${FIELD_NAME};
}

Setter:
@JSONField(name="${REMOTE_FIELD_NAME}")
public void set${CASE_FIELD_NAME}(${FIELD_TYPE} ${FIELD_NAME}){
    this.${FIELD_NAME} = ${FIELD_NAME};
}

具体的代码构建过程这里就不详细讲了,大家可以移步github,这个过程应该不难理解。如果觉得这个插件有用,你可以给个star。

思考

这个工具的开发过程比我想象中要简单很多,一天时间左右应该就差不多完成的了,后续带来的好处和省下来的时间肯定会弥补回这个时间代价,有些码工经常会觉得麻烦或者根本没有这个意识,宁愿麻烦一些也不愿意去写个工具来加速自己的工作,我觉得是不可取的,我们应该用重构和工具去避免写重复的代码,把更多的时间放到有价值和有创造性的工作上面来,从中长期来看,这样带来的好处是巨大的,更快的开发速度、鲁棒性更好的系统等,更重要的是个人也获得了成长。

参考资料

  1. IntelliJ Plugin Development Guidelines
  2. android-codegenerator-plugin-intellij
  3. Intellij 生成Ant工程
  4. IntelliJ Plugin Development Docs

© 著作权归作者所有

共有 人打赏支持
叶大侠

叶大侠

粉丝 56
博文 44
码字总数 67312
作品 5
广州
程序员
ButterKnife注解框架详解

  Android 懒人注解框架 :https://github.com/JakeWharton/butterknife   前言:     注解,相信很多同学都用到了,对控件进行初始化的时候需要用到 findViewById() ,当一个activit...

听着music睡 ⋅ 2017/04/12 ⋅ 0

Flutter尝鲜:跨平台移动应用开发

开始之前 本人使用Flutter开发的一个图文App《每日图文》,可以同时运行在Android和iOS上,欢迎体验,喜欢的话还不吝Star一下。 叮叮叮~ 传送门 Flutter为何物? 随着移动App开发成本越来越...

开发的猫 ⋅ 06/06 ⋅ 0

浅谈Kotlin(一):简介及Android Studio中配置

浅谈Kotlin(一):简介及Android Studio中配置 浅谈Kotlin(二):基本类型、基本语法、代码风格 浅谈Kotlin(三):类 浅谈Kotlin(四):控制流 前言:   今日新闻:谷歌宣布,将Kotli...

听着music睡 ⋅ 2017/05/18 ⋅ 0

Android JNI学习(二)——实战JNI之“hello world”

本系列文章如下: Android JNI(一)——NDK与JNI基础 Android JNI学习(二)——实战JNI之“hello world” Android JNI学习(三)——Java与Native相互调用 Android JNI学习(四)——JNI的常用方法...

隔壁老李头 ⋅ 05/09 ⋅ 0

打造你的开发神器——介绍Android Studio上的几个插件

这个月因为各种事情在忙,包括赶项目,回老家,还有准备旅游的事,所以应该写不了四篇博客了。今天介绍一下关于Android Studio 的几个好用的插件,都是我在用的,它们或能帮你节省时间,或者...

浩码农 ⋅ 2015/04/11 ⋅ 0

新建cordova应用,插件开发教程系列(总目录)

以下几篇是连续的教程,代码也是连续的,包括如下章节: 新建cordova应用 https://my.oschina.net/u/1251858/blog/1799002 使用cordova把h5应用打包成apk https://my.oschina.net/u/1251858/...

canneljls ⋅ 04/21 ⋅ 0

读书笔记--Android Gradle权威指南(上)

最近看了一本书《Android Gradle 权威指南》,对于 Gradle 理解又更深了,但不想过段时间就又忘光了,所以打算写一篇读书笔记,将书中一些我个人觉得蛮有用的点记录、总结一下。 前言 首先,...

请叫我大苏 ⋅ 05/24 ⋅ 0

在 Ubuntu 和 Linux Mint 中轻松安装 Android Studio

Android Studio 是谷歌自己的 Android 开发 IDE,是带 ADT 插件的 Eclipse 的不错替代品。Android Studio 可以通过源代码安装,但在这篇文章中,我们将看到如何在 Ubuntu 18.04、16.04 和相应...

作者: Abhishek Prakash ⋅ 05/10 ⋅ 0

Android ------ 美团的Lint代码检查实践

概述 Lint是Google提供的Android静态代码检查工具,可以扫描并发现代码中潜在的问题,提醒开发人员及早修正,提高代码质量。除了Android原生提供的几百个Lint规则,还可以开发自定义Lint规则...

切切歆语 ⋅ 04/16 ⋅ 0

Android开发实战(十八):Android Studio 优秀插件:GsonFormat

Android Studio 优秀插件系列: Android Studio 优秀插件(一):GsonFormat Android Studio 优秀插件(二): Parcelable Code Generator ----------------------------------------------......

听着music睡 ⋅ 2016/03/04 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

Springboot2 之 Spring Data Redis 实现消息队列——发布/订阅模式

一般来说,消息队列有两种场景,一种是发布者订阅者模式,一种是生产者消费者模式,这里利用redis消息“发布/订阅”来简单实现订阅者模式。 实现之前先过过 redis 发布订阅的一些基础概念和操...

Simonton ⋅ 23分钟前 ⋅ 0

error:Could not find gradle

一.更新Android Studio后打开Project,报如下错误: Error: Could not find com.android.tools.build:gradle:2.2.1. Searched in the following locations: file:/D:/software/android/andro......

Yao--靠自己 ⋅ 昨天 ⋅ 0

Spring boot 项目打包及引入本地jar包

Spring Boot 项目打包以及引入本地Jar包 [TOC] 上篇文章提到 Maven 项目添加本地jar包的三种方式 ,本篇文章记录下在实际项目中的应用。 spring boot 打包方式 我们知道,传统应用可以将程序...

Os_yxguang ⋅ 昨天 ⋅ 0

常见数据结构(二)-树(二叉树,红黑树,B树)

本文介绍数据结构中几种常见的树:二分查找树,2-3树,红黑树,B树 写在前面 本文所有图片均截图自coursera上普林斯顿的课程《Algorithms, Part I》中的Slides 相关命题的证明可参考《算法(第...

浮躁的码农 ⋅ 昨天 ⋅ 0

android -------- 混淆打包报错 (warning - InnerClass ...)

最近做Android混淆打包遇到一些问题,Android Sdutio 3.1 版本打包的 错误如下: Android studio warning - InnerClass annotations are missing corresponding EnclosingMember annotation......

切切歆语 ⋅ 昨天 ⋅ 0

eclipse酷炫大法之设置主题、皮肤

eclipse酷炫大法 目前两款不错的eclipse 1.系统设置 Window->Preferences->General->Appearance 2.Eclipse Marketplace下载【推荐】 Help->Eclipse Marketplace->搜索‘theme’进行安装 比如......

anlve ⋅ 昨天 ⋅ 0

vim编辑模式、vim命令模式、vim实践

vim编辑模式 编辑模式用来输入或修改文本内容,编辑模式除了Esc外其他键几乎都是输入 如何进入编辑模式 一般模式输入以下按键,均可进入编辑模式,左下角提示 insert(中文为插入) 字样 i ...

蛋黄Yolks ⋅ 昨天 ⋅ 0

大数据入门基础:SSH介绍

什么是ssh 简单说,SSH是一种网络协议,用于计算机之间的加密登录。 如果一个用户从本地计算机,使用SSH协议登录另一台远程计算机,我们就可以认为,这种登录是安全的,即使被中途截获,密码...

董黎明 ⋅ 昨天 ⋅ 0

web3j教程

web3j是一个轻量级、高度模块化、响应式、类型安全的Java和Android类库提供丰富API,用于处理以太坊智能合约及与以太坊网络上的客户端(节点)进行集成。 汇智网最新发布的web3j教程,详细讲解...

汇智网教程 ⋅ 昨天 ⋅ 0

谷歌:安全问题机制并不如你想象中安全

腾讯科技讯 5月25日,如今的你或许已经对许多网站所使用的“安全问题机制”习以为常了,但你真的认为包括“你第一个宠物的名字是什么?”这些问题能够保障你的帐户安全吗? 根据谷歌(微博)安...

问题终结者 ⋅ 昨天 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部