Android 关于greenDao的使用教程

关于greenDao的使用

第一篇How  to get started ? 

原文地址：http://greendao-orm.com/documentation/how-to-get-started/

该教程会带你浏览一个简单的greenDao示例工程。地址：https://github.com/greenrobot/greenDAO，该工程包含两个子工程：

DaoExample和DaoExampleGenerator。你可以clone到本地，运行或者直接在github上直接浏览。

如果你从git仓储中检出了DaoExample，可以直接像Android应用一样运行它。正如你所看到的，它就是一个简单的笔记本。可以添加新的note，

或者点击已存在的note进行删除。

预生成代码和创建表

在src-gen目录下，你可以找到一些已经生成的文件

1）Note.java  一个包含一个Note所有数据的java类。

2）NoteDao.java 一个DAO类，是操作Note 对象的接口。

你可以通过DaoExampleGenerator工程再次生成Note和NoteDao。

使用DaoMaster类可以获得一个方便的SQLiteOpenHelper:

new DaoMaster.DevOpenHelper(this, "notes-db", null)

你不必编写“CREATE TABLE” SQL语句，greenDao会为你完成。

插入和删除Note对象

创建了Note表后，就可以存储一些note到数据库里了。这是在NoteActivity类里完成的。在onCreate方法里，我们准备了一个DAO对象：

1 2 3

daoMaster = new DaoMaster(db); daoSession = daoMaster.newSession(); noteDao = daoSession.getNoteDao();

添加一个新的note到数据库中：

1 2 3

Note note = new Note(null, noteText, comment, new Date()); noteDao.insert(note); Log.d("DaoExample", "Inserted new note, ID: " + note.getId());

该示例只是创建并插入了一个java对象。但insert方法返回的时候，数据库的ID已经分发到了刚插入的Note对象上了。在log中可以看到。

删除一条note：非常简单明，在onListItemClick方法中可以看到

1	noteDao.deleteByKey(id);

你也可以看一下其它的DAO方法：loadAll、update。

数据模型化和代码的生成

为了扩展note或者创建新的实体，你可以看一下DaoExampleGenerator工程。它包含了一个单例的类，该类中包含了数据模型的定义代码。

1 2 3 4 5 6 7

Schema schema = new Schema(1, "de.greenrobot.daoexample"); Entity note= schema.addEntity("Note"); note.addIdProperty(); note.addStringProperty("text").notNull(); note.addStringProperty("comment"); note.addDateProperty("date"); new DaoGenerator().generateAll("../DaoExample/src-gen", schema);

正如你所看到的，你可以创建一个Schema对象，通过它你可以添加实体，一个实体连接了一张数据库表。
一个实体包含一些属性，它们可以被映射到数据库的columns。
一旦schema定义完成，你可以触发代码生成器，Note.java和NoteDao.java文件就是这样被创建的。

下一步：

对greenDao有了初步的了解，你可以自己动手试试了。当然，请查看下文档http://greendao-orm.com/documentation/，

如果没有找到你想要的，可以使用support options

第二篇 介绍

GreenDao是一个用于Android开发的对象/关系映射(ORM)工具。它向SQLite数据库提供了一个对象导向的接口。像GreenDao这样的ORM工具不仅为你省去了很多的重复工作，而且提供了更简便的操作接口。

代码生成的工程结构图

为了在你的Android项目中使用GreenDao，你需要创建一个二级工程：“generator project”，它的任务就是为你的domain生成具体的代码。这个生成器工程就是一个普通的java工程。确保greenDao 的greenDao-generator.jar和 freemarker.jar 在classpath中。创建一个可执行的java类，构建你的实体模型并触发代码生成器，更多细节，可以参看 modelling文档。

核心类

一旦生成了指定的代码，就可以在你的android工程中使用greenDao了。别忘记在你的android工程中引入greenDao的核心jar包：greenDao.jar。以下是GreenDao的一些必要接口。

DaoMaster：

daomaster以一定的模式持有数据库对象（SQLiteDatabase）并管理一些DAO类（而不是对象）。

有一个静态的方法创建和drop数据库表。它的内部类OpenHelper和DevOpenHelper是SQLiteOpenHelper的实现类，用于创建SQLite数据库的模式。

DaoSession：

管理指定模式下所有可用的DAO对象，你可以通过某个get方法获取到。DaoSession提供一些通用的持久化方法，比如对实体进行插入，加载，更新，刷新和删除。最后DaoSession对象会跟踪identity scope，更多细节，可以参看 session文档。

DAOs（Data access objects）:

数据访问对象，用于实体的持久化和查询。对于每一个实体，greenDao会生成一个DAO，相对于DaoSession它拥有更多持久化的方法，比如：加载全部，插入（insertInTx，语境不明了，暂且简单的翻译成插入）。

实体
可持久化的对象。通常，实体可以被生成，不用手动去写。在数据库的行中，使用的都是标准的java对象的属性（比如POJO或者JavaBean）。

1 2 3 4

user.addIdProperty(); user.addStringProperty("name"); user.addStringProperty("password"); user.addIntProperty("yearOfBirth");

在示例中有一个Note实体，通过它的DAO，我们可以对指定的实体进行持久化的操作。

第三篇 实体的模型化

使用greenDao的第一步：创建一个代表持久化数据的实体模型。greenDao会依赖该模型为Dao生成java代码。
该模型本身是用java代码定义的，很简单：在DaoExampleGenerator工程的基础上创建一个java对象。具体你可以参看：
http://greendao-orm.com/documentation/how-to-get-started/

下面的插图描绘了元模型，展示了一些用于描述domain具体模型的类。

Schema

实体数据schema是你定义的第一个对象，通过schema的版本和缺省的java包调用构造器。

1	Schema schema = new Schema(1, "de.greenrobot.daoexample");

这个缺省的java包会在greenDao生成实体、DAOs、和JUnit测试的时候使用。如果那些缺省值是正确的，那么就完成了第一步。

如果你希望将DAO和测试类创建到不同的包中，可以重新定义schema的定义代码：

1 2	schema.setDefaultJavaPackageTest("de.greenrobot.daoexample.test"); schema.setDefaultJavaPackageDao("de.greenrobot.daoexample.dao");

对于实体，该schema也有两个缺省的标记，它们是可以被复写的。这些标记可以区分实体是否是激活状态，是否应该使用sections。这些特性在文档里并没有，你可以看一下发布源码中的测试工程。

1 2	schema2.enableKeepSectionsByDefault(); schema2.enableActiveEntitiesByDefault();

实体

一旦你拥有了一个schema对象，你就可以使用它去添加实体了。

1	Entity user = schema.addEntity("User");

一个实体有不同的可变更设置，更重要的是，你可以添加一些属性到实体。

1 2 3 4

user.addIdProperty(); user.addStringProperty("name"); user.addStringProperty("password"); user.addIntProperty("yearOfBirth");

除了实体，还可以添加，一对一和一对多的关系。

属性和主键

以上的实体部分展示了如何给一个实体添加属性，实体的addXXXProperty方法返回一个PropertyBuilder对象，可以用于配制属性，
例如，使用columnName去复写缺省的或者你提供的column name。在ProperyBuilder对象上调用getProperty方法去访问属性对象，

对于指数（indices ）和关系的创建是有必要的。

创建主键的约束

现在实体必须拥有一个long或者Long类型的属性作为它们的主键，这是Android和SQLite推荐的实践方式。因为，在将来，greenDao要准备处理很多主键的脚本，但并不是每件事都能完全实现。为了解决这个问题，你可以使用一个long类型的键并且使用一个唯一的下标去处理这个预期的key属性。

缺省

greenDao会尝试以合理的缺省值进行工作，所以开发者不用单个的配置它们。比如，表和其列名是从实体和属性名中获取到的，而不是java中的驼峰。缺省的数据库名是大写的，单词间用下划线分隔开。比如：属性“creationDate”在数据库列中的映射为“CREATION_DATE”，

关系

一对多和多对多的关系在http://greendao-orm.com/documentation/relations/中有注释。

继承、接口、序列化

实体可以从其他非实体类继承，其父类可以通过setSuperclass(String)方法指定，注意：它可能会有其它的实体作为父类（但这里没有多态查询）。

比如：

1	myEntity.setSuperclass("MyCommonBehavior");

通常，使用接口作为实体属性和行为的通用基类是比较好的。比如：一个实体A和B共享了一套属性，这些属性可以定义在C中。下面是一个序列化B的列子：

1 2 3

entityA.implementsInterface("C"); entityB.implementsInterface("C"); entityB.implementsSerializable();

触发生成器

一旦你的实体schema放置好了，你可以触发代码生成器进行处理。在generator工程中，你可以实例化DaGenerator并调用generateAll中的一个方法：

1 2	DaoGenerator daoGenerator = new DaoGenerator(); daoGenerator.generateAll(schema, "../MyProject/src-gen");

你所需要的就是schema对象和目标文件夹，通常该文件夹就是你android工程的资源文件夹。如果你想把这些测试类放到其他目录下，可以把目的文件夹作为第三个参数传入。

保持独立性（Keep sections 保持自定义的代码不会被覆盖）

实体类在每一次生成器运行的时候都会被覆盖。greenDao允许添加自定义的代码到实体，通过“keep” ，可以满足它们。在schema中使用enableKeepSectinsByDefault()，或者setHasKeepSections(true)在选中的实体中。一旦使用，3个独立的部分会在实体中生成：

1 2 3 4 5 6 7 8

// KEEP INCLUDES - put your custom includes here // KEEP INCLUDES END ... // KEEP FIELDS - put your custom fields here // KEEP FIELDS END ... // KEEP METHODS - put your custom methods here // KEEP METHODS END

现在，你可以在 KEEP [...] and KEEP [...] END.中写入你的代码。注意，不要修改KEEP注释。在该范围的代码会在代码重新生成的时候不被覆盖。对于备份或者提交代码时出现的意外错误，这是一个不错的选择解决方案。

第四篇 非技术类的常见问题

通常的疑问

为什么greenDao使用的是code generation，而不是注解？

对于greenDao，代码生成是非常合理的。在Android平台上，基于注解的解决方式是有缺陷的：它们不得不依赖于元数据的解析和反射。特别是反射，会显著降低ORM工具的性能。另一方面，greenDao会为Android生成优化过的代码。这些生成的代码完全避免了反射。这也是greenDao如此快的主要原因。另一个优势是大小。

greenDao的核心lib是非常小的（在100K以下，包括单元测试）。这是因为对于一些ORM的内部逻辑都在generator中，而不是在核心库中。

greenDao包含了：DaoCore，DaoGenerator和DaoTest。DaoCore是需要你加入到android项目中的，在Apache License 2版本以下是许可的。

DaoGenerator是java程序，负责实体的生成，DAO和其它的文件。DaoTest是单元测试用例额，确保了greenDao本身和其稳定性。

DaoGenerator 和DaoTest 在GPL V3以下是可用的。这些许可条款可以满足大部分的开发者使用。

第五篇 查询

查询会返回符合某些特定标准的实体。你可以使用原始的SQL定制查询语句，或者更好的方式：使用GreenDao的QueryBuilder API。该查询也支持lazy-loading的结果集。这样在操作大量结果集的时候可以节省内存和性能。

QueryBuilder

QueryBuilder可以帮助你构建自定义的查询语句，而不使用SQL的情况。并不是每个人都喜欢书写SQL语句，当然很容易就会出一些错，这些错误只有在运行的时候才会被发现。而QueryBuilder很容易使用，节省了你书写SQL语句的时间。当然，由于语法的检验是在编译时才执行，所以在查询语句中发现bug是很困难的。

QueryBuilder的编译时间会检验属性的引用，这样能够在greenDao后面，通过代码生成的方法发现bug。

比如：查找所有以“Joe”为first name 的用户，并以last name排序：

1 2 3 4

List joes = userDao.queryBuilder() .where(Properties.FirstName.eq("Joe")) .orderAsc(Properties.LastName) .list();

嵌套情况：

获取用户名字为“Joe”并且在1970年9月之后出生的用户

这里要说明下：user 的birthday对于year，month，和day是一个分离的属性。我们可以以一种更正常的方式表达这种条件：

First name is “Joe” AND (year of birth is greater than 1970 OR (year of birth is 1970 AND month of birth is equal to or greater than 10 (October).

1 2 3 4 5

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();

Query 和 LazyList

Query类代表一个可以多次执行的查询。当你使用QueryBuilder之一的方法去获取结果的时候，QueryBuilder内部使用了Query 类。

如果你想运行更多相同的查询，你应该调用build()在QueryBuilder上，去创建Query，而不是执行它。

greenDao支持唯一的结果和结果列表。如果你想得到一个唯一的结果，可以调用Query或者QueryBuilder的unique()方法，这样在没有匹配条件的时候会返回一个唯一的结果，而不是null。如果你希望禁止用例中返回null，可以调用uniqueOrThrow()，该方法会保证返回一个非null的实体。否则就会抛出一个DaoException。

如果你期望一次性返回多个实体，可以使用以下方法：

list()：所有的实体被加载到内存中。该结果通常是一个没有magic involved的ArrayList。使用起来最简单。

listLazy()：实体按照需求加载进入内存。一旦列表中的一个元素被第一次访问，它将被加载同时缓存以便以后使用。必须close。

ListLasyUncached(): 一个“虚拟”的实体列表：任何对列表元素的访问都会导致从数据库中加载，必须close。

listIterator(): 遍历通过需要的时候加载（lazily）获得的结果，数据没有缓存，必须close。

listLazy, listLazyUncached 和 listIterator类使用了greenDao的LazyList类。为了根据需求加载数据，它持有了一个数据库cursor的引用。

这是做是为了确保关闭 lazy list和iterators（通常在try/finally 代码块中）。

一旦有的元素被访问或者遍历过，来自lsitLazy()的cache lazy list和来自listIterator()方法的lazy iterator将会自动关闭cursor。

然而，如果list的处理过早的完成了，你应该调用 close()手动关闭。

多次执行查询

一旦你使用QueryBuilder构建了一个query，该query对象以后可以被重复使用。这种方式比总是重复创建query对象要高效。

如果query的参数没有变更，你只需要再次调用list/unique方法即可。如果有参数变更，你就需要调用setParameter方法处理每一个变更的参数。

现在，个别参数由基于零的参数索引寻址。该下标基于你传递到querybuilder的参数。

使用query对象获取出生在1970年 并且 first name 为 joe 的用户：

1 2 3 4

Query query = userDao.queryBuilder().where( Properties.FirstName.eq("Joe"), Properties.YearOfBirth.eq(1970)) .build(); List joesOf1970 = query.list();

使用query对象，可以查询

1 2 3

query.setParameter(0, "Maria"); query.setParameter(1, 1977); List mariasOf1977 = query.list();

在多个线程中执行查询

如果你在多线程中使用了查询，你必须调用query的 forCurrentThread()为当前的线程获得一个query实例。从greenDAO 1.3开始，

query的实例化被绑定到了那些创建query的线程身上。这样做保证了query对象设置参数时的安全性，避免其他线程的干扰。如果其他线程

试着在query对象上设置参数或者执行查询绑定到了其它线程，将会抛出异常。这样一来，你就不需要一个同步语句了。

事实上你应该避免使用lock，因为如果在并发的事务中使用了同一个query对象，可能会导致死锁。

为了完全避免那些潜在的死锁问题，greenDAO 1.3 引入了forCurrentThread方法，它会返回一个query对象的thread—local实例，该实例

在当前的线程中使用是安全的。当每一次调用 forCueerntThread()的时候，该参数会在builder构建query的时候，设置到初始化参数上。

原始的查询

这里有两种方式执行原始的SQL去获取实体。较好的一种方式是使用QueryBuilder 和 WhereCondition.StringCondition。
使用这个方法，你可以为 query builder 的 WHERE 子句传递任何SQL片段。

下面是一个笨拙的例子展示如果使用这种方式进行一个替代联合查询的子查询。

1 2 3

Query query = userDao.queryBuilder().where( new StringCondition("_ID IN " + "(SELECT USER_ID FROM USER_MESSAGE WHERE READ_FLAG = 0)").build();

该示例中query Builder没有提供你需要的特性，你可以回到原始的queryRaw或者queryRawCreate方法。它们允许你传递原始的SQL字符串，这些字符串会被添加到SELECT 和实体列后面。这种方式，你可以拥有一个 WHERE 和 ORDER BY 语句查询实体。这种实体表可以通过别名“T”引用。

下面的例子展示了如何创建一个query：使用联合获取名为“admin”的group的users

1	Query query = userDao.queryRawCreate(  ", GROUP G WHERE G.NAME=? AND T.GROUP_ID=G._ID", "admin");

提示：

你可以通过生成的常量引用表或者列名。这样建议是为了避免错别字，因为编译器会检验这些名字。在任何实体的DAO，你可以发现 TABLENAME 持有着数据库的名字和一个内部类“Properties”.它的所有属性都是常量。

删除查询

批量删除不删除单独的实体，但所有的实体要匹配一些准则。为了执行批量删除，创建一个QueryBuilder，调用它的buildDelete方法，它会返回一个DeleteQuery。

这部分的API可能会在以后有所变化，比如添加一些更加便利的方法。记住，批量删除现在不会影响到identity scope中的实体。在它们被通过ID访问之前（load 方法）

如果它们被缓存了，你可以激活那些将要被删除的实体。如果导致了一些使用的问题。你可以考虑清除identity scope。

查询故障处理

如果你的query没有返回期望的结果，这里有两个静态的flag，可以开启QueryBuilder身上的SQL和参数的log。

1 2	QueryBuilder.LOG_SQL = true; QueryBuilder.LOG_VALUES = true;

它们会在任何build方法调用的时候打印出SQL命令和传入的值。这样你可以对你的期望值进行对比，或许也能够帮助你复制SQL语句到某些

SQLite 数据库的查看器中，执行并获取结果，以便进行比较。