Intellij IDEA开发--Android Studio插件开发

  • 插件开发
  • 准备工作
  • 新建plugin project
  • 编写插件
  • 运行测试
  • 打包
  • 安装
  • 发布
  • 卸载插件


插件开发

项目需求,需要开发IDE的插件,没开始之前以为会是个很麻烦和困难的事情,开始动手后发现其实步骤也就那么几步。
我平时主要使用的开发IDE就是android studiopycharm
本文主要介绍如何开发自己的Android Studio插件。Android Studio本来就是基于IDEA开发的,要开发AS的插件j就是基于IntelliJ IEDA的插件开发。

准备工作

(1) 安装 Android Studio
(2) 安装配置 IntelliJ IDEA
下载地址:https://www.jetbrains.com/idea/download/
社区版源码:https://github.com/JetBrains/intellij-community
(3) SDK文档:http://www.jetbrains.org/intellij/sdk/docs

新建plugin project

打开IDE—new Project 选择IntelliJ Platform Plugin,注意 Project SDK的配置

android studio的idea版本 android studio .idea文件_Android


Next,输入新建工程名

android studio的idea版本 android studio .idea文件_android studio_02


新建完成后,会自动生成以下目录结构

android studio的idea版本 android studio .idea文件_android studio_03


Resources目录下plugin.xml就是配置文件,一会儿介绍。

src文件夹就是我们要添加代码的地方。

编写插件

我们在src文件夹右击创建一个Action。Action是一个处理插件交互行为的类。

android studio的idea版本 android studio .idea文件_IntelliJ IDEA _04


android studio的idea版本 android studio .idea文件_IntelliJ IDEA _05


Action ID—Action的ID,推荐以插件名.action名格式

Class Name—Action类名,需要带上包名前缀 Name—Action在菜单里面显示的名字

Description—对Action的描述

Groups—定义这个Action所属于的组

Actions—选中的groups下已经存在的actions

Anchor—指定我们的action的位置,first就是最上面

上图中的选择意味着我们的Action功能放在Help菜单中第一个位置。添加后可以看见src目录下系统生成了Action子类,如下

android studio的idea版本 android studio .idea文件_IntelliJ IDEA _06


同时plugin.xml中也添加了一个我设置属性的Action

android studio的idea版本 android studio .idea文件_plugin_07


当然也可以自己手动创建一个类,继承AnAction类,然后手动在xml中添加对Action的属性配置。

下面我们在Action里实现actionPerformed方法,添加一点弹出对话框功能的代码。

public class HelloPlugin extends AnAction{
@Override
	public void actionPerfromed(AnActionEvent e){
	Project project = e.getData(PlatformDataKeys.PROJECT);
	Message.showMessageDialog(project,"Hello World!","xixi",Message.getInformationIcon());
	}
}

android studio的idea版本 android studio .idea文件_插件_08


代码已经完成,下面我们可以运行项目。

运行测试

运行项目,点击小三角形

android studio的idea版本 android studio .idea文件_插件_09


运行后会启动一个新的IntelliJ IDEA ,这里新建一个项目就好了。然后我们可以看到在help菜单里有我们自己的插件选项。

android studio的idea版本 android studio .idea文件_IntelliJ IDEA _10


点击我们的插件

android studio的idea版本 android studio .idea文件_插件_11


OK~我们第一个简单的插件完成了。

打包

测试代码功能后,我们就可以打包插件了,选择Build-- Prepare Plugin Module ’XXX’ For Deployment

android studio的idea版本 android studio .idea文件_IntelliJ IDEA _12


在项目工程下会生成plugin.jar.

android studio的idea版本 android studio .idea文件_android studio_13

安装

打开Android Studio使用下我们的插件。

Setting—plugins—install plugins fromdisk

选择本地刚生成的Jar包。

android studio的idea版本 android studio .idea文件_IntelliJ IDEA _14


然后可能会弹出以下错误incompatible with this installation

android studio的idea版本 android studio .idea文件_插件_15


这种是版本兼容问题,我们回到插件工程,查看plugin.xml文件,since-build,这里初始化版本太高可能和android studio的版本号不兼容,可根据注释调节版本号,我是调整为160.0。这里注意配置文件中的一些配置属性,name就是插件名字,version是插件的版本号。调整后我们重新打包安装。

android studio的idea版本 android studio .idea文件_IntelliJ IDEA _16


可以看到安装成功,显示到插件列表中,重启Android Studio.

android studio的idea版本 android studio .idea文件_插件_17


android studio的idea版本 android studio .idea文件_plugin_18

发布

也可以把我们的插件发布到仓库
http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/publishing_plugin.html

卸载插件

卸载插件就比较简单,和安装插件一样setting-plugin中找到我们的插件,uninstall即可。

android studio的idea版本 android studio .idea文件_IntelliJ IDEA _19


到目前为止我们介绍了使用IntelliJ 编写插件的,以及在android studio上使用插件的流程。

总结下过程

(1) 下载安装Intellij IDEA

(2) 新建项目,添加逻辑功能,最简单就是创建一个Action,然后在actionPerformed中实现自己的功能

(3) 测试生成插件的jar包

(4) 在android studio上安装使用

没有接触过插件之前,觉得插件的编写是一个高大上和困难的事情,实际上走通了以上流程后,发现其实整个步骤不多。当然要做更多功能的插件,还需要查询官方的SDK文档~