阅读 1746

Android Studio Plugin 插件开发教程(二) —— 插件SDK中的常用对象介绍

项目源码

github.com/boredream/A…

系列教程

Android Studio Plugin 插件开发教程(一) —— 开发你的第一个插件

Android Studio Plugin 插件开发教程(二) —— 插件SDK中的常用对象介绍

Android Studio Plugin 插件开发教程(三) —— 制作一个自动生成数据库代码的插件

Android Studio Plugin 插件开发教程(四) —— 为自动生成数据库代码的插件添加UI


先树立一个概念,AS里项目的一切都可以视为对象,比如整个项目,项目里的每个文件,文件里的每个方法、每行语句等等都是一个对象。我们插件SDK的开发,主要工作就是针对这一个个的对象的分析和处理

下面开始介绍几个主要的对象类

Virtual File

虚拟文件类。
可以当做Java开发中的File对象理解,概念比较类似

获取方法

  • 通过Action获取: event.getData(PlatformDataKeys.VIRTUAL_FILE).
    这个也是之前教程(一)中的获取方法
  • 通过本地文件路径获取: LocalFileSystem.getInstance().findFileByIoFile()
  • 通过PSI file获取: psiFile.getVirtualFile()
  • 通过document获取: FileDocumentManager.getInstance().getFile()

用处

传统的文件操作方法这个对象都支持,比如获取文件内容,重命名,移动,删除等


PSI File

PSI系统下的文件类。

获取方法

  • 通过Action获取: e.getData(LangDataKeys.PSI_FILE).
  • 通过VirtualFile获取: PsiManager.getInstance(project).findFile()
  • 通过document获取: PsiDocumentManager.getInstance(project).getPsiFile()
  • 通过文件中的Element元素获取: psiElement.getContainingFile()
    如果要通过名字获取,请使用 FilenameIndex.getFilesByName(project, name, scope)

用处

作为PSI系统中的一个元素,可以使用PSI Element的各种具体方法


看到这里肯定很多人一脸迷惑,这俩File有啥区别?PSI是啥?Element又是啥?

什么是PSI系统?

PSI 是 Program Structure Interface 的简写。从名字可以看出来它是一个接口,相当于把项目中的一切都封装了起来,比如类、方法、语句等,让他们都成为了同一个系统内的实现。封装的对象类都统一加了个前缀比如PsiClass、PsiMethod等。

Virtual File 和 PSI File的区别?

如果学过Dom和Parse解析就很好理解了,Virtual File就是xml文件本身的一个抽象对象。而PSI File就类似于Dom下xml文件解析成的Document对象,虽然也是“文件”,但是特殊封装过的~ 这个PsiFile是整个PSI系统下的文件对象,和PSI下的其他Element元素相通~

PSI Element是什么?

PSI Element是PSI系统下不同类型对象的一个统称,是基类。
比如之前提到的PsiMethod、PsiClass等等都是一个个具体的PsiElement实现。


可能还会有点迷惑,下面写个demo帮助理解。
我们通过ActionEvent的getData方法,传入对应KEY获取PsiFile(Action类创建参考上篇教程),然后遍历PsiFile文件下所有的子级元素,打印出来(日志显示在开发插件的IDE的控制台)
注意,这个直接获取的PsiFile默认为当前我们当前所选的文件

@Override
public void actionPerformed(AnActionEvent e) {
    PsiFile file = e.getData(PlatformDataKeys.PSI_FILE);
    for (PsiElement psiElement : file.getChildren()) {
        System.out.println(psiElement);
    }
}复制代码

代码run起来
运行起来的IDE我们新建一个Android Project,默认主页面代码如下

插件测试项目
插件测试项目

然后在菜单中 Code | Database Generate 调用我们编写的插件
运行结果日志如下:

PsiPackageStatement:com.boredream.plugindemo
PsiWhiteSpace
PsiImportList
PsiWhiteSpace
PsiClass:MainActivity
PsiWhiteSpace

这里把MainActivity文件下所有的子级Element都列出来了(只遍历直接子级)
看名字就能知道意思,PsiPackageStatement是包名语句,PsiClass是类。。。甚至还有PsiWhiteSpace,空白都专门有个类型啊!细致!

这里不同的Element还有自己对应的特殊方法,比如PsiClass就和Java中的Class类似,可以获取Field、Method等。下面我们再简单改造下Demo,获取MainActivity文件中Class里面的元素。

@Override
public void actionPerformed(AnActionEvent e) {
    PsiFile file = e.getData(PlatformDataKeys.PSI_FILE);
    for (PsiElement psiElement : file.getChildren()) {
        if(psiElement instanceof PsiClass) {
            PsiClass clazz = (PsiClass) psiElement;
            PsiMethod method = clazz.getMethods()[0];
            System.out.println(method.getName());
            System.out.println(method.getParameterList().getText());
        }
    }
}复制代码

同样,再次run项目,然后调用插件
运行结果日志如下:

onCreate
(Bundle savedInstanceState)

这次我们遍历获取了PsiClass类对象,然后获取它内部的第一个方法,并打印方法的名字和方法参数的文字

本篇教程结束~
下一章,我们将开撸 自动生成数据库插件代码的实战~
然后一边写插件一边再学习新的内容

关注下面的标签,发现更多相似文章
评论