1.概述
上一期我們已經(jīng)分享了Android Studio插件開發(fā)之 - 基礎(chǔ)入門篇。那么現(xiàn)在我們來動(dòng)手寫一個(gè)IOC注解生成器,有點(diǎn)類似于ButterKnife的插件一樣自動(dòng)給我們生成代碼，在網(wǎng)上找了很多資料國內(nèi)基本就在HelloWorld階段，也有很多哥們向我反應(yīng)插件的代碼還是有點(diǎn)蒙B。代碼方面能理解就理解，不理解也不強(qiáng)求，如果你能改一改別人已經(jīng)寫好的插件就最好了，實(shí)在不行我們干脆也別折騰了大不了不用，本文章旨在給自己想寫一些奇葩插件的哥們一些引導(dǎo)。
廢話不多說，請(qǐng)看具體效果：
GIF.gif
自動(dòng)生成注解代碼，跟ButterKnife的插件類似,但是我們自己寫的插件生成的注解代碼更加符合google源碼規(guī)范，而且是基于我們自己動(dòng)手打造一套IOC注解框架。當(dāng)然我們可以去參考ButterKnife的插件是怎么寫的，但是我看了一下里面的東西太多了，我們干脆自己來吧。
所有分享大綱：2017Android進(jìn)階之路與你同行
視頻講解地址：http://pan.baidu.com/s/1gf40cV5
2.實(shí)現(xiàn)
2.1 思路整理
我們先來整理一下思路，要實(shí)現(xiàn)這么個(gè)插件我們需要做一些什么東東：
- 獲取光標(biāo)所在行的布局文件 --> R.layout.xxxx.xml；
- 搜索整個(gè)項(xiàng)目獲取到R.layout.xxxx.xml文件；
- 通過該布局文件去遍歷找出含有id的布局標(biāo)簽，當(dāng)然如果考慮完善一點(diǎn)需要考慮include等等；
- 遍歷完成后生成對(duì)話框，讓用戶可以自己選擇需要生成注解的View以及點(diǎn)擊事件，這個(gè)是Java GUI里面的內(nèi)容
- 最后當(dāng)用戶點(diǎn)擊確定生成最終的注解代碼即可
這么說起來還是挺簡單的，當(dāng)然其中的細(xì)節(jié)還是讓人很蛋疼的，需要不斷反復(fù)的調(diào)試。
2.2 具體實(shí)現(xiàn)
- 獲取光標(biāo)所在行的布局文件 --> R.layout.xxxx.xml；
/**
* 獲取當(dāng)前光標(biāo)的layout文件
*/
private String getCurrentLayout(Editor editor) {
Document document = editor.getDocument();
CaretModel caretModel = editor.getCaretModel();
int caretOffset = caretModel.getOffset();
int lineNum = document.getLineNumber(caretOffset);
int lineStartOffset = document.getLineStartOffset(lineNum);
int lineEndOffset = document.getLineEndOffset(lineNum);
// 獲取當(dāng)前光標(biāo)所在行的所有內(nèi)容
String lineContent = document.getText(new TextRange(lineStartOffset, lineEndOffset));
String layoutMatching = "R.layout.";
if (!TextUtils.isEmpty(lineContent) && lineContent.contains(layoutMatching)) {
// 獲取layout文件的字符串
int startPosition = lineContent.indexOf(layoutMatching) + layoutMatching.length();
int endPosition = lineContent.indexOf(")", startPosition);
String layoutStr = lineContent.substring(startPosition, endPosition);
// 可能是另外一種情況 View.inflate
if (layoutStr.contains(",")) {
endPosition = lineContent.indexOf(",", startPosition);
layoutStr = lineContent.substring(startPosition, endPosition);
}
return layoutStr;
}
return null;
}
- 搜索整個(gè)項(xiàng)目獲取到R.layout.xxxx.xml文件；
@Override
public void actionPerformed(AnActionEvent e) {
// 獲取project
Project project = e.getProject();
// 獲取選中內(nèi)容
final Editor mEditor = e.getData(PlatformDataKeys.EDITOR);
if (null == mEditor) {
return;
}
SelectionModel model = mEditor.getSelectionModel();
mSelectedText = model.getSelectedText();
// 未選中布局內(nèi)容，顯示dialog
if (TextUtils.isEmpty(mSelectedText)) {
// 獲取光標(biāo)所在位置的布局
mSelectedText = getCurrentLayout(mEditor);
if (TextUtils.isEmpty(mSelectedText)) {
mSelectedText = Messages.showInputDialog(project, "布局內(nèi)容：（不需要輸入R.layout.）", "未選中布局內(nèi)容，請(qǐng)輸入layout文件名", Messages.getInformationIcon());
if (TextUtils.isEmpty(mSelectedText)) {
Util.showPopupBalloon(mEditor, "未輸入layout文件名", 5);
return;
}
}
}
// 獲取布局文件，通過FilenameIndex.getFilesByName獲取
// GlobalSearchScope.allScope(project)搜索整個(gè)項(xiàng)目
PsiFile[] psiFiles = FilenameIndex.getFilesByName(project, mSelectedText + ".xml", GlobalSearchScope.allScope(project));
if (psiFiles.length <= 0) {
Util.showPopupBalloon(mEditor, "未找到選中的布局文件" + mSelectedText, 5);
return;
}
XmlFile xmlFile = (XmlFile) psiFiles[0];
List<Element> elements = new ArrayList<>();
Util.getIDsFromLayout(xmlFile, elements);
// 將代碼寫入文件，不允許在主線程中進(jìn)行實(shí)時(shí)的文件寫入
if (elements.size() != 0) {
PsiFile psiFile = PsiUtilBase.getPsiFileInEditor(mEditor, project);
PsiClass psiClass = Util.getTargetClass(mEditor, psiFile);
// 有的話就創(chuàng)建變量和findViewById
if (mDialog != null && mDialog.isShowing()) {
mDialog.cancelDialog();
}
mDialog = new FindViewByIdDialog(mEditor, project, psiFile, psiClass, elements, mSelectedText);
mDialog.showDialog();
} else {
Util.showPopupBalloon(mEditor, "未找到任何Id", 5);
}
}
- 通過該布局文件去遍歷找出含有id的布局標(biāo)簽，當(dāng)然如果考慮完善一點(diǎn)需要考慮include等等；
/**
* 獲取所有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
// 遍歷一個(gè)文件的所有元素
file.accept(new XmlRecursiveElementVisitor() {
@Override
public void visitElement(PsiElement element) {
super.visitElement(element);
// 解析Xml標(biāo)簽
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;
}
- 遍歷完成后生成對(duì)話框，讓用戶可以自己選擇需要生成注解的View以及點(diǎn)擊事件，這個(gè)是Java GUI里面的內(nèi)容，我就大致黏貼一部分代碼把，把對(duì)話框中間的部分黏貼出來，具體可以去github下載源碼
/**
* 解析mElements，并添加到JPanel
*/
private void initContentPanel() {
mContentJPanel.removeAll();
// 設(shè)置內(nèi)容
for (int i = 0; i < mElements.size(); i++) {
Element mElement = mElements.get(i);
IdBean itemJPanel = new IdBean(new GridLayout(1, 4, 10, 10),
new EmptyBorder(5, 10, 5, 10),
new JCheckBox(mElement.getName()),
new JLabel(mElement.getId()),
new JCheckBox(),
new JTextField(mElement.getFieldName()),
mElement);
// 監(jiān)聽
itemJPanel.setEnableActionListener(this);
itemJPanel.setClickActionListener(clickCheckBox -> mElement.setIsCreateClickMethod(clickCheckBox.isSelected()));
itemJPanel.setFieldFocusListener(fieldJTextField -> mElement.setFieldName(fieldJTextField.getText()));
mContentJPanel.add(itemJPanel);
mContentConstraints.fill = GridBagConstraints.HORIZONTAL;
mContentConstraints.gridwidth = 0;
mContentConstraints.gridx = 0;
mContentConstraints.gridy = i;
mContentConstraints.weightx = 1;
mContentLayout.setConstraints(itemJPanel, mContentConstraints);
}
mContentJPanel.setLayout(mContentLayout);
jScrollPane = new JBScrollPane(mContentJPanel);
jScrollPane.revalidate();
// 添加到JFrame
getContentPane().add(jScrollPane, 1);
}
/**
* 創(chuàng)建注解View變量
*/
private void generateFields() {
for (Element element : mElements) {
if (mClass.getText().contains("@ViewById(" + element.getFullID() + ")")) {
// 不創(chuàng)建新的變量
continue;
}
// 設(shè)置變量名，獲取text里面的內(nèi)容
String text = element.getXml().getAttributeValue("android:text");
if (TextUtils.isEmpty(text)) {
// 如果是text為空，則獲取hint里面的內(nèi)容
text = element.getXml().getAttributeValue("android:hint");
}
// 如果是@string/app_name類似
if (!TextUtils.isEmpty(text) && text.contains("@string/")) {
text = text.replace("@string/", "");
// 獲取strings.xml
PsiFile[] psiFiles = FilenameIndex.getFilesByName(mProject, "strings.xml", GlobalSearchScope.allScope(mProject));
if (psiFiles.length > 0) {
for (PsiFile psiFile : psiFiles) {
// 獲取src\main\res\values下面的strings.xml文件
String dirName = psiFile.getParent().toString();
if (dirName.contains("src\\main\\res\\values")) {
text = Util.getTextFromStringsXml(psiFile, text);
}
}
}
}
StringBuilder fromText = new StringBuilder();
if (!TextUtils.isEmpty(text)) {
fromText.append("/****" + text + "****/\n");
}
fromText.append("@ViewById(" + element.getFullID() + ")\n");
fromText.append("private ");
fromText.append(element.getName());
fromText.append(" ");
fromText.append(element.getFieldName());
fromText.append(";");
// 創(chuàng)建點(diǎn)擊方法
if (element.isCreateFiled()) {
// 添加到class
mClass.add(mFactory.createFieldFromText(fromText.toString(), mClass));
}
}
}
/**
* 創(chuàng)建OnClick方法
*/
private void generateOnClickMethod() {
for (Element element : mElements) {
// 可以使用并且可以點(diǎn)擊
if (element.isCreateClickMethod()) {
// 需要?jiǎng)?chuàng)建OnClick方法
String methodName = getClickMethodName(element) + "Click";
PsiMethod[] onClickMethods = mClass.findMethodsByName(methodName, true);
boolean clickMethodExist = onClickMethods.length > 0;
if (!clickMethodExist) {
// 創(chuàng)建點(diǎn)擊方法
createClickMethod(methodName, element);
}
}
}
}
/**
* 創(chuàng)建一個(gè)點(diǎn)擊事件
*/
private void createClickMethod(String methodName, Element element) {
// 拼接方法的字符串
StringBuilder methodBuilder = new StringBuilder();
methodBuilder.append("@OnClick(" + element.getFullID() + ")\n");
methodBuilder.append("private void " + methodName + "(" + element.getName() + " " + getClickMethodName(element) + "){");
methodBuilder.append("\n}");
// 創(chuàng)建OnClick方法
mClass.add(mFactory.createMethodFromText(methodBuilder.toString(), mClass));
}
/**
* 獲取點(diǎn)擊方法的名稱
*/
public String getClickMethodName(Element element) {
String[] names = element.getId().split("_");
// aaBbCc
StringBuilder sb = new StringBuilder();
for (int i = 0; i < names.length; i++) {
if (i == 0) {
sb.append(names[i]);
} else {
sb.append(Util.firstToUpperCase(names[i]));
}
}
return sb.toString();
}
如果在公司的時(shí)候比較閑比如說我，那么還是可以去了解一下插件開發(fā)的，我們可以利用它去生成代碼或者修改代碼找沒有用到的資源等等等等，還是蠻不錯(cuò)的，如果是天天加班還是應(yīng)該考慮一下學(xué)習(xí)成本，因?yàn)橛行┑胤絼偨佑|還是容易蒙B。
附上源碼地址：https://github.com/Shenmowen/DarrenIOC
所有分享大綱：2017Android進(jìn)階之路與你同行
