工欲善其事必先利其器&＃xff0c;自打从Eclipse转战AndroidStudio以来&＃xff0c;还没彻底摆脱Eclipse。打算从开发AndroidStudio插件开始&＃xff0c;彻底摆脱Eclipse。AndroidStudio基于IntelliJ平台&＃xff0c;因此&＃xff0c;开发AndroidStudio插件其本质只是开发IntelliJ平台的插件。通常我们开发的IntelliJ平台插件主要分为如下几类&＃xff1a;
自定义编程语言的支持(Custom language support)&＃xff1a;包括语法高亮、文件类型识别、代码格式化、代码查看和自动补全等等
框架集成(Framework integration)&＃xff1a;其实就是类似基于IntelliJ开发一个IDE出来&＃xff0c;比如AndroidStudio 将Android SDK集成进IntelliJ。其他的插件如Java EE中的Spring、Struts等framework集成到IntelliJ。使用户在IntelliJ上面使用特定的框架更方便。
工具集成(Tool integration)&＃xff1a;对IntelliJ定制一些个性化或者是实用的工具。
附加UI(User interface add-ons)&＃xff1a;对标准的UI界面进行修改&＃xff0c;如在编辑框里加一个背景图片等。
1. 下载IntelliJ IDEA
在开发IntelliJ插件时&＃xff0c;我们使用的是IntelliJ IDEA自身来开发。为什么不用AndroidStudio来开发呢&＃xff1f;主要是AndroidStudio是面向Android开发的&＃xff0c;在针对IntelliJ插件的各种环境都没有&＃xff0c;当然&＃xff0c;你也可以自己下载插件开发环境然后在AndroidStudio上去配置。但是个人觉得过于麻烦&＃xff0c;IntelliJ IDEA集成了插件开发环境&＃xff0c;下载后可以直接拿来开发插件。IntelliJ IDEA下载地址如下&＃xff1a;
2. 创建项目
选择“File>New>Project...”,将Project选择为IntelliJ Platform Plugin&＃xff0c;然后再点击Next。如下图所示&＃xff1a;
选择IntelliJ Platform Plugin
填写Project名称及项目保存路径&＃xff0c;其中Project Name可以认为是插件名称。点击Finish&＃xff0c;如下图所示。
填写Project name
完成后&＃xff0c;创建的项目结构如下所示&＃xff1a;
项目结构
我们比较关心的主要是src目录和resources/META-INF/plugin.xml文件。src目录存放的是插件对应的Java源码&＃xff0c;resources/META-INF/plugin.xml是配置Action的文件&＃xff0c;关于Action后面讲&＃xff0c;现在暂时可以将resources/META-INF/plugin.xml看成是插件的配置文件。
3. 创建Action
我们在IntelliJ自定义的插件可以添加到菜单项目(如右键菜单中)或者是放在工具栏中。当用户点击时触发一个动作事件&＃xff0c;IntelliJ则会回调AnAction类的actionPerformed函数。因此我们只需重写actionPerformed函数即可。
在src目录中创建包名&＃xff1a;com.huachao.plugin,然后&＃xff0c;在com.huachao.plugin中创建java类&＃xff0c;类为FirstPlugin.java
创建Java类
将FirstPlugin继承AnAction类&＃xff0c;并重写actionPerformed函数。
package com.huachao.plugin;
import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.AnActionEvent;
import com.intellij.openapi.actionSystem.PlatformDataKeys;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.ui.Messages;
/**
* Created by HuaChao on 2016/12/24.
*/
public class FirstPlugin extends AnAction {
&＃64;Override
public void actionPerformed(AnActionEvent event) {
Project project &＃61; event.getData(PlatformDataKeys.PROJECT);
Messages.showMessageDialog(project, "Hello World!", "Information", Messages.getInformationIcon());
}
}
4. 修改plugin.xml
上一节我通过继承AnAction类来定义Action&＃xff0c;现在我们需要将我们自定义的插件放入到工具类或者是菜单子项中&＃xff0c;这就是通过plugin.xml指定。打开resources/META-INF/plugin.xml文件&＃xff0c;IntelliJ帮我们自动生成内容如下&＃xff1a;
com.your.company.unique.plugin.id
Plugin display name here
1.0
YourCompany
Enter short description for your plugin here.
most HTML tags may be used
]]>
Add change notes here.
most HTML tags may be used
]]>
每个标签的具体作用在注释中解释的很详细&＃xff0c;我们现在只关心标签&＃xff0c;暂时先忽略其他标签。在标签中添加子标签&＃xff0c;如下所示&＃xff1a;
标签属性的简单说明&＃xff1a;
id&＃xff1a;作为标签的唯一标识。一般以.方式。
class&＃xff1a;即我们自定义的AnAction类
text&＃xff1a;显示的文字&＃xff0c;如我们自定义的插件放在菜单列表中&＃xff0c;这个文字就是对应的菜单项
description&＃xff1a;对这个AnAction的描述
另外还有标签&＃xff0c;这个标签指定我们自定义的插件应该放入到哪个菜单下面。在IntelliJ IDEA菜单栏中有很多菜单如File、Edit、View、Navigate、Code、......、Help等。他们的ID一般是菜单名&＃43;Menu的方式。比如&＃xff0c;我们想将我们自定义的插件放到Help菜单中&＃xff0c;作为Help菜单的子选项。那么在标签中指定group-id&＃61;"HelpMenu"。标签的anchor属性用于描述位置&＃xff0c;主要有四个选项&＃xff1a;first、last、before、after。他们的含义如下&＃xff1a;
first&＃xff1a;放在最前面
last&＃xff1a;放在最后
before&＃xff1a;放在relative-to-action属性指定的ID的前面
after&＃xff1a;放在relative-to-action属性指定的ID的后面
relative-to-action也是的属性。
5. 运行
完成plugin.xml的修改后&＃xff0c;点击运行。会发现&＃xff0c;运行时是自动再启动新的IntelliJ IDEA。而新启动的IntelliJ IDEA由于没有可打开的项目会停留在如下界面&＃xff1a;
启动界面
为了能查看到我们的插件&＃xff0c;可以点击Create New Project或者是导入项目&＃xff0c;总之&＃xff0c;让它正确进入到开发界面就好。
接下来&＃xff0c;点击help菜单&＃xff0c;会看到如下&＃xff1a;
查看插件
点击·"Hello World"项&＃xff0c;运行如下&＃xff1a;
HelloWorld
6. 其他
6.1 自动配置plugin.xml
前面我们通过收到创建Java类&＃xff0c;然后基础AnAction类的方式创建Action。并且最后还需要收到配置plugin.xml。其实可以无需手动编写&＃xff0c;直接通过New>Action的方式创建&＃xff0c;如下图所示。
new Action
打开的图形化创建界面如下&＃xff1a;
New Action
可以看到&＃xff0c;需要填写的部分跟我们plugin.xml中的一一对应。
6.2 卸载插件
当我们按照上面的方面再创建一个插件时&＃xff0c;发现上一次的插件还会出现。而且我们创建的新的插件不会出现&＃xff0c;这是什么原因呢&＃xff1f;这主要是&＃xff0c;我们没有修改插件名称&＃xff0c;并且没有修改版本。这样的话自然就没有覆盖原先的插件了。因此我们有2种方法&＃xff0c;第一种就是将原来的插件卸载&＃xff0c;第二种就是将新建的插件名称与原先的区分开来(在plugin.xml中 标签中指定)。第二种方法比较简单&＃xff0c;我们看看第一种方法。
首先&＃xff0c;点击“File>Settings>Plugins”&＃xff0c;如下图。
卸载插件
找到插件名称&＃xff0c;这里也就是“Plugin display name here”,因为一开始我们没有修改插件名称&＃xff0c;这个名词是自动生成的。然后点击Uninstall&＃xff0c;最后重启或者是关闭IntelliJ IDEA完成卸载。
6.3 打包插件并在AndroidStudio中安装
回到主题&＃xff0c;我们开发的插件是希望运行在AndroidStudio中。因此少不了在IntelliJ中打包和在AndroidStudio中安装的过程。点击“Build>Prepare All Plugin Modules For Deployment”&＃xff0c;如下图&＃xff1a;
打包插件
这时在HelloWorld项目中多了一个HelloWorld.jar文件&＃xff0c;如下图&＃xff1a;
jar包
这个文件即为我们导出的插件。接下来打开AndroidStudio&＃xff0c;点击“File>Settings>Plugins”
安装插件
点击“install plugin from disk...”,将HelloWorld.jar包加入即可完成安装。
我在安装过程中出现如下错误(Plugin display name here为插件名称)&＃xff1a;
Error
从错误提示上看&＃xff0c;是不兼容错误。回到plugin.xml&＃xff0c;从中找到一行&＃xff1a;
这是指定IntelliJ IDEA为2016年1月发布的版本(点击这里查看对应的版本),显然&＃xff0c;我的AndroidStudio还没使用那么新的IntelliJ IDEA&＃xff0c;因此把145修改小一点就好&＃xff0c;比如我修改为105.0&＃xff0c;重新打包再安装。运行如下&＃xff1a;
Hello Wrold
点击后&＃xff1a;
运行结果
京公网安备 11010802041100号