之前看了不少篇文章关于GreenDao的文章 ,感觉使用这个操作数据库还是很好用的,帮我们省了不少的查询代码’
一:了解
弄明白greenDao之前我们应该先了解什么是ORM(Object Relation Mapping 即 对象关系映射),说白了就是将面向对象编程语言里的对象与数据库关联起来的一种技术,而greenDao就是实现这种技术之一,所以说greenDao其实就是一种将java object 与SQLite Database关联起来的桥梁,它们之间的关系 如下图所示;
二:功能
greenDAO的功能一目了然
1:最高性能(可能是Android上最快的ORM); 我们的基准也是开源的
2:易于使用的强大API涵盖关系和连接
3:最小的内存消耗
4:小库大小(<100KB),以保持较低的构建时间并避免65k方法限制
5:数据库加密:greenDAO支持SQLCipher,以确保用户的数据安全
6:强大的社区:超过5000个GitHub明星表明有一个强大而活跃的社区
三.配置
第一步:build.gradle(主项目的progect)
// Top-level build file where you can add configuration options common to all sub-projects/modules.
buildscript {
repositories {
google()
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:3.1.2'
classpath 'org.greenrobot:greendao-gradle-plugin:3.2.2'
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
}
}
allprojects {
repositories {
google()
jcenter()
}
}
task clean(type: Delete) {
delete rootProject.buildDir
}
第二步:build.gradle(app的)
apply plugin: 'com.android.application
//greenDao插件
apply plugin: 'org.greenrobot.greendao'
android {
compileSdkVersion 27
defaultConfig {
applicationId "com.example.ausu.big_progect"
minSdkVersion 15
targetSdkVersion 27
versionCode 1
versionName "1.0"
testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
}
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
//greenDao指定版本和路劲等
greendao {
//数据库的schema版本,也可以理解为数据库版本号
schemaVersion 1
//设置DaoMaster、DaoSession、Dao包名,也就是要放置这些类的包的全路径。
daoPackage 'com.example.ausu.big_progect.dao'
//设置DaoMaster、DaoSession、Dao目录
targetGenDir 'src/main/java'
}
}
dependencies {
implementation fileTree(include: ['*.jar'], dir: 'libs')
implementation 'com.android.support:appcompat-v7:27.1.1'
implementation 'com.android.support.constraint:constraint-layout:1.1.3'
implementation 'com.android.support:support-v4:27.1.1'
testImplementation 'junit:junit:4.12'
androidTestImplementation 'com.android.support.test:runner:1.0.2'
androidTestImplementation 'com.android.support.test.espresso:espresso-core:3.0.2'
//greenDao依赖
implementation 'org.greenrobot:greendao:3.2.2'
}
通过以上操作就完成我们的基本配置了;
四:使用
1:创建一个实体类
@Entity
public class Bean {
@Id
private Long id;
private String date;
@Unique
private String key;
private int step;
}
注意:编写完实体类以后在实体类界面下按下Ctrl+F9(Make project),程序会自动编译生成dao文件,生成的文件一共有三个。
2.核心类介绍
DaoMaster
是GreenDao的入口也是greenDao顶级对象,对于一个指定的表单持有数据库对象(SQLite数据库)并且能够管理DAO类,能够创建表和删除表,其内部类OpenHelper 与DevOpenHelper是创建SQlite数据库的SQLiteOpenHelper的具体实现
DaoSession
对于一个指定的表单可以管理所有的Dao 对象。也能够对实体类执行 insert ,load,update,refresh.delete操作。
DaoSession也能跟踪 identity scope:即session查询后的实体会存在缓存中,并给该实体生成一个flag来追踪该实体,下次再次查询时会直接从缓存中取出来而不是从数据库中取出来
xxxDAO
能够持久访问和查询实体类,比起DaoSession有更多的持久化方法 count, loadAll,insertInt等等;
Entities - 可持久化对象, 通常,实体是使用标准Java属性(如POJO或JavaBean)表示数据库行的对象
3:创建一个application类,在application中完成DaoSession的初始化,避免以后重复初始化,便于使用。
public class BaseApp extends Application {
private static BaseApp sInstance;
private DaoMaster.DevOpenHelper mHelper;
private DaoMaster mDaoMaster;
private DaoSession mDaoSession;
@Override
public void onCreate() {
super.onCreate();
sInstance = this;
setDatabase();
}
/**
* 设置greenDao
*/
private void setDatabase() {
//通过DaoMaster内部类DevOpenHelper可以获取一个SQLiteOpenHelper 对象
// 可能你已经注意到了,你并不需要去编写「CREATE TABLE」这样的 SQL 语句,因为 greenDAO 已经帮你做了。
// 注意:默认的 DaoMaster.DevOpenHelper 会在数据库升级时,删除所有的表,意味着这将导致数据的丢失。
// 所以,在正式的项目中,你还应该做一层封装,来实现数据库的安全升级。
// 此处MyDb表示数据库名称 可以任意填写
mHelper = new DaoMaster.DevOpenHelper(this, "MyDb", null);
SQLiteDatabase db = mHelper.getWritableDatabase();
mDaoMaster = new DaoMaster(db);
mDaoSession = mDaoMaster.newSession();
}
public static BaseApp getInstance(){
return sInstance;
}
public DaoSession getDaoSession(){
return mDaoSession;
}
}
4.数据库操作
//获取xxxDao对象
private BeanDao mBeanDao = BaseApp.getInstance().getDaoSession().getBeanDao();
插入数据
//插入一条数据
//mBeanDao.insert(new Bean(...));
//插入多条数据
//mBeanDao.insertInTx();
//插入或者替换,如果不存在就插入,存在就修改(insert+update)
//mBeanDao.insertOrReplace(new Bean(...));
//插入或替换多条数据
//mBeanDao.insertOrReplaceInTx(beans);
删除数据
//删除一条数据
mBeanDao.delete(new Bean(100l, date, 12+"",10));
//删除一条数据,根据key也就是id
mBeanDao.deleteByKey();
//删除所有数据
mBeanDao.deleteAll();
//删除一组数据(对象)
mBeanDao.deleteInTx();
//删除一组数据(根据id)
mBeanDao.deleteByKeyInTx();
修改数据
//更新一条数据
//mBeanDao.update(new Bean(1l, date, 1800));
//更新一组数据,没有对应id的不做处理
ArrayList<Bean> beans = new ArrayList<>();
for (int i = 0; i < 5; i++) {
beans.add(new Bean((long)i,new Date().toString(),i+10+"",i+100));
}
mBeanDao.updateInTx(beans);
查询数据
//查询所有
//List<Bean> list = mBeanDao.queryBuilder().list();
List<Bean> list = mBeanDao.loadAll();
//精确查找
Bean unique = mBeanDao.queryBuilder().where(BeanDao.Properties.Key.eq("2")).unique();
//精确查找
/*List<Bean> list2 = mBeanDao.queryBuilder().where(BeanDao.Properties.Step.eq(100)).list();
*/
//模糊查找,查找以1打头的key
/*List<Bean> list2 = mBeanDao.queryBuilder().where(BeanDao.Properties.Key.like("1%")).list();
*/
//区间查询
//大于gt()
List<Bean> list2 = mBeanDao.queryBuilder().where(BeanDao.Properties.Step.gt(102)).list();
//大于等于ge()
//小于 lt()
//小于等于le()
//介于中间between(100,102)
//查询大于step 大于102 的数据,并按照id升序排列
List<Bean> list2 = mBeanDao.queryBuilder().where(BeanDao.Properties.Step.
gt(102))
.orderAsc(BeanDao.Properties.Id).list();
特殊意思
- eq():==
- noteq():!=
- gt(): >
- lt():<
- ge:>=
- le:<=
- like():包含
- between:俩者之间
- in:在某个值内
- notIn:不在某个值内
分页查询
limit(int): 限制查询的数量;
offset(int): 每次返回的数量; offset不能单独使用;
查询与LazyList类:
list() 缓存查询结果;list()类型一般为ArrayList
listLazy() 懒查询,只有当调用list()中的实体对象时才会执行查询操作并且只缓存第一次被查询的结果,需要关闭
listlazyUncached() 懒查询,只有当调用list()中的实体对象时才会执行查询操作并且不缓存;
listIterator() 对查询结果进行遍历,不缓存,需要关闭;
后面三个方法是LazyList类中的方法,LazyList为了执行不同的缓存策略其内部持有数据库的cursor对象;一般情况下这三个方法执行完毕后会自动关闭cursor;但是防止在还没有执行完查询结果时,对象被终结cursor还是无法被关闭的情况发生,需要手动关闭close();
总结:
增加单个数据
getShopDao().insert(shop);
getShopDao().insertOrReplace(shop);
增加多个数据
getShopDao().insertInTx(shopList);
getShopDao().insertOrReplaceInTx(shopList);
查询全部
List< Shop> list = getShopDao().loadAll();
List< Shop> list = getShopDao().queryBuilder().list();
查询附加单个条件
.where()
.whereOr()
查询附加多个条件
.where(, , ,)
.whereOr(, , ,)
查询附加排序
.orderDesc()
.orderAsc()
查询限制当页个数
.limit()
查询总个数
.count()
修改单个数据
getShopDao().update(shop);
修改多个数据
getShopDao().updateInTx(shopList);
删除单个数据
getTABUserDao().delete(user);
删除多个数据
getUserDao().deleteInTx(userList);
删除数据ByKey
getTABUserDao().deleteByKey();
5:基本注释属性
1 .实体和注释
@Entity
告诉GreenDao 该Bean类需要持久化。只有使用@Entity注释的Bean类才能被dao类操作
@Entity可以在不使用参数下使用,但是也可以给Entity配置参数,其参数如下
//如果该实体属于多个表单,可以使用该参数;
schema = "myschema",
// 该实体属于激活状态,激活状态的实体有更新,删除,刷新方法;
active = true,
// 给这个表指定一个名字,默认情况下是名字是类名
nameInDb = "AWESOME_USERS",
// 可以给多个属性定义索引和其他属性.
indexes = { @Index(value = "name DESC", unique = true) },
//是否使用GreenDao创建该表,默认为true,false时不创建
createInDb = false,
// 是否所有的属性构造器都应该被生成,无参构造器总是被要求
generateConstructors = true,
// 如果该类中没有set get方法是否自动生成
generateGettersSetters = true
@Transient
private int tempUsageCount; // 没有存入数据库中
@ID 一般会选择long/Long属性作为Entity ID(即数据库中的主键)autoincrement=true表示主键会自增如果false就会使用旧值
@Property 可以自定义一个该属性在数据库中的名称,默认情况下数据库中该属性名称是Bean对象中的 属性名但是不是以驼峰式而是以大写与下划线组合形式来命名的比如:customName将命名为 CUSTOM_NAME;注意:外键不能使用该属性;
@NotNull 确保属性值不会为null值;
@Transient 使用该注释的属性不会被存入数据库中;
@Unique 将属性变成唯一约束属性;也就是说在数据库中该值必须唯一
@Generated 提示开发者该属性不能被修改;并且实体类的方法,属性,构造器一旦被@Generated注释就不能被再次修改,否则或报错
Error:Execution failed for task ':app:greendao'.> Constructor (see
ExampleEntity:21) has been changed after generation.Please either mark
it with @Keep annotation instead of @Generated to keep it untouched,or
use @Generated (without hash) to allow to replace it.
这是因为在通过javabean对象自动生成entities类时,greenDao会增加实体类代码,@Generated注释部分与GreenDao增加的代码相关,胡乱修改@Generated代码,就会导致entities部分属性与javabean不匹配导致报错;有俩种方法可以避免这种错误
1:还原@Generated 改动的部分,当然你也可以完全删除@Generated 注释的部分下一次 app build时将会自动生成;
2: 使用@Keep 代替@Generated 这将告诉greenDao 不会使用该属性注释的代码,但是这种改变可能会破坏entities类和greenDAO的其他部分的连接;注意:默认情况下 greenDao会使用合理的默认值去设置实体类,因此开发者不需要为每个属性都添加注释
主键限制
每个实体类都应该有一个long或者LONG型属性作为主键;如果你不想用long或者LONG型作为主键,你可以使用一个唯一索引(使用@Index(unique = true)注释使普通属性改变成唯一索引属性)属性作为关键属性。
@Id
private Long id;
@Index(unique = true)
private String key;
索引属性
使用@Index 可以将一个属性变为数据库索引;其有俩个参数
name :不使用默认名称,自定义索引名称
unique : 给索引增加一个唯一约束,迫使该值唯一
@Entity
public class User {
@Id
private Long id;
@Index(unique = true)
private String name;
}
@ToOne 一对一 关系表
@ToMany 一对多
@OrderBy 排序
6:一对一 / 一对多
1.session 缓存
如果你有多个相同的查询语句去执行,猜猜看返回给你的对象是一个还是多个?比如说像下面这样
QueryBuilder<Project> projectQueryBuilder = projectDao
.queryBuilder()
.where(ProjectDao.Properties.UserName.eq("123456"));
Query<Project> query = projectQueryBuilder.build();
Project project1=query.unique();
QueryBuilder<Project> projectQueryBuilder1 = projectDao
.queryBuilder()
.where(ProjectDao.Properties.UserName.eq("123456"));
Query<Project> query2 = projectQueryBuilder1.build();
Project project2=query.unique();
答案是project1==project2而且project2查询出来的速度要比project1查询出来的速度快很多倍;
这是因为在同一个session中如果一个entities已经被session记录那么下一次再次操作该实体时,greenDao会先从内存中查找,如果内存中没有再去数据库中查找。这样一方面就极大的提高greenDao的查询效率,另一方面也是需要特别注意的是当entities更新过 greenDao仍然会从内存中取出旧值,所以如果entities更新过,需要去调用daoseesion.clear()方法清除缓存后才能查到最新值,否则查询到的将还是保存在内存中的值。
下面介绍下清除缓存有两种方法
清除所所有的缓存
daoSession.clear();
清除指定Dao类的缓存
projectDao = daoSession.getNoteDao();
projectDao.detachAll();
2.一对一关联
当我们在使用sqlite数据库来实现表的1:1关联时,通常我们会在主表中定义一个外键去关联副表,当要查询对应的数据时,首先我们要知道查询数据的外键,然后需要用外键去副表中查询所需要的数据。比如下面这样
public class Customer {
private Long id;
}
public class Order {
private Long id;
private Date date;
private long customerId;
}
Customer表通过id与Order表关联,查询Order的Customer时需要先知道Order中的customerId然后根据id=customerId值再去数据库中查询该id所对应的Customer对象。然而在greenDao中一个注释就可以搞定,只需要使用@ToOne注释来定义一个关联对象即可。
@ToOne 定义了一个entities与另一个entities的1:1对应关系。通过joinProperty参数来定义一个外键下面是代码示例
public class Order {
@Id
private Long id;
private long customerId;
@ToOne(joinProperty = "customerId")
private Customer customer;
}
@Entity
public class Customer {
@Id
private Long id;
}
这样只要获得Order对象就能通过getCustomer()方法获取Order所对应的Customer了,这样是不是很高效,很简便。其实getCustomer方法也很简单,就是在底层帮助我们封装好了查询语句而已,另外getCustomer获取的对象也是懒查询机制,只有真正使用getCustomer方法查询到的对象时greenDao才会执行查询操作。如果你想立即执行查询操作可以调用DAO类的loadDeep()与queryDeep()方法。
3.一对多
在1对1关联中每个顾客只能与一个订单对应,但是现实生活中肯定不只是这样,也会出现一个顾客下多个订单的情况。如果出现这种需求的话,按照原生Sqlite的思路一样是通过外键关联即可,只是这一次查询的对象会有很多个,但是使用greenDao的1:1关联方式显然不行。不过别担心greenDao还给我们准备了@ToMany注释。
@ToMany 定义了一个entities(这个标记为源实体)与另一个entities(这个标记为目标实体)的多个对象的关联关系:@Tomany有一下三种方式来定义1:N的映射关系。
referencedJoinProperty 在目标实体中我们需要定义一个与源实体关联起来的外键,即Order中的customerId,然后需要在源实体里我们需要将customerId作为referencedJoinProperty的属性。说起来很拗口,其实代码很简单;
@Entity
public class Customer {
@Id private Long id;
@ToMany(referencedJoinProperty = "customerId")
@OrderBy("date ASC")
private List<Order> orders;
}
@Entity
public class Order {
@Id private Long id;
private Date date;
private long customerId;
}
是不是很简单通过referencedJoinProperty来标注下俩个实体之间的外键即可
joinProperties这个参数是referencedJoinProperty 参数的升级版。在referencedJoinProperty参数中我们发现俩个实体关联的外键是CustomerId与id,但是如果我们的需求是外键不能通过id来定义,需要用自己自定义属性来定义,第一种方法就没法用了,而joinProperties就是为了解决这个需求的。
@Entity
public class Customer {
@Id private Long id;
@Unique private String tag;
@ToMany(joinProperties = {
@JoinProperty(name = "tag", referencedName = "customerTag")
})
@OrderBy("date ASC")
private List<Site> orders;
}
@Entity
public class Order {
@Id private Long id;
private Date date;
@NotNull private String customerTag;
}
其实如果把
@ToMany(joinProperties = {
@JoinProperty(name = "id", referencedName = "customerId")
})
7.多表查询
有些时候我们的表没有使用ToOne与ToMany建立关联关系,但是我们又想一步到位。这时我们可以使用greenDao的多表查询功能来帮助我们减少不必要的代码。
1. 关联单个表
//查询地址是住在迪拜大楼的用户
QueryBuilder<User> queryBuilder = userDao.queryBuilder();
queryBuilder.join(Address.class, AddressDao.Properties.userId)
.where(AddressDao.Properties.Street.eq("迪拜大楼"));
List<User> users = queryBuilder.list();
通过queryBuilder.join()方法即可完成,其用法也很简单第一个参数是关联的类,第二个是关联类中的关联属性。
2.关联多个表
//查询在欧洲人口超过100000的城市
QueryBuilder qb = cityDao.queryBuilder().where(Properties.Population.ge(1000000));
Join country = qb.join(Properties.CountryId, Country.class);
Join continent = qb.join(country, CountryDao.Properties.ContinentId,
Continent.class, ContinentDao.Properties.Id);
continent.where(ContinentDao.Properties.Name.eq("Europe"));
List<City> bigEuropeanCities = qb.list();
通过queryBuilder.join()链式调用来实现多表查询
注意:多表查询的前提是我们已经定义好了外键来关联表与表之间的关系。
8.数据库升级
在版本迭代时,我们经常需要对数据库进行升级,而GreenDAO默认的DaoMaster.DevOpenHelper在进行数据升级时,会把旧表删除,然后创建新表,并没有迁移旧数据到新表中,从而造成数据丢失。
这在实际中是不可取的,因此我们需要作出调整。下面介绍数据库升级的步骤与要点。
第一步:
复制MigrationHelper到项目,网上有不少MigrationHelper的源码,这里采用的是https://github.com/yuweiguocn/GreenDaoUpgradeHelper中的MigrationHelper,它主要是通过创建一个临时表,将旧表的数据迁移到新表中,大家可以去看下源码。
public class MyOpenHelper extends DaoMaster.OpenHelper {
public MyOpenHelper(Context context, String name, SQLiteDatabase.CursorFactory factory) {
super(context, name, factory);
}
@Override
public 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);
}
}, BeanDao.class);
}
}
新建一个类,继承DaoMaster.DevOpenHelper,重写onUpgrade(Database db, int oldVersion, int newVersion)方法,在该方法中使用MigrationHelper进行数据库升级以及数据迁移。
然后使用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即可,最后运行app
greendao {
//数据库版本号,升级时进行修改
schemaVersion 2
daoPackage 'com.dev.base.model.db'
targetGenDir 'src/main/java'
}