一.开发环境
由于Android Studio是无法创建idea plugin 项目的,所以需要先安装IDEA。
-
新建一个Intellij Platform Plugin Project,如果是第一次创建需要点击new设置Project SDK。
- 在Project的resources/META-INF目录下有一个plugin.xml文件,这个文件作用是保存插件的所有配置信息,相当于Android 的AndroidManifest.xml文件。
-
在src目录下新建一个Action:src>右键>new>Action:
- Action ID :Action的唯一表示,建议以PluginName.ID的格式命名
- Class Name : Action的类名
- Name : Action显示在工具栏的名字
- Description : Action的功能描述 不是必须填写的
-
Groups : 将Action 添加的一个分组,可选的有很多,我这里选择GenerateGroup,最后就可以在Generate这一组Action中看到:
- Keyboard Shortcuts : 触发Action的快捷键
然后plugin中会自动生成配置信息:
<actions>
<!-- Add your actions here -->
<action id="Test.ID" class="TestAction" text="Test">
<add-to-group group-id="GenerateGroup" anchor="last"/>
<keyboard-shortcut keymap="$default" first-keystroke="shift alt V"/>
</action>
</actions>
4 .actionPerformed方法是程序的入口,从这里开始实现插件的功能,在这里先简单的弹出一个对话框。
public class TestAction extends AnAction {
@Override
public void actionPerformed(AnActionEvent e) {
// TODO: insert action logic here
Messages.showMessageDialog("Hello!", "Information", Messages.getInformationIcon());
}
}
5.点击Run,然后会重新启动一个Idea,在这里我们可以测试我们的程序
6.打包插件程序,右键工程目录>Prepare Plugin Module 'Test' For Deployment,然后可以得到一个jar文件,这个jar就是插件的安装包,idea可以通过Settings>Plugins>Install plugin from disk来安装插件
7.发布到idea 插件仓库:
- 首先需要注册一个帐号https://account.jetbrains.com/login
- 上传插件https://plugins.jetbrains.com/idea/plugin/add
然后在两个工作日之后就可以在idea 的插件仓库搜索到上传的插件了
二.插件开发一些API
获取当前编辑的文件
PsiFile psiFile = event.getData(LangDataKeys.PSI_FILE);
可以通过下面两种方式对文件的进行操作:
new WriteCommandAction.Simple(event.getProject(), psiFile) {
@Override
protected void run() throws Throwable {
//do something
}
}.execute();
WriteCommandAction.runWriteCommandAction(event.getProject(), new Runnable() {
@Override
public void run() {
//do something
}
});
获取当前编辑的class对象
PsiElement element = psiFile.findElementAt(editor.getCaretModel().getOffset());
PsiClass psiClass = PsiTreeUtil.getParentOfType(element, PsiClass.class);
获取类名
String className = psiClass.getNameIdentifier().getText();
获得PsiElementFactory 对象 可以通过这个工厂类创建成员变量 方法 类等等
PsiElementFactory elementFactory = JavaPsiFacade.getElementFactory(project);
添加一个方法
String methodText = buildMethodText(className);
PsiMethod psiMethod = elementFactory.createMethodFromText(methodText, psiClass);
psiClass.add(psiMethod);
private String buildMethodText (String className){
return "public static " + className + " getInstance() {\n" +
" return " + buildFiledText() + ";\n" +
" }";
}
添加一个构造方法
PsiMethod constructor = elementFactory.createConstructor();
psiClass.add(constructor);
添加一个成员变量,PsiType表示变量的类型,PsiModifierList代表变量的修饰符,可以通过setInitializer设置变量初始化方式
PsiType psiType = PsiType.getTypeByName(className, project
, GlobalSearchScope.EMPTY_SCOPE);
PsiField psiField = elementFactory.createField("mInstance", psiType);
PsiExpression psiInitializer = elementFactory.createExpressionFromText("new " + className + "()", psiField);
psiField.setInitializer(psiInitializer);
PsiModifierList modifierList = psiField.getModifierList();
if (modifierList != null) {
modifierList.setModifierProperty(PsiModifier.STATIC, true);
}
psiClass.add(psiField);
添加一个内部类
PsiClass innerClass = elementFactory.createClass(innerClassName);
PsiModifierList classModifierList = innerClass.getModifierList();
if (classModifierList != null) {
classModifierList.setModifierProperty(PsiModifier.PRIVATE, true);
classModifierList.setModifierProperty(PsiModifier.STATIC, true);
}
psiClass.add(innerClass);
其他
//创建枚举
PsiClass anEnum = elementFactory.createEnum("TestEnum");
//创建一个枚举常量
PsiEnumConstant enumConstant= elementFactory.createEnumConstantFromText("TEST",anEnum);
//创建接口
elementFactory.createInterface("TestInterface");
格式化代码
CodeStyleManager.getInstance(project).reformat(psiClass);
插件的UI都是使用java Swing来实现,比如创建一个Dialog:src>new>Dialog;然后会生成一个JDialog的java类和一个Dialog的from文件。然后在Action中使用:
TestDialog dialog = new TestDialog();
dialog.setBounds(new Rectangle(300, 200));
//让dialog居中
dialog.setLocationRelativeTo(null);
dialog.setVisible(true);
三. 一个生成单例代码的插件
为了练手,写了个小插件,可以自动生成五种单例模式(IDEA自带生成单例代码的功能,不过只有一种模式):懒汉式,饿汉式,双重检查,静态内部类和枚举。
在Android Studio或者IDEA中使用:Settings>Plugins>Browse repositories 搜索singleton,如下图,点击install 然后重启Android Studio 或者IDEA就可以使用了。
菜单栏选择Code>Generate或者使用你设置的快捷键:
选择一种单例模式:
自动生成的代码: