快捷導(dǎo)航

AndroidStuio插件開發(fā)適用于jetbrains全家桶

更新時間：2020年12月16日 14:37:45 作者：Huang兄

這篇文章主要介紹了AndroidStuio插件開發(fā)適用于jetbrains全家桶,本文通過實例給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下

寫了個類似Butter Knife的開發(fā)庫，但是并沒有與其配套的AndroidStudio插件，抽時間研究了以下IDEA的api文檔，擼了一個對應(yīng)的插件，源碼在這里
之前寫的一些小demo可以看看這篇文章
初步編寫IDEA\AndroidStudio翻譯插件
以及另外一個插件項目
https://github.com/huangyuanlove/VariableNameStyleTransfer

本項目代碼參考 android-butterknife-zelezny

所用到的知識點：

查找文件
解析xml
寫文件

IDEA插件開發(fā)文檔：https://jetbrains.org/intellij/sdk/docs/intro/welcome.html

創(chuàng)建項目

官方推薦創(chuàng)建gradle項目，這里貼個圖，創(chuàng)建過程按照官網(wǎng)敘述的創(chuàng)建就好

https://jetbrains.org/intellij/sdk/docs/tutorials/build_system/prerequisites.html

這里說明一下，如果想要在AndroidStudio中進行debug，閱讀一下這個

https://jetbrains.org/intellij/sdk/docs/products/android_studio.html

也就是在項目根目錄的的build.gradle中配置 intellij和runIde，具體含義可在網(wǎng)頁中找到，這里不再贅述

// See https://github.com/JetBrains/gradle-intellij-plugin/
intellij {
 version '201.8743.12'
 type 'IC'
 plugins = ['android', 'java']
}
runIde {
 // Absolute path to installed target 3.5 Android Studio to use as IDE Development Instance
 // The "Contents" directory is macOS specific.
// ideDirectory '/Applications/Android Studio.app/Contents' //for mac
// ideDirectory '/home/huangyuan/androidStudio' //for linux
 ideDirectory 'G:\\AndroidStudio' //for window
}

在這里插入圖片描述

創(chuàng)建類

創(chuàng)建一個繼承AnAction 的類，這里創(chuàng)建的方式有兩種，一個是直接創(chuàng)建java類，然后再去注冊；另外一個就是通過想到直接創(chuàng)建(就像我們創(chuàng)建Activity一樣)；

具體可以看這里 https://jetbrains.org/intellij/sdk/docs/tutorials/action_system/working_with_custom_actions.html

這里我們需要解析layout文件(xml文件)并且還要寫入文件，所以就直接繼承BaseGenerateAction，重寫其中的兩個方法

 @Override
 public void update(@NotNull AnActionEvent e) {
 // Using the event, evaluate the context, and enable or disable the action.
 e.getPresentation().setEnabledAndVisible(e.getProject() != null);
 }
 @Override
 public void actionPerformed(@NotNull AnActionEvent event) {
 // Using the event, implement an action. For example, create and show a dialog.
 }

當(dāng)工程處于indexing的時候，我們不想讓插件生效，可以實現(xiàn)DumbAware接口，繼續(xù)向actionPerformed方法中添加邏輯

 @Override
 public void actionPerformed(@NotNull AnActionEvent event) {
 //獲取工程對象，具體信息可以看這里 https://jetbrains.org/intellij/sdk/docs/basics/project_structure.html
 Project project = event.getData(PlatformDataKeys.PROJECT);
 if(project ==null){
  return ;
 }
 Editor editor = event.getData(PlatformDataKeys.EDITOR);
 if(editor ==null){
  return;
 }
 DumbService dumbService = DumbService.getInstance(project);
 if (dumbService.isDumb()) {
  dumbService.showDumbModeNotification("ViewInject plugin is not available during indexing");
  return;
 }
 //這里是我們自己的邏輯
 analyze(project, editor);
 }

獲取文件

我們可以獲取到當(dāng)前光標(biāo)所指向的位置，也可以獲取當(dāng)前選中的字符，我們從官方文檔中找到我們自己需要的東西：需要看一下PSI(Program Structure Interface),具體信息在這里https://jetbrains.org/intellij/sdk/docs/basics/architectural_overview/psi.html

關(guān)鍵信息在PSI element 和 PSI Files，項目的中的具體邏輯在GetLayoutFileUtil.java，這里比較麻煩一些，用到了Module和GlobalSearchScope這兩個類，具體可以看這里https://jetbrains.org/intellij/sdk/docs/reference_guide/project_model/module.html ，就不再抄一遍+翻譯了

解析文件

這里我們拿到了對應(yīng)的layout.xml文件對象，一個PsiFile對象，調(diào)用文件的遍歷方法layoutFile.accept(PsiElementVisitor visitor)，這里我們傳入XmlRecursiveElementVisitor實例對象，在解析xml的過程中，我們可能會遇到<include>標(biāo)簽，需要繼續(xù)解析該標(biāo)簽下的xml文件，這里搞個遞歸。

展示解析內(nèi)容

解析出來的數(shù)據(jù)存入ArrayList中，在解析過程中，保存了對應(yīng)id、判斷是否引用了android name space中id、將id的值轉(zhuǎn)化為對應(yīng)的字段名字、保存了是是否為自定義的view等信息

 public String id;
 public boolean isAndroidNS = false;
 public String nameFull; // element name with package
 public String name; // element name
 public String fieldName; // name of variable
 public boolean isValid = false;
 public boolean used = true;
 public boolean isClick = true;

展示解析內(nèi)容使用javax.swing組件，這個也沒什么好說的。

在這里插入圖片描述

在展示面板上提供的全選功能；提供了生成代碼的兩種格式

@BindView(idStr = "xxxx") //可在library、application中使用
@BindView(id = R.id.xxx) //僅在application中使用

因為在library中生成的R文件中的變量不是final類型，并且application中的R文件變量，在gradle plugin 5.0之后也不再是final的，所以建議使用idStr的方式，也是默認(rèn)生成的代碼

寫入文件

為了方便，寫入文件的時候使用的是PsiClass對象進行操作的，源碼在這里，至于如何操作PsiFile，可以看這里。寫入文件的過程，看起來個使用javapoet差不多，javapoet可以看這里，github上直接搜索即可

private void generateClick() {
 for (ElementBean element : mElements) {
 if (element.isClick) {
 StringBuilder method = new StringBuilder();
 method.append("@ClickResponder(" + element.getGenerateValue(generateId) + ")");
 method.append("public void onClick" + Utils.capitalize(element.fieldName) + " (View v) {}");
 mClass.add(mFactory.createMethodFromText(method.toString(), mClass));
 }
 }
}

在寫入類字段的時候，需要判斷是否需要添加前綴，在Constant中列舉了一些需要特殊處理的對象

protected void generateFields() {
 for (ElementBean element : mElements) {
  if (!element.used) {
  continue;
  }

  StringBuilder injection = new StringBuilder();
  injection.append("@BindView");
  injection.append('(');
  injection.append(element.getGenerateValue(generateId));
  injection.append(")");
  if (element.nameFull != null && element.nameFull.length() > 0) { // custom package+class
  injection.append(element.nameFull);
  } else if (Constant.paths.containsKey(element.name)) { // listed class
  injection.append(Constant.paths.get(element.name));
  } else { // android.widget
  injection.append("android.widget.");
  injection.append(element.name);
  }
  injection.append(" ");
  injection.append(element.fieldName);
  injection.append(";");
  mClass.add(mFactory.createFieldFromText(injection.toString(), mClass));
 }
 }

寫入完成后格式化一下代買，要不然寫入的字段會是這樣：android.widget.TextView userNameTextView

JavaCodeStyleManager styleManager = JavaCodeStyleManager.getInstance(mProject);
styleManager.optimizeImports(mFile);
styleManager.shortenClassReferences(mClass);
new ReformatCodeProcessor(mProject, mClass.getContainingFile(), null, false).runWithoutProgress();

到此為止，就已經(jīng)完成了我們的工作。

到此這篇關(guān)于AndroidStuio插件開發(fā)適用于jetbrains全家桶的文章就介紹到這了,更多相關(guān)AndroidStuio插件開發(fā)jetbrains全家桶內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: