Android Studio插件开发之 - IOC注解生成器

红橙Darren
• 阅读 1351

1.概述


上一期我们已经分享了Android Studio插件开发之 - 基础入门篇。那么现在我们来动手写一个IOC注解生成器,有点类似于ButterKnife的插件一样自动给我们生成代码,在网上找了很多资料国内基本就在HelloWorld阶段,也有很多哥们向我反应插件的代码还是有点蒙B。代码方面能理解就理解,不理解也不强求,如果你能改一改别人已经写好的插件就最好了,实在不行我们干脆也别折腾了大不了不用,本文章旨在给自己想写一些奇葩插件的哥们一些引导。
  废话不多说,请看具体效果:

Android Studio插件开发之 - IOC注解生成器

GIF.gif

  自动生成注解代码,跟ButterKnife的插件类似,但是我们自己写的插件生成的注解代码更加符合google源码规范,而且是基于我们自己动手打造一套IOC注解框架。当然我们可以去参考ButterKnife的插件是怎么写的,但是我看了一下里面的东西太多了,我们干脆自己来吧。

所有分享大纲:2017Android进阶之路与你同行

视频讲解地址:http://pan.baidu.com/s/1gf40cV5

2.实现


2.1 思路整理

我们先来整理一下思路,要实现这么个插件我们需要做一些什么东东:

  • 获取光标所在行的布局文件 --> R.layout.xxxx.xml;
  • 搜索整个项目获取到R.layout.xxxx.xml文件;
  • 通过该布局文件去遍历找出含有id的布局标签,当然如果考虑完善一点需要考虑include等等;
  • 遍历完成后生成对话框,让用户可以自己选择需要生成注解的View以及点击事件,这个是Java GUI里面的内容
  • 最后当用户点击确定生成最终的注解代码即可

这么说起来还是挺简单的,当然其中的细节还是让人很蛋疼的,需要不断反复的调试。

2.2 具体实现

  • 获取光标所在行的布局文件 --> R.layout.xxxx.xml;
 /**
     * 获取当前光标的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);
        // 获取当前光标所在行的所有内容
        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;
    } 
  • 搜索整个项目获取到R.layout.xxxx.xml文件;
 @Override
    public void actionPerformed(AnActionEvent e) {
        // 获取project
        Project project = e.getProject();
        // 获取选中内容
        final Editor mEditor = e.getData(PlatformDataKeys.EDITOR);
        if (null == mEditor) {
            return;
        }
        SelectionModel model = mEditor.getSelectionModel();
        mSelectedText = model.getSelectedText();
        // 未选中布局内容,显示dialog
        if (TextUtils.isEmpty(mSelectedText)) {
            // 获取光标所在位置的布局
            mSelectedText = getCurrentLayout(mEditor);
            if (TextUtils.isEmpty(mSelectedText)) {
                mSelectedText = Messages.showInputDialog(project, "布局内容:(不需要输入R.layout.)", "未选中布局内容,请输入layout文件名", Messages.getInformationIcon());
                if (TextUtils.isEmpty(mSelectedText)) {
                    Util.showPopupBalloon(mEditor, "未输入layout文件名", 5);
                    return;
                }
            }
        }
        // 获取布局文件,通过FilenameIndex.getFilesByName获取
        // GlobalSearchScope.allScope(project)搜索整个项目
        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);
        // 将代码写入文件,不允许在主线程中进行实时的文件写入
        if (elements.size() != 0) {
            PsiFile psiFile = PsiUtilBase.getPsiFileInEditor(mEditor, project);
            PsiClass psiClass = Util.getTargetClass(mEditor, psiFile);
            // 有的话就创建变量和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的布局标签,当然如果考虑完善一点需要考虑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
    // 遍历一个文件的所有元素
    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;
} 
  • 遍历完成后生成对话框,让用户可以自己选择需要生成注解的View以及点击事件,这个是Java GUI里面的内容,我就大致黏贴一部分代码把,把对话框中间的部分黏贴出来,具体可以去github下载源码
 /**
     * 解析mElements,并添加到JPanel
     */
    private void initContentPanel() {
        mContentJPanel.removeAll();
        // 设置内容
        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);
            // 监听
            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);
    } 
  • 最后当用户点击确定生成最终的注解代码即可,主要生成两部分代码@ViewById(R.id.xxx) , @OnClick(R.id.xxx)即可
 /**
     * 创建注解View变量
     */
    private void generateFields() {
        for (Element element : mElements) {
            if (mClass.getText().contains("@ViewById(" + element.getFullID() + ")")) {
                // 不创建新的变量
                continue;
            }
            // 设置变量名,获取text里面的内容
            String text = element.getXml().getAttributeValue("android:text");
            if (TextUtils.isEmpty(text)) {
                // 如果是text为空,则获取hint里面的内容
                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(";");
            // 创建点击方法
            if (element.isCreateFiled()) {
                // 添加到class
                mClass.add(mFactory.createFieldFromText(fromText.toString(), mClass));
            }
        }
    }

    /**
     * 创建OnClick方法
     */
    private void generateOnClickMethod() {
        for (Element element : mElements) {
            // 可以使用并且可以点击
            if (element.isCreateClickMethod()) {
                // 需要创建OnClick方法
                String methodName = getClickMethodName(element) + "Click";
                PsiMethod[] onClickMethods = mClass.findMethodsByName(methodName, true);
                boolean clickMethodExist = onClickMethods.length > 0;
                if (!clickMethodExist) {
                    // 创建点击方法
                    createClickMethod(methodName, element);
                }
            }
        }
    }

    /**
     * 创建一个点击事件
     */
    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}");
        // 创建OnClick方法
        mClass.add(mFactory.createMethodFromText(methodBuilder.toString(), mClass));
    }

    /**
     * 获取点击方法的名称
     */
    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();
    } 

如果在公司的时候比较闲比如说我,那么还是可以去了解一下插件开发的,我们可以利用它去生成代码或者修改代码找没有用到的资源等等等等,还是蛮不错的,如果是天天加班还是应该考虑一下学习成本,因为有些地方刚接触还是容易蒙B。

附上源码地址:https://github.com/Shenmowen/DarrenIOC

所有分享大纲:2017Android进阶之路与你同行

视频讲解地址:http://pan.baidu.com/s/1gf40cV5

点赞
收藏
评论区
推荐文章
blmius blmius
3年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
待兔 待兔
3个月前
手写Java HashMap源码
HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22
Jacquelyn38 Jacquelyn38
3年前
2020年前端实用代码段,为你的工作保驾护航
有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
Easter79 Easter79
3年前
Twitter的分布式自增ID算法snowflake (Java版)
概述分布式系统中,有一些需要使用全局唯一ID的场景,这种时候为了防止ID冲突可以使用36位的UUID,但是UUID有一些缺点,首先他相对比较长,另外UUID一般是无序的。有些时候我们希望能使用一种简单一些的ID,并且希望ID能够按照时间有序生成。而twitter的snowflake解决了这种需求,最初Twitter把存储系统从MySQL迁移
Wesley13 Wesley13
3年前
00:Java简单了解
浅谈Java之概述Java是SUN(StanfordUniversityNetwork),斯坦福大学网络公司)1995年推出的一门高级编程语言。Java是一种面向Internet的编程语言。随着Java技术在web方面的不断成熟,已经成为Web应用程序的首选开发语言。Java是简单易学,完全面向对象,安全可靠,与平台无关的编程语言。
Stella981 Stella981
3年前
Django中Admin中的一些参数配置
设置在列表中显示的字段,id为django模型默认的主键list_display('id','name','sex','profession','email','qq','phone','status','create_time')设置在列表可编辑字段list_editable
Stella981 Stella981
3年前
Eclipse插件开发_学习_00_资源帖
一、官方资料 1.eclipseapi(https://www.oschina.net/action/GoToLink?urlhttp%3A%2F%2Fhelp.eclipse.org%2Fmars%2Findex.jsp%3Ftopic%3D%252Forg.eclipse.platform.doc.isv%252Fguide%2
Wesley13 Wesley13
3年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
Python进阶者 Python进阶者
9个月前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这