android orm工具GreenDao的使用

最新推荐文章于 2024-10-09 18:40:13 发布

好大一只蜗牛

最新推荐文章于 2024-10-09 18:40:13 发布

阅读量478

点赞数

分类专栏： android 文章标签： android orm 框架 sqlite

android 专栏收录该内容

3 篇文章 0 订阅

订阅专栏

原文：http://itangqi.me/android/using-greendao-experience/ , 按照自己的尝试略做修改

我相信，在平时的开发过程中，大家一定会或多或少地接触到 SQLite。然而在使用它时，我们往往需要做许多额外的工作，像编写 SQL 语句与解析查询结果等。所以，适用于 Android 的ORM 框架也就孕育而生了，现在市面上主流的框架有 OrmLite、SugarORM、Active Android、Realm 与 GreenDAO。而今天的主角便是 greenDAO，下面，我将详解地介绍如何在 Android Studio 上使用 greenDAO，并结合代码总结一些使用过程中的心得。

关于 greenDAO

简单的讲，greenDAO 是一个将对象映射到 SQLite 数据库中的轻量且快速的 ORM 解决方案。（greenDAO is a light & fast ORM solution that maps objects to SQLite databases.）
而关于 ORM （Object Relation Mapping - 对象关系映射）的概念，可参见 Wikipedia。

GREENDAO 设计的主要目标
一个精简的库

性能最大化

内存开销最小化

易于使用的 APIs

对 Android 进行高度优化

GREENDAO 设计的主要特点
greenDAO 性能远远高于同类的 ORMLite，具体测试结果可见官网

greenDAO 支持 protocol buffer(protobuf) 协议数据的直接存储，如果你通过 protobuf 协议与服务器交互，将不需要任何的映射。

与 ORMLite 等使用注解方式的 ORM 框架不同，greenDAO 使用「Code generation」的方式，这也是其性能能大幅提升的原因。

DAO CODE GENERATION PROJECT

这是其核心概念：为了在我们的 Android 工程中使用 greenDAO ，我们需要另建一个纯 Java Project，用于自动生成后继 Android 工程中需要使用到的 Bean、DAO、DaoMaster、DaoSession 等类。

CORE CLASSES & MODELLING ENTITIES
关于以上几个类的相关概念与作用，我将在下面的代码（注释）中详细讲解。
当然，你也可以在官网中找到相关介绍。

让我们开始吧

一. 在 ANDROID 工程中配置「GREENDAO GENERATOR」模块
配置 Android 工程（app）的 build.gradle，如图添加 dependencies。

这里写图片描述

二. 新建「GREENDAO GENERATOR」模块 (纯 JAVA 工程）

1.通过 File -> New -> New Module -> Java Library -> 填写相应的包名与类名,如(包名com.example.test,类名OrmGenerator) -> Finish.

这里写图片描述

2.配置 ormgenerator 工程的 build.gradle，添加 dependencies.

这里写图片描述

3.编写 OrmGenerator 类，注意：我们的 Java 工程只有一个类，它的内容决定了「GreenDao Generator」的输出，你可以在这个类中通过对象、关系等创建数据库结构，下面我将以注释的形式详细讲解代码内容。


public class OrmGenerator {
    public static void main(String[] args) throws Exception {
        // 正如你所见的，你创建了一个用于添加实体（Entity）的模式（Schema）对象。
        // 两个参数分别代表：数据库版本号与自动生成代码的包路径。
        Schema schema = new Schema(1, "com.example.test.orm");
//      当然，如果你愿意，你也可以分别指定生成的 Bean 与 DAO 类所在的目录，只要如下所示：
//      Schema schema = new Schema(1, "com.example.test.orm.bean");
//      schema.setDefaultJavaPackageDao("com.example.test.orm.dao");

        // 模式（Schema）同时也拥有两个默认的 flags，分别用来标示 entity 是否是 activie 以及是否使用 keep sections。
        // schema2.enableActiveEntitiesByDefault();
        // schema2.enableKeepSectionsByDefault();

        // 一旦你拥有了一个 Schema 对象后，你便可以使用它添加实体（Entities）了。
        addNote(schema);

        // 最后我们将使用 DAOGenerator 类的 generateAll() 方法自动生成代码，此处你需要根据自己的情况更改输出目录（既之前创建的 java-gen)。
        // 其实，输出目录的路径可以在 build.gradle 中设置，有兴趣的朋友可以自行搜索，这里就不再详解。
        new DaoGenerator().generateAll(schema, "./app/src/main/java");
        //注:此处的./表示工程的根目录,非模块的根目录
    }

    /**
     * @param schema
     */
    private static void addNote(Schema schema) {
        // 一个实体（类）就关联到数据库中的一张表，此处表名为「Note」（既类名）
        Entity note = schema.addEntity("Note");
        // 你也可以重新给表命名
        // note.setTableName("NODE");

        // greenDAO 会自动根据实体类的属性值来创建表字段，并赋予默认值
        // 接下来你便可以设置表中的字段：
        note.addIdProperty();
        note.addStringProperty("text").notNull();
        // 与在 Java 中使用驼峰命名法不同，默认数据库中的命名是使用大写和下划线来分割单词的。
        // For example, a property called “creationDate” will become a database column “CREATION_DATE”.
        note.addStringProperty("comment");
        note.addDateProperty("date");
    }
}

三. 执行 ormgenerator 工程, 生成 DAO 文件（数据库）

在android studio中执行java程序的话可能要先配置一下Run的configurations.

这里写图片描述

如图,先添加一个Application,然后配置一些执行程序的变量,主要是Main class和Use classpath of module,完成后执行 generator 工程，如一切正常，你将会在控制台看到如下日志，并且在主工程「java-gen」下会发现生成了DaoMaster、DaoSession、NoteDao、Note共4个类文件。

这里写图片描述