greenDAO3 基本使用

greenDAO3基本使用

greenDAO3开始使用注解的方式定义实体类（entity），并且是通过安装gradle插件来生成代码。之前的版本则是通过建立一个独立的Java-lib工程来存放生成的文件。

导入相关的包

总工程下加入

dependencies
{
    compile fileTree(dir: 'libs', include: ['*.jar'])
    testCompile 'junit:junit:4.12'
    compile 'com.android.support:appcompat-v7:23.3.0'

	//加上以下两行,引入greendao 3.0
	compile 'org.greenrobot:greendao:3.0.1'
    compile 'org.greenrobot:greendao-generator:3.0.0'
}

配置gradle

这一步非常关键，这是整个grennDAO3改变的核心所在了。

同样也是在总的工程目录下添加以下

apply plugin: 'org.greenrobot.greendao'  

buildscript {
	repositories {
    	mavenCentral()
 	}
	dependencies {
    	classpath 'org.greenrobot:greendao-gradle-plugin:3.0.0'
	}
}

在gradle的根模块中加入上述代码后，sync project的时候，gradle会自动去maven仓库下载一个gradle的插件，当然了，这个插件就是为greenDAO服务的，用来生成数据库相关的代码。

下载起来会比较慢（网络不好），由于了这个插件，就不用再去新建一个java-lib去存放一些所生成的文件了，非常方便。

简单的介绍下通过gradle插件生成数据库代码的步骤：每次在make project之前，它会扫描项目中所有的@Entity文件（greenDAO中数据库的实体类），根据实体类生成DaoSession、DaoMaster以及所有实体类的dao类，生成的文件默认目录为：build/generated/source/greendao，当然也可以自行修改。

若不想修改生成的路径，可以将此路径设置为资源目录。我们也可以自定义这个路径，下面就来介绍如何在gradle中配置greenDAO的相关属性：

修改路径的方法：

在总的工程目录下添加以下代码：

greendao {
	//指定数据库schema版本号，迁移等操作会用到
    schemaVersion 1  

	//DaoSession、DaoMaster以及所有实体类的dao生成的目录,默认为你的entity所在的包名
	//daoPackage 包名
    daoPackage 'com.greendaodemo.greendao.gen'  

	//这就是我们上面说到的自定义生成数据库文件的目录了，可以将生成的文件放到我们的java目录中，而不是build中，这样就不用额外的设置资源目录了
	//工程路径
	targetGenDir 'src/main/java'
}

所以最后代码生成的位置是 src/main/java/greendaodemo/greendao/gen

---

有以下参数可以选择

schemaVersion：数据库架构的当前版本。这是使用的 * OpenHelpers类模式版本之间迁移。如果你改变你的实体/数据库架构，这个值必须增加。默认为1。

daoPackage：用于生成的DAO，DaoMaster和DaoSession包名称。 默认为源实体的包名。

targetGenDir：其中，生成源应保存在该位置。 默认为构建目录里面生成的源文件夹（ build / generated / source / greendao ）。

generateTests： 设置为true，自动生成单元测试。

targetGenDirTests： 在哪里产生的单元测试应该被存储在基本目录。默认为 SRC / androidTest / java的。

编写entity类

//@Entity 将我们的java普通类变为一个能够被greenDAO识别的数据库类型的实体类
@Entity
public class User {  

	//@Id：通过这个注解标记的字段必须是Long类型的，这个字段在数据库中表示它就是主键，并且它默认就是自增的
    @Id
    private Long id;  

    private String name;  //普通字段

	//@Transient：表明这个字段不会被写入数据库，只是作为一个普通的java类字段，用来临时存储数据的，不会被持久化
    @Transient
    private int tempUsageCount; // not persisted
}

编译一下(Build->Make Project)

make完成之后会发现我们的User类中突然多了好多代码，这就是greenDAO自动为你生成的代码。这时就会多了get、set方法，以及构造函数（无参、有参），同时发现src/main/java/greendaodemo/greendao/gen下多了DaoSession、DaoMaster以及所有实体类的dao,之后所有相关的数据库操作都依靠这三个文件了。

---

@Id注解选择 long / Long 属性作为实体ID。在数据库术语中，它是主键。参数自动增量，是使ID值不断增加（不会选用旧值）的标志。

@Property让你定义一个非默认的列名，其属性映射到。如果不存在，greenDAO将在SQL杂交方式使用字段名（大写，下划线，而不是骆驼情况下，例如 customName将成为 CUSTOM_NAME）。注意：您目前只能使用内联常量来指定列名。

@NotNull makes the property a “NOT NULL” column on the database side。通常是有意义的纪念原始类型（long, int, short, byte）与@NotNull，同时具有包装类（Long, Integer, Short, Byte）空的值。

@Transient表明这个字段不会被写入数据库，只是作为一个普通的java类字段，用来临时存储数据的，不会被持久化

@Entity 定义实体

@nameInDb 在数据库中的名字，如不写则为实体中类名

@indexes 索引

@createInDb 是否创建表，默认为true,false时不创建

@schema 指定架构名称为实体

@active 无论是更新生成都刷新

@Id

@NotNull 不为null

@Unique 唯一约束

@ToMany 一对多

@OrderBy 排序

@ToOne 一对一

@Transient 不存储在数据库中

@generated 由greendao产生的构造函数或方法

---

数据库侧的表和列名称派生自实体和属性名称。 而不是在Java中使用的骆驼案例样式，默认数据库名称使用大写，使用下划线分隔单词。

例如name在数据库中显示NAME，creationDate 显示CREATION_DATE

用法(增删改查操作)

1.初始化数据库

DaoMaster.DevOpenHelper devOpenHelper = new DaoMaster.DevOpenHelper(MyApplication.getContext(), "user-db", null);
DaoMaster daoMaster = new DaoMaster(devOpenHelper.getWritableDatabase());
DaoSession daoSession = daoMaster.newSession();
UserDao userDao = daoSession.getUserDao();

1. user-db是数据库名字（可以修改成别的，因为本来就不存在），应为我们之前创建了一个Entity叫做User，所以greenDAO自定帮我们生成的UserDao，拿到了这个UserDao，我们就可以操作User这张表了。

2. 一个DaoMaster就代表着一个数据库的连接；DaoSession可以让我们使用一些Entity的基本操作和获取Dao操作类，DaoSession可以创建多个，每一个都是属于同一个数据库连接的。

---

DaoMaster：使用greenDAO的切入点。 DaoMaster保存数据库对象（SQLiteDatabase）并管理特定模式的DAO类（而不是对象）。它有静态方法来创建表或删除它们。它的内部类OpenHelper和DevOpenHelper是SQLiteOpenHelper实现，在SQLite数据库中创建模式。

DaoSession：管理特定模式的所有可用DAO对象，您可以使用其中一个getter方法获取。 DaoSession还为实体提供了一些通用的持久性方法，如插入，加载，更新，刷新和删除。最后，DaoSession对象也跟踪标识范围。

DAO：数据访问对象（DAO）持续并查询实体。对于每个实体，greenDAO生成DAO。它具有比DaoSession更多的持久化方法，例如：count，loadAll和insertInTx。

实体：持久对象。通常，实体是使用标准Java属性（如POJO或JavaBean）表示数据库行的对象。

2.插入数据

操作都是基于对象的了

//新建一个对象
User user = new User(null, "001");
//插入
userDao.insert(user);

3.查找数据

List<User> userList = userDao.queryBuilder()
   .where(UserDao.Properties.Id.notEq(999))
   .orderAsc(UserDao.Properties.Id)
   .limit(5)
   .build().list();

queryBuilder()方法，生成一个查找构造器，可以给构造器添加where条件判断、按照某某字段排序以及查询的条数等基本的数据库操作。list()方法表示查询的结果为一个集合.上述代码查询的就是ID号不等于999，按升序排序，做多5条，返回List类型

list()所有实体被加载到内存中。其结果通常是一个 ArrayList中，最容易使用。

listLazy（）实体被装入点播存储器。一旦列表中的一个元素被首次访问，它被加载并高速缓存以供将来使用。必须关闭。

listLazyUncached（）一个“虚拟”实体名单：任何接触到从数据库加载其数据的列表元素的结果。必须关闭。

ListIterator（）通过懒加载的数据让你通过迭代的结果的。数据不会被缓存。必须关闭

方法 listLazy （）， listLazyUncached （），和 的ListIterator （）利用greenDAO的的LazyList类。要加载按需数据，它保存到数据库游标的引用。这是你必须确保关闭惰性列表和迭代器（通常在try / finally块）的原因。

查找单一个对象

User user = userDao.queryBuilder()
       .where(UserDao.Properties.Id.eq(999)).unique();

在多线程执行查询

如果您在使用多线程查询，您必须调用 forCurrentThread （）得到一个Query实例当前线程。

原始查询

如果QueryBuilder的不提供你所需要的，有执行原始SQL仍返回实体对象的两种方法。

第一，优选的方法是使用的QueryBuilder和 WhereCondition 。StringCondition。

有了这个，你可以传递任何SQL片段作为WHERE子句查询生成器。

例如：

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

第二种方法是使用 queryRaw或 queryRawCreate方法。

它们允许你通过原始SQL字符串，这是SELECT和实体列后面。通过这种方式，你可以有任何WHERE和ORDER BY要选择实体条款。实体表可以被称为使用别名。

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

4.修改数据

//1.where是查询条件，
//2.unique()表示查询结果为一条数据，若数据不存在，findUser为null。
User findUser = userDao.queryBuilder().where(UserDao.Properties.Name.eq("wyk")).build().unique();
if(findUser != null) {
    findUser.setName(newName);
	// update为更新
    userDao.update(findUser);
    Toast.makeText(MyApplication.getContext(), "修改成功", Toast.LENGTH_SHORT).show();
} else {
    Toast.makeText(MyApplication.getContext(), "用户不存在", Toast.LENGTH_SHORT).show();
}

5.删除数据

User findUser = userDao.queryBuilder().where(UserDao.Properties.Name.eq("wyk")).build().unique();
if(findUser != null){
	//通过Key来删除，这里的Key就是user字段中的ID号
    userDao.deleteByKey(findUser.getId());
}