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类对象，而后获取它内部的第一个方法，并打印方法的名字和方法参数的文字

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