本文共 10455 字，大约阅读时间需要 34 分钟。
Android之greenDao使用
文章大纲一、greenDao简介二、greenDao实战三、项目源码下载四、参考文章一、greenDao简介
（2）GreenDao的github地址
（3）GreenDao的Google讨论区（4）GreenDao 加密SQLCipher for Android官方说明地址（5） GreenDao使用文档DaoMaster：Dao中的管理者。它保存了sqlitedatebase对象以及操作DAO classes（注意：不是对象）。其提供了一些创建和删除table的静态方法，其内部类OpenHelper和DevOpenHelper实现了
SQLiteOpenHelper，并创建数据库的框架。DaoSession：会话层。操作具体的DAO对象（注意：是对象），比如各种getter方法。
Daos：实际生成的某某DAO类，通常对应具体的java类，比如NoteDao等。其有更多的权限和方法来操作数据库元素。
Entities：持久的实体对象。通常代表了一个数据库row的标准java properties。
(2)性能最大化
(3)内存开销最小化(4)易于使用的 APIs(5)对 Android 进行高度优化二、greenDao实战
在app的build.gradle添加
具体代码如下：
apply plugin: 'com.android.application'
//添加greendao相关的plugin
apply plugin: 'org.greenrobot.greendao'android {
compileSdkVersion 27defaultConfig { applicationId "top.daxianwill.greendaodemo" minSdkVersion 15 targetSdkVersion 27 versionCode 1 versionName "1.0"}buildTypes { release { minifyEnabled false proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' }}greendao{ //指定数据库schema版本号，迁移等操作会用到; schemaVersion 1 //dao的包名，包名默认是entity所在的包； daoPackage 'com.greendao.gen' //生成数据库文件的目录; targetGenDir 'src/main/java'} }
dependencies {
implementation fileTree(dir: 'libs', include: ['*.jar'])implementation 'com.android.support:appcompat-v7:27.1.1'implementation 'com.android.support.constraint:constraint-layout:1.1.0'//添加greendao相关依赖implementation 'org.greenrobot:greendao:3.2.2'
}
import org.greenrobot.greendao.annotation.Entity;
import org.greenrobot.greendao.annotation.Id;import org.greenrobot.greendao.annotation.Property;import org.greenrobot.greendao.annotation.Transient;import org.greenrobot.greendao.annotation.Generated;/**
@Entity 表示这个实体类一会会在数据库中生成对应的表，
@Id 表示该字段是id，注意该字段的数据类型为包装类型Long@Property 则表示该属性将作为表的一个字段，其中nameInDb看名字就知道这个属性在数据库中对应的数据名称。@Transient 该注解表示这个属性将不会作为数据表中的一个字段。@NotNull 表示该字段不可以为空@Unique 表示该字段唯一
*/
@Entity
public class User {@Idprivate Long id;@Property(nameInDb = "NAME")private String name;@Transientprivate int tempUsageCount; // not persisted@Generated(hash = 873297011)public User(Long id, String name) { this.id = id; this.name = name;}@Generated(hash = 586692638)public User() {}public Long getId() { return this.id;}public void setId(Long id) { this.id = id;}public String getName() { return this.name;}public void setName(String name) { this.name = name;} }
注解介绍
（1）@Entity 用来声明类实体，表示它将映射为数据表 @Entity（）括号内可加入更详细的设置，如：nameInDb =“TABLE_NAME” ——> 声明该表的表名，默认取类名createInDb = true ——> 是否创建表，默认为truegenerateConstructors = true ——> 是否生成含所有参数的构造函数，默认为truegenerateGettersSetters = true ——> 是否生成getter/setter，默认为true（2）@Id
用来声明某变量为表的主键，类型使用Long @Id（）括号可加入autoincrement = true表明自增长（3）@Unique
用来声明某变量的值需为唯一值（4）@NotNull
用来声明某变量的值不能为null（5）@Property
@Property(nameInDb = “URL”) 用来声明某变量在表中的实际字段名为URL（6）@Transient
用来声明某变量不被映射到数据表中（7）@ToOne、@ToMany
用来声明”对一”和“对多”关系，下面举例说明： 学生与学校之间一对多的关系（一个学生对应一个学校，一个学校对应有多个学生）@Entity
class Student{//...省略其他变量private long fk_schoolId;//外键@ToOne(joinProperty = "fk_schoolId")private School school;
}
@Entity
class School{//...省略其他变量 @ToMany(referencedJoinProperty = "fk_schoolId")private Liststudents;
}
学生与课程之间“多对多”的关系（一个学生对应有多门课程，一门课程对应有多个学生）@Entity
class Student{//...省略其他变量@ToMany@JoinEntity( entity = StudentWithCourse.class, sourceProperty = "sId", targetProperty = "cId")private Listcourses;
}
@Entity
class Course{//...省略其他变量@ToMany@JoinEntity( entity = StudentWithCourse.class, sourceProperty = "cId", targetProperty = "sId")private Listcourses;
}
@Entity
class StudentWithCourse{@Idprivate Long id;private Long sId;private Long cId;
}
DaoMaster：用于创建数据库以及获取DaoSession
DaoSession：用于获取各个表对应的Dao类 各个表对应的Dao：提供了对表进行增删改查的方法UserDao mUserDao = MyApplication.getInstances().getDaoSession().getUserDao();
进行数据增加public void insert(){ mUser = new User(id++,"any"+id); mUserDao.insert(mUser); notifyListView();} 补充：
(1)上述代码讲的是插入单条数据，插入多条数据方式为：List listUserCollect;
mUserDao.insertInTx(listUserCollect);(2)插入或替换数据//插入的数据如果已经存在表中，则替换掉旧数据（根据主键来检测是否已经存在）MovieCollect userCollect;
mUserDao.insertOrReplace(userCollect);//单个数据List listUserCollect;
mUserDao.insertOrReplace(listUserCollect);//一组数据进行数据删除public void delete(){
long l = mUserDao.count() - 1; mUserDao.deleteByKey(l); notifyListView();}
补充：
（1）上面代码讲的是删除一条数据，删除所有数据方式为：mUserDao.deleteAll();
（2）删除多条数据List listUserCollect;
mUserDao.deleteInTx(listUserCollect）;进行数据修改public void update(){ mUser = new User((long)3,"any0803"); mUserDao.update(mUser); notifyListView();} 补充：
（1）上面代码介绍的是修改单条数据，修改多条数据方式如下：List listUserCollect;
mUserDao.updateInTx(listUserCollect）;进行数据查询public void loadAll(){
mUserList = mUserDao.loadAll();//查询所有数据 notifyListView();}
补充：
（1）上面代码介绍的是查询所有数据，查询数据数量方式如下：int count = mUserDao.count();
（2）精确（where）条件查询//查询电影名为“肖申克的救赎”的电影
MovieCollect movieCollect = mMovieCollectDao.queryBuilder().where(MovieCollectDao.Properties.Title.eq("肖申克的救赎")).unique();//查询电影年份为2017的电影
List movieCollect =mMovieCollectDao.queryBuilder().where(MovieCollectDao.Properties.Year.eq(2017)).list();（3）模糊查询（like）//查询电影名含有“传奇”的电影
List movieCollect = mMovieCollectDao.queryBuilder().where(MovieCollectDao.Properties.Title.like("传奇")).list();//查询电影名以“我的”开头的电影
List movieCollect = mMovieCollectDao.queryBuilder().where(MovieCollectDao.Properties.Title.like("我的%")).list();（4）区间查询//大于
//查询电影年份大于2012年的电影List movieCollect = mMovieCollectDao.queryBuilder().where(MovieCollectDao.Properties.Year.gt(2012)).list();//大于等于
//查询电影年份大于等于2012年的电影List movieCollect = mMovieCollectDao.queryBuilder().where(MovieCollectDao.Properties.Year.ge(2012)).list();//小于
//查询电影年份小于2012年的电影List movieCollect = mMovieCollectDao.queryBuilder().where(MovieCollectDao.Properties.Year.lt(2012)).list();//小于等于
//查询电影年份小于等于2012年的电影List movieCollect = mMovieCollectDao.queryBuilder().where(MovieCollectDao.Properties.Year.le(2012)).list();//介于中间
//查询电影年份在2012-2017之间的电影List movieCollect = mMovieCollectDao.queryBuilder().where(MovieCollectDao.Properties.Year.between(2012,2017)).list();（5）升序降序//查询电影年份大于2012年的电影，并按年份升序排序
List movieCollect = mMovieCollectDao.queryBuilder().where(MovieCollectDao.Properties.Year.gt(2012)).orderAsc(MovieCollectDao.Properties.Year).list();//查询电影年份大于2012年的电影，并按年份降序排序
List movieCollect = mMovieCollectDao.queryBuilder().where(MovieCollectDao.Properties.Year.gt(2012)).orderDesc(MovieCollectDao.Properties.Year).list();（6）and/or//and
//查询电影年份大于2012年且电影名以“我的”开头的电影List movieCollect = mMovieCollectDao.queryBuilder().and(MovieCollectDao.Properties.Year.gt(2012), MovieCollectDao.Properties.Title.like("我的%")).list();//or
//查询电影年份小于2012年或者大于2015年的电影List movieCollect = mMovieCollectDao.queryBuilder().or(MovieCollectDao.Properties.Year.lt(2012), MovieCollectDao.Properties.Year.gt(2015)).list();解决方法：查询前先清空缓存，清空方法如下
//清空所有数据表的缓存数据
DaoSession daoSession = MyApplication.getInstances().getDaoSession();daoSession .clear();//清空某个数据表的缓存数据
UserDao userDao = MyApplication.getInstances().getDaoSession().getUserDao();userDao.detachAll();compile 'net.zetetic:android-database-sqlcipher:3.5.7'//使用加密数据库时需要添加
获取操作的数据库对象mSQLiteOpenHelper = new MySQLiteOpenHelper(MyApplication.getInstance(), DB_NAME, null);//建库
mDaoMaster = new DaoMaster(mSQLiteOpenHelper.getEncryptedWritableDb("你的密码"));//加密//mDaoMaster = new DaoMaster(mSQLiteOpenHelper.getWritableDatabase());mDaoSession = mDaoMaster.newSession();温馨提示：（1）使用上面步骤得到的DaoSession进行具体的数据表操作。（2）如果运行后报无法加载有关so库的异常，请对项目进行clean和rebuild。这在实际中是不可取的，因此我们需要作出调整。下面介绍数据库升级的步骤与要点。
第一步 新建一个类，继承DaoMaster.DevOpenHelper，重写onUpgrade(Database db, int oldVersion, int newVersion)方法，在该方法中使用MigrationHelper进行数据库升级以及数据迁移。网上有不少MigrationHelper的源码，这里采用的是中的MigrationHelper，它主要是通过创建一个临时表，将旧表的数据迁移到新表中，大家可以去看下源码。public class MyOpenHelper extends DaoMaster.OpenHelper {
public MyOpenHelper(Context context, String name, SQLiteDatabase.CursorFactory factory) { super(context, name, factory);}@Overridepublic void onUpgrade(Database db, int oldVersion, int newVersion) { //把需要管理的数据库表DAO作为最后一个参数传入到方法中 MigrationHelper.migrate(db, new MigrationHelper.ReCreateAllTableListener() { @Override public void onCreateAllTables(Database db, boolean ifNotExists) { DaoMaster.createAllTables(db, ifNotExists); } @Override public void onDropAllTables(Database db, boolean ifExists) { DaoMaster.dropAllTables(db, ifExists); } }, MovieCollectDao.class);} }
然后使用MyOpenHelper替代DaoMaster.DevOpenHelper来进行创建数据库等操作mSQLiteOpenHelper = new MyOpenHelper(MyApplication.getInstance(), DB_NAME, null);//建库
mDaoMaster = new DaoMaster(mSQLiteOpenHelper.getWritableDatabase());mDaoSession = mDaoMaster.newSession();第二步 在表实体中，调整其中的变量（表字段），一般就是新增/删除/修改字段。注意： （1）新增的字段或修改的字段，其变量类型应使用基础数据类型的包装类，如使用Integer而不是int，避免升级过程中报错。 （2）根据MigrationHelper中的代码，升级后，新增的字段和修改的字段，都会默认被赋予null值。第三步
将原本自动生成的构造方法以及getter/setter方法删除，重新Build—>Make Project进行生成。第四步
修改Module下build.gradle中数据库的版本号schemaVersion ，递增加1即可，最后运行appgreendao{//数据库版本号，升级时进行修改 schemaVersion 2 //dao的包名，包名默认是entity所在的包； daoPackage 'com.greendao.gen' //生成数据库文件的目录; targetGenDir 'src/main/java'} -keepclassmembers class * extends org.greenrobot.greendao.AbstractDao {
public static java.lang.String TABLENAME;}-keep class **$Properties-dontwarn org.greenrobot.greendao.database.**
-dontwarn rx.**
-keep class net.sqlcipher.* { ;}
-keep class net.sqlcipher.database.* { ;}三、项目源码下载
链接:密码:iel2四、参考文章
3.原文地址转载地址：http://frhbm.baihongyu.com/