Android Studio 插件開(kāi)發(fā)

這兩天一直在忙一個(gè)Android studio插件的事,為的是簡(jiǎn)化android開(kāi)發(fā),所以在這里我總結(jié)一下關(guān)于插件開(kāi)發(fā)的相關(guān)知識(shí),感興趣的開(kāi)發(fā)者可以自己試一下,對(duì)于一個(gè)android開(kāi)發(fā)者來(lái)說(shuō)還是很有必要的。


準(zhǔn)備

android studio的插件開(kāi)發(fā)必須用IntelliJ IDEA,不能直接在android studio中直接開(kāi)發(fā),所以首先下載IntelliJ IDEA。

創(chuàng)建新工程

選擇工程類型:

創(chuàng)建完畢

創(chuàng)建一個(gè)行為

右鍵點(diǎn)擊src,New->Action(在偏下面的位置)

在彈出的對(duì)話框(如上圖所示)中填寫(xiě)內(nèi)容:

我選擇的是GenerateGroup,也就是程序中郵件菜單中的generate選項(xiàng)。當(dāng)然你也可以添加到AS的頂部菜單中,如File,Code等等。

這時(shí)會(huì)生成一個(gè)Class:

現(xiàn)在我們可以做個(gè)測(cè)試,修改代碼:

 @Override
    public void actionPerformed(AnActionEvent e) {
      System.out.printf("okokokokoko");
    }

點(diǎn)擊運(yùn)行。
這時(shí)會(huì)啟動(dòng)一個(gè)IntelliJ IDEA的程序,你隨便新建一個(gè)就能進(jìn)去。
這時(shí)我們新建一個(gè)文件,然后在文件內(nèi)點(diǎn)擊右鍵,選擇Generate,會(huì)彈出如下一個(gè)菜單:

這就是我們剛剛添加進(jìn)去的TESTNAME,點(diǎn)擊,回去看下控制臺(tái)發(fā)現(xiàn)打印了我們剛才寫(xiě)的東西:

功能描述

上面介紹完了怎么在IDE中插入一個(gè)按鈕行為,但是我們能進(jìn)行什么操作呢?下面就介紹一下。(需要將繼承的AnAction改成BaseGenerateAction)

在代碼中插入方法:

插入代碼需要一個(gè)調(diào)用一個(gè)類WriteCommandAction.Simple。
我們新建一個(gè)類繼承WriteCommandAction.Simple:

public class LayoutCreator extends WriteCommandAction.Simple{
    private Project project;
    private PsiFile file;
    private PsiClass targetClass;
    private PsiElementFactory factory;

    public LayoutCreator(Project project, PsiClass targetClass, PsiElementFactory factory, PsiFile... files) {
        super(project, files);
        this.project = project;
        this.file = files[0];
        this.targetClass = targetClass;
        this.factory = factory;
    }

    @Override
    protected void run() throws Throwable {
    
    }
}

我們可以在run方法中進(jìn)行插入操作。
例如我們插入一個(gè)方法

 @Override
    protected void run() throws Throwable {
        // 將彈出dialog的方法寫(xiě)在StringBuilder里
        StringBuilder dialog = new StringBuilder();
        dialog.append("public void showDialog(){");
        dialog.append("   android.support.v7.app.AlertDialog.Builder builder = new AlertDialog.Builder(this);");
        dialog.append("    builder.setTitle(\"Title\")\n");
        dialog.append(".setMessage(\"Dialog content\")\n");
        dialog.append(".setPositiveButton(\"OK\", new android.content.DialogInterface.OnClickListener() {\n" +
                "@Override\n" +
                "public void onClick(DialogInterface dialog, int which) {\n" +
                "\t\n" +
                "}" +
                "})\n");
        dialog.append(".setNegativeButton(\"Cancel\", new DialogInterface.OnClickListener() {\n" +
                "@Override\n" +
                "public void onClick(DialogInterface dialog, int which) {\n" +
                "\t\n" +
                "}" +
                "})\n");
        dialog.append(".show();");
        dialog.append("}");
       targetClass.add(factory.createMethodFromText(dialog.toString(), targetClass));
        JavaCodeStyleManager styleManager = JavaCodeStyleManager.getInstance(project);
        styleManager.optimizeImports(file);
        styleManager.shortenClassReferences(targetClass);
    }

然后再看一下這個(gè)方法怎么調(diào)用:

 @Override
    public void actionPerformed(AnActionEvent e) {
        Project project = e.getData(PlatformDataKeys.PROJECT);
        Editor editor = e.getData(PlatformDataKeys.EDITOR);
        PsiFile file = PsiUtilBase.getPsiFileInEditor(editor, project);
        PsiClass targetClass = getTargetClass(editor, file);
        PsiElementFactory factory = JavaPsiFacade.getElementFactory(project);
        new LayoutCreator(project, targetClass, factory, file).execute();
    }

這樣就可以插入一個(gè)方法。

彈出一個(gè)提示

我們也可以在IDE中彈出一個(gè)錯(cuò)誤提示:

 public static void showNotification(Project project, MessageType type, String text) {
        StatusBar statusBar = WindowManager.getInstance().getStatusBar(project);

        JBPopupFactory.getInstance()
                .createHtmlTextBalloonBuilder(text, type, null)
                .setFadeoutTime(7500)
                .createBalloon()
                .show(RelativePoint.getCenterOf(statusBar.getComponent()), Balloon.Position.atRight);
    }

工程中查找一個(gè)文件

 public static void findFile(Project project,String name){
        PsiFile[] mPsiFiles = FilenameIndex.getFilesByName(project,name, GlobalSearchScope.allScope(project));
       System.out.printf("length="+mPsiFiles.length);
    }

獲取用戶選中內(nèi)容

     Editor editor = e.getData(PlatformDataKeys.EDITOR);
        if (null == editor) {
            return;
        }

        SelectionModel model = editor.getSelectionModel();
        //獲取選中內(nèi)容
        final String selectedText = model.getSelectedText();

解析xml文件

public static ArrayList<Element> getIDsFromLayout(final PsiFile file, final ArrayList<Element> elements) {
        file.accept(new XmlRecursiveElementVisitor() {

            @Override
            public void visitElement(final PsiElement element) {
                super.visitElement(element);
                //解析XML標(biāo)簽
                if (element instanceof XmlTag) {
                    XmlTag tag = (XmlTag) element;
                  //解析include標(biāo)簽
                    if (tag.getName().equalsIgnoreCase("include")) {
                        XmlAttribute layout = tag.getAttribute("layout", null);

                        if (layout != null) {
                            Project project = file.getProject();
//                            PsiFile include = findLayoutResource(file, project, getLayoutName(layout.getValue()));
                            PsiFile include = null;
                            PsiFile[] mPsiFiles = FilenameIndex.getFilesByName(project, getLayoutName(layout.getValue())+".xml", GlobalSearchScope.allScope(project));
                            if (mPsiFiles.length>0){
                                include = mPsiFiles[0];
                            }

                            if (include != null) {
                                getIDsFromLayout(include, elements);

                                return;
                            }
                        }
                    }

                    // get element ID
                    XmlAttribute id = tag.getAttribute("android:id", null);
                    if (id == null) {
                        return; // missing android:id attribute
                    }
                    String value = id.getValue();
                    if (value == null) {
                        return; // empty value
                    }

                    // check if there is defined custom class
                    String name = tag.getName();
                    XmlAttribute clazz = tag.getAttribute("class", null);
                    if (clazz != null) {
                        name = clazz.getValue();
                    }

                    try {
                        Element e = new Element(name, value, tag);
                        elements.add(e);
                    } catch (IllegalArgumentException e) {
                        // TODO log
                    }
                }
            }
        });


        return elements;
    }

    public static String getLayoutName(String layout) {
        if (layout == null || !layout.startsWith("@") || !layout.contains("/")) {
            return null; // it's not layout identifier
        }

        String[] parts = layout.split("/");
        if (parts.length != 2) {
            return null; // not enough parts
        }

        return parts[1];
    }

其他方法

FilenameIndex.getFilesByName()   //通過(guò)給定名稱(不包含具體路徑)搜索對(duì)應(yīng)文件
ReferencesSearch.search()  //類似于IDE中的Find Usages操作
RefactoringFactory.createRename()  //重命名
FileContentUtil.reparseFiles()  //通過(guò)VirtualFile重建PSI
ClassInheritorsSearch.search()  //搜索一個(gè)類的所有子類
JavaPsiFacade.findClass()  //通過(guò)類名查找類
PsiShortNamesCache.getInstance().getClassesByName()  //通過(guò)一個(gè)短名稱(例如LogUtil)查找類
PsiClass.getSuperClass()  //查找一個(gè)類的直接父類
JavaPsiFacade.getInstance().findPackage()  //獲取Java類所在的Package
OverridingMethodsSearch.search()  //查找被特定方法重寫(xiě)的方法

生成插件

工程開(kāi)發(fā)完畢,可以點(diǎn)擊Build->Prepare plugin Module 'xxx' For Deployment,之后便會(huì)在工程下生成對(duì)應(yīng)的xxx.jar

安裝插件

打開(kāi)你的Android Studio,選擇Preferences,如圖所示:

如上圖所示,選擇Plugins,選擇上圖指示的按鈕,在選擇你剛才生成的jar即可。

總結(jié)

基本上本文提到的方法可以實(shí)現(xiàn)基本的操作,熟練掌握插件的開(kāi)發(fā),可以加快Android開(kāi)發(fā)的速度。
這里說(shuō)一下我在開(kāi)發(fā)中遇到的問(wèn)題

遇到的問(wèn)題

  • 添加了Action但是調(diào)試的時(shí)候發(fā)現(xiàn),找不到新建的Action,可能是由于你的IntelliJ IDEA版本過(guò)高,可以在plugin.xml中,找到idea-version標(biāo)簽,將版本改到141.0或以下即可。

  • 插入一個(gè)方法,但是運(yùn)行報(bào)錯(cuò),提示不正確的方法,這是由于你在使用上文提到的插入方法時(shí),插入的要是一個(gè)完整的方法以public 或private或protected開(kāi)頭,在開(kāi)頭不能有空格,而且注意大括號(hào)不能缺失。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,182評(píng)論 6 543
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 99,489評(píng)論 3 429
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人,你說(shuō)我怎么就攤上這事。” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 178,290評(píng)論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我,道長(zhǎng),這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 63,776評(píng)論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 72,510評(píng)論 6 412
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 55,866評(píng)論 1 328
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,860評(píng)論 3 447
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 43,036評(píng)論 0 290
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,585評(píng)論 1 336
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 41,331評(píng)論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 43,536評(píng)論 1 374
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,058評(píng)論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,754評(píng)論 3 349
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 35,154評(píng)論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 36,469評(píng)論 1 295
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 52,273評(píng)論 3 399
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 48,505評(píng)論 2 379

推薦閱讀更多精彩內(nèi)容