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閱讀 227,882評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,208評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,746評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,666評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,477評論 6 407
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,960評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,047評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,200評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,726評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,617評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,807評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,327評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,049評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,425評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,674評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,432評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,769評論 2 372

推薦閱讀更多精彩內容