Android Studio 插件開發

時間 2019-11-24

標籤 android studio 插件開發欄目 Android 简体版

原文原文鏈接

這兩天一直在忙一個Android studio插件的事，爲的是簡化android開發，因此在這裏我總結一下關於插件開發的相關知識，感興趣的開發者能夠本身試一下，對於一個android開發者來講仍是頗有必要的。javascript

準備

android studio的插件開發必須用IntelliJ IDEA，不能直接在android studio中直接開發，因此首先下載IntelliJ IDEA。java

建立新工程

選擇工程類型：

建立完畢

建立一個行爲

右鍵點擊src，New->Action（在偏下面的位置）android

在彈出的對話框（如上圖所示）中填寫內容：app

我選擇的是GenerateGroup，也就是程序中郵件菜單中的generate選項。固然你也能夠添加到AS的頂部菜單中，如File，Code等等。ide

這時會生成一個Class：測試

如今咱們能夠作個測試，修改代碼：ui

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

點擊運行。
這時會啓動一個IntelliJ IDEA的程序，你隨便新建一個就能進去。
這時咱們新建一個文件，而後在文件內點擊右鍵，選擇Generate，會彈出以下一個菜單：this

這就是咱們剛剛添加進去的TESTNAME，點擊,回去看下控制檯發現打印了咱們剛纔寫的東西：idea

功能描述

上面介紹完了怎麼在IDE中插入一個按鈕行爲，可是咱們能進行什麼操做呢？下面就介紹一下。（須要將繼承的AnAction改爲BaseGenerateAction）spa

在代碼中插入方法：

插入代碼須要一個調用一個類WriteCommandAction.Simple。
咱們新建一個類繼承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方法中進行插入操做。
例如咱們插入一個方法

@Override
    protected void run() throws Throwable {
        // 將彈出dialog的方法寫在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);
    }複製代碼

而後再看一下這個方法怎麼調用：

@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();
    }複製代碼

這樣就能夠插入一個方法。

彈出一個提示

咱們也能夠在IDE中彈出一個錯誤提示：

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);
    }複製代碼

工程中查找一個文件

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

獲取用戶選中內容

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

        SelectionModel model = editor.getSelectionModel();
        //獲取選中內容
        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標籤
                if (element instanceof XmlTag) {
                    XmlTag tag = (XmlTag) element;
                  //解析include標籤
                    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()   //經過給定名稱（不包含具體路徑）搜索對應文件
ReferencesSearch.search()  //相似於IDE中的Find Usages操做
RefactoringFactory.createRename()  //重命名
FileContentUtil.reparseFiles()  //經過VirtualFile重建PSI
ClassInheritorsSearch.search()  //搜索一個類的全部子類
JavaPsiFacade.findClass()  //經過類名查找類
PsiShortNamesCache.getInstance().getClassesByName()  //經過一個短名稱（例如LogUtil）查找類
PsiClass.getSuperClass()  //查找一個類的直接父類
JavaPsiFacade.getInstance().findPackage()  //獲取Java類所在的Package
OverridingMethodsSearch.search()  //查找被特定方法重寫的方法複製代碼

生成插件

工程開發完畢，能夠點擊Build->Prepare plugin Module 'xxx' For Deployment,以後便會在工程下生成對應的xxx.jar

安裝插件

打開你的Android Studio，選擇Preferences，如圖所示：

如上圖所示，選擇Plugins，選擇上圖指示的按鈕，在選擇你剛纔生成的jar便可。

總結

基本上本文提到的方法能夠實現基本的操做，熟練掌握插件的開發，能夠加快Android開發的速度。
這裏說一下我在開發中遇到的問題

遇到的問題

添加了Action可是調試的時候發現，找不到新建的Action，多是因爲你的IntelliJ IDEA版本太高，能夠在plugin.xml中，找到idea-version標籤，將版本改到141.0或如下便可。
插入一個方法，可是運行報錯，提示不正確的方法，這是因爲你在使用上文提到的插入方法時，插入的要是一個完整的方法以public 或private或protected開頭，在開頭不能有空格，並且注意大括號不能缺失。