Android ORM框架之GreenDAO

GreenDao

在Android 开发过程中,android 使用sqlite 来存储数据的，但是我们在实际开发过程中，要编写大量的工作来开发数据管理。因此，适用于 Android 的 ORM 框架也就孕育而生了，现在市面上主流的框架有 OrmLite、SugarORM、Active Android、Realm 与 GreenDAO。

但是本文当中要讲的是greenDao，因为它是这么框架中当中性能最好的ORM 框架之一，

简单的讲，greenDAO 是一个将对象映射到 SQLite 数据库中的轻量且快速的 ORM 解决方案。

（greenDAO is a light & fast ORM solution that maps objects to SQLite databases.）

reenDAO 设计的主要目标

一个精简的库

性能最大化

内存开销最小化

易于使用的 APIs

对 Android 进行高度优化

greenDAO 设计的主要特点

greenDAO 性能远远高于同类的 ORMLite，具体测试结果可见官网



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

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

这是其核心概念：为了在我们的 Android 工程中使用 greenDAO ，我们需要另建一个纯 Java Project，

用于自动生成后继 Android 工程中需要使用到的 Bean、DAO、DaoMaster、DaoSession 等类。

总之，一句话，greenDAO就是实现Java对象和SQLite Datebase的一个媒介人，简化了SQLite的操作。

更多的介绍详见官方网站：http://greendao-orm.com/

在这里更多是介绍一下greenDao的用法：

前言

（1）generator — greenDAO-generator.jar

网上使用说明很少，搜到的都是对于我这个新人来说看的云里雾里，于是本人就干脆直接看官方文档，这篇文章也是边看边写的，可能会有些混乱。

在github上下载的实例源码以及上面图中我们都会发现，会有一个generator。比如包里面会有greendao和greendao-generator，示例工程会有DaoExample和DaoExampleGenerator两个工程。之前一直不明白，看了官方文档终于理解了。

“In order to use greenDao in your project, you need to create a second project, the "generator project". 这个额外的工程是一个普通的java工程，而非android工程。它的任务是生成你希望的java对象所对应的DAO接口对象。

（2）核心的class – greenDAO.jar

DAO的core library（greenDAO.jar）中有以下几个核心类，也是后面比用到的，先来大概了解下他们的结构吧，不然直接看他们的使用会云里雾里。

DaoMaster：一看名字就知道它是Dao中的最大的官了。它保存了sqlitedatebase对象以及操作DAO classes（注意：不是对象）。其提供了一些创建和删除table的静态方法，其内部类OpenHelper和DevOpenHelper实现了SQLiteOpenHelper并创建数据库的框架。

DaoSession：会话层。操作具体的DAO对象（注意：是对象），比如各种getter方法。
XXXDao：实际生成的某某DAO类，通常对应具体的java类，比如NoteDao等。其有更多的权限和方法来操作数据库元素。
XXXEntity：持久的实体对象。通常代表了一个数据库row的标准java properties。

如下一个实例初始化代码：
helper = new DaoMaster.DevOpenHelper(.this, "notes-db", null);
db = helper.getWritableDatabase();
daoMaster = new DaoMaster(db);
daoSession = daoMaster.newSession();
noteDao = daoSession.getNoteDao();

即：先创建了一个SQLiteOpenHelper并创建连接到一个具体数据库；再根据具体的datebase创建一个master对象用于；最后通过master创建一个数据库的会话操作。

GreenDao的使用步骤

（文中使用Android studio构建项目）

1、新建一个项目，然后在在 src/main 目录下新建一个与 java 同层级的「java-gen」目录，这个目录用于存放由 greenDAO 生成的 Bean、DAO、DaoMaster、DaoSession 等类。



2、配置 Android 工程（app）的 build.gradle，分别添加 sourceSets 与dependencies。如下代码：

apply plugin: 'com.android.application'

android {
compileSdkVersion 23
buildToolsVersion "23.0.0"

defaultConfig {
applicationId "com.zhiyahan.greendaodemo"
minSdkVersion 15
targetSdkVersion 23
versionCode 1
versionName "1.0"
}
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}

//添加sourceSets
sourceSets {
main {
java.srcDirs = ['src/main/java', 'src/main/java-gen']
}
}
}

dependencies {
compile fileTree(dir: 'libs', include: ['*.jar'])
testCompile 'junit:junit:4.12'
compile 'com.android.support:appcompat-v7:23.4.0'
//导入greendao的jar包
compile 'de.greenrobot:greendao:1.3.7'
}

3、新建一个module， 选择java Library：



填写相应的包名和名称后点击完成

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

compile 'de.greenrobot:greendao-generator:1.3.1'

导入greendao-generator的jar包

4、Generator 类，在java module中，自动生成了一个类，下面来编写这个类：

package com.zhiyahan;

import de.greenrobot.daogenerator.DaoGenerator;
import de.greenrobot.daogenerator.Entity;
import de.greenrobot.daogenerator.Schema;

public class GreenDaoGenerater {

public static void main(String[] args) throws Exception {
// 正如你所见的，你创建了一个用于添加实体（Entity）的模式（Schema）对象。
// 两个参数分别代表：数据库版本号与自动生成代码的包路径。
Schema schema = new Schema(1, "com.zhiyahan.greendaodemo");
//      当然，如果你愿意，你也可以分别指定生成的 Bean 与 DAO 类所在的目录，只要如下所示：
//      Schema schema = new Schema(1, "me.itangqi.bean");
//      schema.setDefaultJavaPackageDao("me.itangqi.dao");
// 模式（Schema）同时也拥有两个默认的 flags，分别用来标示 entity 是否是 activie 以及是否使用 keep sections。
// schema2.enableActiveEntitiesByDefault();
// schema2.enableKeepSectionsByDefault();
// 一旦你拥有了一个 Schema 对象后，你便可以使用它添加实体（Entities）了。
addNote(schema);
addChengji(schema);
// 最后我们将使用 DAOGenerator 类的 generateAll() 方法自动生成代码，此处你需要根据自己的情况更改输出目录（既之前创建的 java-gen)。
// 其实，输出目录的路径可以在 build.gradle 中设置，有兴趣的朋友可以自行搜索，这里就不再详解。
new DaoGenerator().generateAll(schema, "D:/Android/StudioSpace/GreenDaoDemo/app/src/main/java-gen");
}

/**
* @param schema
*/
private static void addNote(Schema schema) {
// 一个实体（类）就关联到数据库中的一张表，此处表名为「Note」（既类名）
Entity note = schema.addEntity("Note");
// 你也可以重新给表命名
// note.setTableName("NODE");
// greenDAO 会自动根据实体类的属性值来创建表字段，并赋予默认值
// 接下来你便可以设置表中的字段：
note.addIdProperty();
note.addStringProperty("xuehao");
note.addStringProperty("name").notNull();
// 与在 Java 中使用驼峰命名法不同，默认数据库中的命名是使用大写和下划线来分割单词的。
// For example, a property called “creationDate” will become a database column “CREATION_DATE”.
note.addIntProperty("sex");
note.addIntProperty("age");
note.addDateProperty("date");

}

public static  void addChengji(Schema schema){
// 一个实体（类）就关联到数据库中的一张表，此处表名为「Note」（既类名）
Entity note = schema.addEntity("Chengji");
note.addIdProperty();
note.addStringProperty("xuehao");
note.addIntProperty("yuwen");
note.addIntProperty("shuxue");
note.addIntProperty("yingyu");
note.addIntProperty("huaxue");
note.addIntProperty("wuli");
}
}

5、执行，生成数据库相关文件

执行 generator 工程，如一切正常，你将会在控制台看到如下日志，并且在主工程「java-gen」下会发现生成了DaoMaster、DaoSession、**Dao、Bean共4个类文件。



得到下列文件：



这样数据库和表以及数据库的操作文件都生生了，下面就可以操作数据库了：

6、获得数据库实例

//官方建议，这部分的操作应该在Application的oncreate方法中，实现，确保这个实例是单例，避免生成多个实例
DaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(this, "notes-db",null);
SQLiteDatabase   db = helper.getWritableDatabase();

7、获取DaoSession 实例

DaoSession daoSession = new DaoMaster(db).newSession();

8、获取**Dao 类 实例：例如 NoteDao

NoteDao noteDao = daoSession.getNoteDao();

9、经过以上的步骤下，就可以对数据进行增删查减了：

插入数据

// 插入操作，简单到只要你创建一个 Java 对象
Note note = new Note(null, noteText, comment, new Date());
noteDao.insert(note);

或者：
使用async API
AsyncSession asyncSession = daoSession.startAsyncSession();
asyncSession.insert(new Note(null, noteText, comment, new Date());

删除数据

//删除操作
noteDao.deleteByKey(id);

还有其他的删除方法，具体可以看生成的NoteDao

(1)清空表格数据
/** 清空相册图片列表的数据 */
noteDao.deleteAll();

(2)删除某个对象
{
QueryBuilder<Note> qb = noteDao.queryBuilder();
DeleteQuery<Note> bd = qb.where(Properties.CityId.eq(cityId)).buildDelete();
bd.executeDeleteWithoutDetachingEntities();
}

更新数据

noteDao.insertOrReplace(note);
noteDao.insertInTx(note);

或者用
AsyncSession asyncSession = daoSession.startAsyncSession();
asyncSession.update(note);

查询数据

查询
范例1：查询某个表是否包含某个id:
public boolean isSaved(int ID)
{
QueryBuilder<Note> qb = noteDao.queryBuilder();
qb.where(Properties.Id.eq(ID));
qb.buildCount().count();
return qb.buildCount().count() > 0 ? true : false;
}

范例2：获取整个表的数据集合,一句代码就搞定！
public List<Chengji> getChengji()
{
return chengjiDao.loadAll();// 成绩列表
}

范例3：通过一个字段值查找对应的另一个字段值(为简便直接使用下面方法，也许有更简单的方法，尚未尝试)
/** 通过图片id查找其目录id */
public int getTypeId(int picId)
{
QueryBuilder<PhotoGalleryDB> qb = photoGalleryDao.queryBuilder();
qb.where(Properties.Id.eq(picId));
if (qb.list().size() > 0)
{
return qb.list().get(0).getTypeId();
}
else
{
return -1;
}
}

范例4：查找所有第一姓名是“Joe”并且以lastname排序。
List joes = userDao.queryBuilder()
.where(Properties.FirstName.eq("Joe"))
.orderAsc(Properties.LastName)
.list();

范例5：多重条件查询
(1)获取id为cityId并且infotype为HBContant.CITYINFO_SL的数据集合：
public List<CityInfoDB> getSupportingList(int cityId)
{
QueryBuilder<CityInfoDB> qb = cityInfoDao.queryBuilder();
qb.where(qb.and(Properties.CityId.eq(cityId),Properties.InfoType.eq(HBContant.CITYINFO_SL)));
qb.orderAsc(Properties.Id);// 排序依据
return qb.list();
}

(2)获取firstname为“Joe”并且出生于1970年10月以后的所有user集合:
QueryBuilder qb = userDao.queryBuilder();
qb.where(Properties.FirstName.eq("Joe"),
qb.or(Properties.YearOfBirth.gt(1970),
qb.and(Properties.YearOfBirth.eq(1970), Properties.MonthOfBirth.ge(10))));
List youngJoes = qb.list();

范例6：获取某列对象
picJsonDao.loadByRowId(picId);

10、问题定位（日志）

你可能会遇到查询结果并不是预期的那样，这时候你就可以设置两个静态flag参数来打日志定位问题：

QueryBuilder. LOG_SQL = true ;

QueryBuilder. LOG_VALUES = true ;

这将会将产生的sql命令以及传递的参数以日志方式输出，由此方便程序员定位问题。

11、数据库升级处理：

在DaoMaster类的onUpgrade方法添加如下代码即可，参数为所有的Dao类

MigrationHelper.getInstance().migrate(db,TestDataDao.class,TestData2Dao.class,TestData3Dao.class);

升级参考：http://blog.csdn.net/growth58/article/details/50453038