AndroidStudio/IDEA插件开发学习

一.开发环境

由于Android Studio是无法创建idea plugin 项目的,所以需要先安装IDEA

  1. 新建一个Intellij Platform Plugin Project,如果是第一次创建需要点击new设置Project SDK。


  2. 在Project的resources/META-INF目录下有一个plugin.xml文件,这个文件作用是保存插件的所有配置信息,相当于Android 的AndroidManifest.xml文件。
  3. 在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 插件仓库:

二.插件开发一些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或者使用你设置的快捷键:

选择一种单例模式:

自动生成的代码:


intellij官方文档
GitHub地址

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,457评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,837评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,696评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,183评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,057评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,105评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,520评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,211评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,482评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,574评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,353评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,897评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,489评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,683评论 2 335

推荐阅读更多精彩内容