阅读 1695

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

项目源码

github.com/boredream/A…

系列教程

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

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

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

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


插件介绍

本篇实战撸个自动生成安卓Sqlite数据库代码的插件,先演示下最终效果
db文件夹下的都是插件自动生成的,而MainActivity里面的代码是我提前写好的,用于实验插件生成的代码效果

DatabaseGenerator.gif
DatabaseGenerator.gif

简单解释下插件功能
给定一个数据类,比如User。希望插件能根据数据类自动生成对应的表结构,存在一个Column类里。然后再生成对应的Dao类其中包含CRUD方法。

和网上常见的一些数据库框架类似,只不过这里是用插件直接生成Android Sqlite原生代码

优点:

  • 无需额外依赖
  • 无学习成本
  • 便于自定义

缺点:

  • 原生代码量较多
  • 需要对安卓Sqlite原生代码有一定了解

开撸~
需要处理这么几个模块
SqliteOpenHelper类,其中包含create table的sql语句;
Columns字段类,统一存在一个DataContract类中;
数据Dao类,包含CRUD的sql语句

几个模块的处理步骤和逻辑都类似,这里拿Columns类生成举例。
其他可以下载源码参考 ,源码地址:
github.com/boredream/A…
欢迎star和follow~
下载源码后参考教程一先搭建环境,然后导入项目


处理步骤如下:

一、定位到需要创建文件的目录

这里希望把生成的类都存在包名目录下的db包中(com.packagename.db)

首先要获取到包名目录路径...app/src/main/java/包名,然后才能在它下面获取或新建db文件夹。而获取包名目录又要先获取Android项目的包名,想获取这个又得先找到AndroidManifest文件~

AndroidManifest.png
AndroidManifest.png

因为AndroidManifest文件路径是固定的,所以可以用上一篇教程中的LocalFileSystem.getInstance().findFileByPath(path);方法获取文件

public static PsiFile getManifestFile(Project project) {
    String path = project.getBasePath() + File.separator +
            "app" + File.separator +
            "src" + File.separator +
            "main" + File.separator +
            "AndroidManifest.xml";
    VirtualFile virtualFile = LocalFileSystem.getInstance().findFileByPath(path);
    if(virtualFile == null) return null;
    return PsiManager.getInstance(project).findFile(virtualFile);
}复制代码

project可以在Action中通过event.getData()获取,参考上一篇教程
获取到VirtualFile后再转换成PsiFile,大部分操作都是针对Psi体系的

然后解析AndroidManifest文件,获取package属性里的包名
因为是Xml文件,所以和Dom啥的解析差不多,获取代码如下

public static String getAppPackageName(Project project) {
    PsiFile manifestFile = getManifestFile(project);
    XmlDocument xml = (XmlDocument) manifestFile.getFirstChild();
    return xml.getRootTag().getAttribute("package").getValue();
}复制代码

然后就可以根据包名获取到包名目录了

public static VirtualFile getAppPackageBaseDir(Project project) {
    String path = project.getBasePath() + File.separator +
            "app" + File.separator +
            "src" + File.separator +
            "main" + File.separator +
            "java" + File.separator +
            getAppPackageName(project).replace(".", File.separator);
    return LocalFileSystem.getInstance().findFileByPath(path);
}复制代码

project.getBasePath()是项目的根目录,在其基础上拼接后续路径
然后,包名目录下断有没有db文件夹,没有就创建一个

// app包名根目录 ...\app\src\main\java\PACKAGE_NAME\
VirtualFile baseDir = AndroidUtils.getAppPackageBaseDir(project);

// 判断根目录下是否有db文件夹
VirtualFile dbDir = baseDir.findChild("db");
if(dbDir == null) {
    // 没有就创建一个
    try {
        dbDir = baseDir.createChildDirectory(null, "db");
    } catch (IOException e) {
        e.printStackTrace();
    }
}复制代码

这次我们用了 VirtualFile.FindChild(filename) 方法,获取文件子一级路径中寻找文件或文件夹
(LocalFileSystem.getInstance().findFileByPath(path); 只能获取文件不能获取目录,所以不用)
没有db文件夹的话,就 VirtualFile.createChildDirectory(requestor, name) 创建一个
这个方法第一个参数是指定谁调用了它,一般传null不做特殊处理

db目录定位到了,然后就是在里面创建DataContract类了,再在其中存放Columns类。
DataContact.java文件其实也可以通过类似上面的 VirtualFile.createChildData 直接创建文件,
但创建的是空的文件,而我们需要的是有代码内容的java文件,所以下面我们介绍另一个方法~


二、创建一个包含代码的文件

按照我们的插件需求,要创建一个DataContract类,然后把Columns类都存进去。
首先就是要生成这个作为壳子的类~ 我们先拼接出来类文件的字符串,代码如下

public static String genDataContractInitCode(VirtualFile dir) {
    return StringUtils.formatSingleLine(0, "package " + AndroidUtils.getFilePackagePath(dir) + ";") +
            "\n" +
            StringUtils.formatSingleLine(0, "import android.provider.BaseColumns;") +
            "\n" +
            StringUtils.formatSingleLine(0, "public final class DataContract {") +
            "\n" +
            StringUtils.formatSingleLine(1, "private DataContract() {") +
            StringUtils.formatSingleLine(2, "// private") +
            StringUtils.formatSingleLine(1, "}") +
            "\n" +
            "}";
}复制代码

其中getFilePackagePath是获取当前文件/文件夹对应包名 com.xxx.xxx 的,
逻辑是把当前文件路径的 / 替换成 . 然后截取com.xxx.xxx以后的部分即可

public static String getFilePackageName(VirtualFile dir) {
    if(!dir.isDirectory()) {
        // 非目录的取所在文件夹路径
        dir = dir.getParent();
    }
    String path = dir.getPath().replace("/", ".");
    String preText = "src.main.java";
    int preIndex = path.indexOf(preText) + preText.length() + 1;
    path = path.substring(preIndex);
    return path;
}复制代码

获取到代码字符串以后,可以用createFileFromText创建有内容的文件,如下

String name = "DataContract.java";
VirtualFile virtualFile = dbDir.findChild(name);
if(virtualFile == null) {
    // 没有就创建一个,第一次使用代码字符串创建个类
    PsiFile initFile = PsiFileFactory.getInstance(project).createFileFromText(
            name, JavaFileType.INSTANCE, CodeFactory.genDataContractInitCode(dbDir));
    // 加到db目录下
    PsiManager.getInstance(project).findDirectory(dbDir).add(initFile);
    virtualFile = dbDir.findChild(name);
}复制代码

dbDir是步骤一中获取到的db文件夹
genDataContractInitCode是上面拼接代码的方法,返回代码字符串

注意,createFileFromText创建的文件是一个无目录的文件,需要手动add到需要位置
这个add操作就会把文件加到指定目录下,新建一个文件~


三、解析数据生成对应Columns类

上一篇介绍过,我们可以用action中的event获取当前正在编辑的文件,然后在file中获取到PsiClass元素,最后遍历Class获取全部成员变量Field。PsiClass和Java中的Class相似,有一点反射姿势的可以很快上手

下面就是根据数据类信息,拼接代码字符串的方法

public static String genBeanColumnsCode(PsiClass clazz) {
    StringBuilder sb = new StringBuilder();
    sb.append(StringUtils.formatSingleLine(0, "public interface " + clazz.getName() + " extends BaseColumns {"));
    sb.append(StringUtils.formatSingleLine(1, "String TABLE_NAME = \"" + StringUtils.camel2underline(clazz.getName()) + "\";"));
    for (PsiField field : clazz.getFields()) {
        String name = StringUtils.camel2underline(field.getName()).toUpperCase();
        String value = name.toLowerCase();
        sb.append(StringUtils.formatSingleLine(1, "String " + name + " = \"" + value + "\";"));
    }
    sb.append("}");
    return sb.toString().trim();
}复制代码

clazz.getField获取到类的所有成员变量,然后拼接成需要的代码

其中的StringUtils是自己封装的工具类
camel2underline是将驼峰命名转换成下划线风格的字符串
formatStringLine是在前面加缩进符,后面加换行符
拼好代码后,就可以用它去生成类、文件、方法等等

和之前生成文件类似,也是 createXXXFromText一类的方法,
可以用代码生成类、方法、语句、变量等等。
这里我们就要根据代码去生成Columns类,也就是PsiClass对象

上一步我们已经获取到了DataContract类了,新建的Columns要保存在它里面

PsiFile psiFile = PsiManager.getInstance(project).findFile(virtualFile);
// 用拼接的代码生成Columns Class
String beanColumnsCode = CodeFactory.genBeanColumnsCode(clazz);
PsiElementFactory factory = JavaPsiFacade.getInstance(project).getElementFactory();
PsiClass beanColumnsClass = factory.createClassFromText(beanColumnsCode, psiFile);
// 将创建的class添加到DataContract Class中
PsiClass fileClass = PluginUtils.getFileClass(psiFile);
fileClass.add(beanColumnsClass.getInnerClasses()[0]);复制代码

这次用到了 PsiElementFactory 类,然后用它去 createClassFromText 创建类
方法的第二个参数是Context,传入所在File或所在Class都可以

然后将这个生成的类添加到DataContract文件类中
注意不能是添加到DataContract文件上,而是添加到文件里的类上
获取方法如下(应该有更好的方法吧,暂时没找到)

public static PsiClass getFileClass(PsiFile file) {
    for (PsiElement psiElement : file.getChildren()) {
        if (psiElement instanceof PsiClass) {
            return (PsiClass) psiElement;
        }
    }
    return null;
}复制代码

class.getInnerClasses()[0] 这里要单独说明下

createFileFromText的时候我们拼接的字符串是完整的代码,
但是在createClassFromText的时候比较特殊,codeText是作为类主体部分的

String classCode = "public class MyClass {\n" +
                                "\tprivate String a;\n" +
                            "}";
PsiClass newClass = factory.createClassFromText(classCode, null);复制代码

如果你这样去生成,那么最终代码会是

class _Dummy_ {
    public class MyClass {
        private String a;
    }
}复制代码

这不是我们想要的!!!
所以一般做法是只用类 { } 里面的代码去生成,比如"private String a;"
而类的public等信息需要额外设置,如下

newClass.setName("User"); // 设置类名,默认名为_Dummy_
newClass.getModifierList().add(factory.createKeyword(PsiKeyword.PUBLIC)); // 定义列表里添加关键字public
newClass.getImplementsList().add(factory.createReferenceElementByFQClassName(
                "android.provider.BaseColumns", clazz.getResolveScope())); // 实现接口列表里添加BaseColumns类复制代码

这就比较麻烦了,所以介绍个良心小技巧!
还是用全部代码生成,然后再获取这个类的innerClasses内部类里面的第一个就行了!
所以才有了上面的 class.getInnerClasses()[0] 的处理


四、整合代码,运行

将之前的代码封装到DatabaseGenerator类中的genCode方法中,然后在action里调用
action的相关介绍参考教程一

public class DatabaseGenerateAction extends AnAction {
    @Override
    public void actionPerformed(AnActionEvent e) {
        Project project = e.getData(PlatformDataKeys.PROJECT);
        PsiFile file = e.getData(PlatformDataKeys.PSI_FILE);
        PsiClass clazz = PluginUtils.getFileClass(file);
        WriteCommandAction.runWriteCommandAction(project, () -> {
            DatabaseGenerator.genCode(file, clazz);
        });
    }
}复制代码

注意,这里有个特殊的处理 WriteCommandAction.runWriteCommandAction
在插件中,如果是新建File等操作是可以直接进行的。
但在DataContract文件类中添加个内部类,这种写入文件内容的操作是需要特殊处理的,需要放在 WriteCommandAction.runWriteCommandAction 第二个参数的runnable中运行

搞定,效果图见文章开始动态图。
源码部分见
github.com/boredream/A…
欢迎star和follow~
下载源码后参考教程一先搭建环境,然后导入项目

评论