自己编写Android Studio插件

前言

R.layout.activity_main

activity_main

activity_main

findViewById()

适用Activity和Fragment

编写插件

环境

创建项目

目录结构

plugin.xml

plugin.xml

开始编写

创建一个Action，是继承AnAction类的

New->Action

填写内容

可以在

plugin.xml

里面修改对应的Action属性

编写Action

actionPerformed

思路

findViewById

获取布局文件

PsiFile

FilenameIndex.getFilesByName(project, name, scope)

// 获取project
Project project = e.getProject();
// 获取选中内容
final Editor mEditor = e.getData(PlatformDataKeys.EDITOR);
if (null == mEditor) {
return;
}
SelectionModel model = mEditor.getSelectionModel();
String selectedText = model.getSelectedText();
if (TextUtils.isEmpty(selectedText)) {
// 未选中布局内容，显示dialog
selectedText = Messages.showInputDialog(project, "layout（不需要输入R.layout.）：" , "未选中布局内容，请输入layout文件名", Messages.getInformationIcon());
if (TextUtils.isEmpty(selectedText)) {
Utils.showPopupBalloon(mEditor, "未输入layout文件名");
return;
}
}

// 获取布局文件，通过FilenameIndex.getFilesByName获取
// GlobalSearchScope.allScope(project)搜索整个项目
PsiFile[] psiFiles = FilenameIndex.getFilesByName(project, selectedText + ".xml", GlobalSearchScope.allScope(project));
if (psiFiles.length <= 0) {
Utils.showPopupBalloon(mEditor, "未找到选中的布局文件");
return;
}
XmlFile xmlFile = (XmlFile) psiFiles[0];

解析布局文件，获取属性

/**
* 获取所有id
*
* @param file
* @param elements
* @return
*/
public static java.util.List<Element> getIDsFromLayout(final PsiFile file, final java.util.List<Element> elements) {
// To iterate over the elements in a file
// 遍历一个文件的所有元素
file.accept(new XmlRecursiveElementVisitor() {

@Override
public void visitElement(PsiElement element) {
super.visitElement(element);
// 解析Xml标签
if (element instanceof XmlTag) {
XmlTag tag = (XmlTag) element;
// 获取Tag的名字（TextView）或者自定义
String name = tag.getName();
// 如果有include
if (name.equalsIgnoreCase("include")) {
// 获取布局
XmlAttribute layout = tag.getAttribute("layout", null);
// 获取project
Project project = file.getProject();
// 布局文件
XmlFile include = null;
PsiFile[] psiFiles = FilenameIndex.getFilesByName(project, getLayoutName(layout.getValue()) + ".xml", GlobalSearchScope.allScope(project));
if (psiFiles.length > 0) {
include = (XmlFile) psiFiles[0];
}
if (include != null) {
// 递归
getIDsFromLayout(include, elements);
return;
}
}
// 获取id字段属性
XmlAttribute id = tag.getAttribute("android:id", null);
if (id == null) {
return;
}
// 获取id的值
String idValue = id.getValue();
if (idValue == null) {
return;
}
XmlAttribute aClass = tag.getAttribute("class", null);
if (aClass != null) {
name = aClass.getValue();
}
// 添加到list
try {
Element e = new Element(name, idValue, tag);
elements.add(e);
} catch (IllegalArgumentException e) {

}
}
}
});

return elements;
}

/**
* layout.getValue()返回的值为@layout/layout_view
*
* @param layout
* @return
*/
public static String getLayoutName(String layout) {
if (layout == null || !layout.startsWith("@") || !layout.contains("/")) {
return null;
}

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

// 判断id正则
private static final Pattern sIdPattern = Pattern.compile("@\\+?(android:)?id/([^$]+)$", Pattern.CASE_INSENSITIVE);
// id
public String id;
// 名字如TextView
public String name;
// 命名1 aa_bb_cc; 2 aaBbCc 3 mAaBbCc
public int fieldNameType = 3;
public XmlTag xml;

/**
* 构造函数
*
* @param name View的名字
* @param id   android:id属性
* @throws IllegalArgumentException When the arguments are invalid
*/
public Element(String name, String id, XmlTag xml) {
// id
final Matcher matcher = sIdPattern.matcher(id);
if (matcher.find() && matcher.groupCount() > 1) {
this.id = matcher.group(2);
}

if (this.id == null) {
throw new IllegalArgumentException("Invalid format of view id");
}

String[] packages = name.split("\\.");
if (packages.length > 1) {
// com.example.CustomView
this.name = packages[packages.length - 1];
} else {
this.name = name;
}

this.xml = xml;
}

/**
* 获取id，R.id.id
*
* @return
*/
public String getFullID() {
StringBuilder fullID = new StringBuilder();
String rPrefix = "R.id.";
fullID.append(rPrefix);
fullID.append(id);
return fullID.toString();
}

/**
* 获取变量名
*
* @return
*/
public String getFieldName() {
String fieldName = id;
String[] names = id.split("_");
if (fieldNameType == 2) {
// aaBbCc
StringBuilder sb = new StringBuilder();
for (int i = 0; i < names.length; i++) {
if (i == 0) {
sb.append(names[i]);
} else {
sb.append(firstToUpperCase(names[i]));
}
}
fieldName = sb.toString();
} else if (fieldNameType == 3) {
// mAaBbCc
StringBuilder sb = new StringBuilder();
for (int i = 0; i < names.length; i++) {
if (i == 0) {
sb.append("m");
}
sb.append(firstToUpperCase(names[i]));
}
fieldName = sb.toString();
}
return fieldName;
}

// 第一个字母大写
public static String firstToUpperCase(String key) {
return key.substring(0, 1).toUpperCase(Locale.CHINA) + key.substring(1);
}

将代码写入action

WriteCommandAction.Simple

@Override
protected void run() throws Throwable {

}

/**
* 根据当前文件获取对应的class文件
* @param editor
* @param file
* @return
*/
protected PsiClass getTargetClass(Editor editor, PsiFile file) {
int offset = editor.getCaretModel().getOffset();
PsiElement element = file.findElementAt(offset);
if(element == null) {
return null;
} else {
PsiClass target = PsiTreeUtil.getParentOfType(element, PsiClass.class);
return target instanceof SyntheticElement ?null:target;
}
}

mClass.findMethodsByName("onCreate", false)

JavaPsiFacade.getInstance(mProject).findClass("android.app.Activity", new EverythingGlobalScope(mProject));

PsiUtilBase.getPsiFileInEditor(mEditor, project);

psiclass.add(JavaPsiFacade.getElementFactory(mProject).createMethodFromText(sbInitView.toString(), psiclass))

mFactory.mFactory.createMethodFromText(method.toString(), mClass)

onCreate.getBody().addAfter(mFactory.createStatementFromText("initView();", mClass), setContentViewStatement);

import com.intellij.codeInsight.actions.ReformatCodeProcessor;
import com.intellij.openapi.command.WriteCommandAction;
import com.intellij.openapi.command.WriteCommandAction.Simple;
import com.intellij.openapi.project.Project;
import com.intellij.psi.*;
import com.intellij.psi.codeStyle.JavaCodeStyleManager;
import com.intellij.psi.search.EverythingGlobalScope;
import entity.Element;
import org.apache.http.util.TextUtils;

import java.util.List;

public class IdCreator extends Simple {

private PsiFile mFile;
private Project mProject;
private PsiClass mClass;
private List<Element> mElements;
private PsiElementFactory mFactory;
private String mSelectText;

public IdCreator(PsiFile psiFile, PsiClass psiClass, String command, List<Element> elements, String selectText) {
super(psiClass.getProject(), command);

mFile = psiFile;
mProject = psiClass.getProject();
mClass = psiClass;
mElements = elements;
// 获取Factory
mFactory = JavaPsiFacade.getElementFactory(mProject);
mSelectText = selectText;
}

@Override
protected void run() throws Throwable {
generateFields();
generateFindViewById();
// 重写class
JavaCodeStyleManager styleManager = JavaCodeStyleManager.getInstance(mProject);
styleManager.optimizeImports(mFile);
styleManager.shortenClassReferences(mClass);
new ReformatCodeProcessor(mProject, mClass.getContainingFile(), null, false).runWithoutProgress();
}

/**
* 创建变量
*/
private void generateFields() {
for (Element element : mElements) {

// remove duplicate field
PsiField[] fields = mClass.getFields();
boolean duplicateField = false;
for (PsiField field : fields) {
String name = field.getName();
if (name != null && name.equals(element.getFieldName())) {
duplicateField = true;
break;
}
}

if (duplicateField) {
continue;
}
// 设置变量
String text = element.xml.getAttributeValue("android:text");
// text
String fromText = "private " + element.name + " " + element.getFieldName() + ";";
if (!TextUtils.isEmpty(text)) {
fromText = "/** " + text + " */\n" + fromText;
}
// 添加到class
mClass.add(mFactory.createFieldFromText(fromText, mClass));
}
}

/**
* 设置变量的值FindViewById，Activity和Fragment
*/
private void generateFindViewById() {
// 根据类名查找类
PsiClass activityClass = JavaPsiFacade.getInstance(mProject).findClass("android.app.Activity", new EverythingGlobalScope(mProject));
PsiClass activityCompatClass = JavaPsiFacade.getInstance(mProject).findClass("android.support.v7.app.AppCompatActivity", new EverythingGlobalScope(mProject));
PsiClass fragmentClass = JavaPsiFacade.getInstance(mProject).findClass("android.app.Fragment", new EverythingGlobalScope(mProject));
PsiClass fragmentV4Class = JavaPsiFacade.getInstance(mProject).findClass("android.support.v4.app.Fragment", new EverythingGlobalScope(mProject));
// 判断mClass是不是继承activityClass或者activityCompatClass
if ((activityClass != null && mClass.isInheritor(activityClass, true))
|| (activityCompatClass != null && mClass.isInheritor(activityCompatClass, true))
|| mClass.getName().contains("Activity")) {
// 判断是否有onCreate方法
if (mClass.findMethodsByName("onCreate", false).length == 0) {
StringBuilder method = new StringBuilder();
method.append("@Override protected void onCreate(android.os.Bundle savedInstanceState) {\n");
method.append("super.onCreate(savedInstanceState);\n");
method.append("\t// TODO:run FindViewById again To setValue in initView method\n");
method.append("\tsetContentView(R.layout.");
method.append(mSelectText);
method.append(");\n");
method.append("}");
// 添加
mClass.add(mFactory.createMethodFromText(method.toString(), mClass));
} else {
// 获取setContentView
PsiStatement setContentViewStatement = null;
// onCreate是否存在initView方法
boolean hasInitViewStatement = false;

PsiMethod onCreate = mClass.findMethodsByName("onCreate", false)[0];
for (PsiStatement psiStatement : onCreate.getBody().getStatements()) {
// 查找setContentView
if (psiStatement.getFirstChild() instanceof PsiMethodCallExpression) {
PsiReferenceExpression methodExpression = ((PsiMethodCallExpression) psiStatement.getFirstChild()).getMethodExpression();
if (methodExpression.getText().equals("setContentView")) {
setContentViewStatement = psiStatement;
} else if (methodExpression.getText().equals("initView")) {
hasInitViewStatement = true;
}
}
}

if (!hasInitViewStatement && setContentViewStatement != null) {
// 将initView()写到setContentView()后面
onCreate.getBody().addAfter(mFactory.createStatementFromText("initView();", mClass), setContentViewStatement);
}

generatorLayoutCode(null);
}

// 判断mClass是不是继承fragmentClass或者fragmentV4Class
} else if ((fragmentClass != null && mClass.isInheritor(fragmentClass, true))
|| (fragmentV4Class != null && mClass.isInheritor(fragmentV4Class, true))
|| mClass.getName().contains("Fragment")) {
// 判断是否有onCreateView方法
if (mClass.findMethodsByName("onCreateView", false).length == 0) {
StringBuilder method = new StringBuilder();
method.append("@Override public View onCreateView(android.view.LayoutInflater inflater, android.view.ViewGroup container, android.os.Bundle savedInstanceState) {\n");
method.append("\t// TODO: run FindViewById again To setValue in initView method\n");
method.append("\tView view = View.inflate(getActivity(), R.layout.");
method.append(mSelectText);
method.append(", null);");
method.append("return view;");
method.append("}");
// 添加
mClass.add(mFactory.createMethodFromText(method.toString(), mClass));

} else {
// 查找onCreateView
PsiReturnStatement returnStatement = null;
// view
String returnValue = null;
// onCreateView是否存在initView方法
boolean hasInitViewStatement = false;

PsiMethod onCreate = mClass.findMethodsByName("onCreateView", false)[0];
for (PsiStatement psiStatement : onCreate.getBody().getStatements()) {
if (psiStatement instanceof PsiReturnStatement) {
// 获取view的值
returnStatement = (PsiReturnStatement) psiStatement;
returnValue = returnStatement.getReturnValue().getText();
} else if (psiStatement.getFirstChild() instanceof PsiMethodCallExpression) {
PsiReferenceExpression methodExpression = ((PsiMethodCallExpression) psiStatement.getFirstChild()).getMethodExpression();
if (methodExpression.getText().equals("initView")) {
hasInitViewStatement = true;
}
}
}

if (!hasInitViewStatement && returnStatement != null && returnValue != null) {
onCreate.getBody().addBefore(mFactory.createStatementFromText("initView(" + returnValue + ");", mClass), returnStatement);
}
generatorLayoutCode(returnValue);
}
}
}

/**
* 写initView方法
*
* @param findPre Fragment的话要view.findViewById
*/
private void generatorLayoutCode(String findPre) {
// 判断是否已有initView方法
PsiMethod[] initViewMethods = mClass.findMethodsByName("initView", false);
if (initViewMethods.length > 0 && initViewMethods[0].getBody() != null) {
PsiCodeBlock initViewMethodBody = initViewMethods[0].getBody();
for (Element element : mElements) {
String pre = TextUtils.isEmpty(findPre) ? "" : findPre + ".";
String s2 = element.getFieldName() + " = (" + element.name + ") " + pre + "findViewById(" + element.getFullID() + ");";
initViewMethodBody.add(mFactory.createStatementFromText(s2, initViewMethods[0]));
}
} else {
StringBuilder initView = new StringBuilder();
if (TextUtils.isEmpty(findPre)) {
initView.append("private void initView() {\n");
} else {
initView.append("private void initView(View " + findPre + ") {\n");
}

for (Element element : mElements) {
String pre = TextUtils.isEmpty(findPre) ? "" : findPre + ".";
initView.append(element.getFieldName() + " = (" + element.name + ")" + pre + "findViewById(" + element.getFullID() + ");\n");
}
initView.append("}\n");
mClass.add(mFactory.createMethodFromText(initView.toString(), mClass));
}

}
}

使用插件

Build->Prepare All Plugin Modules For Deployment

Install plugin from disk...

发布插件

感谢