前言
新接手的项目中正缺一款好用的数据库框架,趁着项目准备阶段来遍历了一下目前流行的几个框架GreenDao、Room、Realm、ObjectBox等。经过简单的阅读和对比,本着高(tou)效(lan)的开发原则,毅然选择GreenDao3.0来作为数据库框架。因为它使用起来太方便了!我觉得它已经简便到令人惊叹的地步了。
一、优势
在官方网站上,GreenDao用了6个词来形容自己的优势:
- Maximum performance:性能最高的
- Easy to use:便于使用
- Minimal:最小的内存消耗
- Small:包体积小
- Database encryption:支持数据库加密(3.0新功能)
- Strong community:强大的社区,目前在GitHub上拥有9000个star
简单来说就是多快好省了。他们还贴出了性能测试的比较图:
都讲到这个份上了!赶紧引入试一试吧。
二、引入
在project的build.gradle文件中加入
apply plugin: 'org.greenrobot.greendao'
dependencies {
classpath 'com.android.tools.build:gradle:2.1.3'
classpath 'org.greenrobot:greendao-gradle-plugin:3.2.0'
}
在app的 build.gradle 文件的中加入
android{
greendao{
//数据库的版本号
schemaVersion 1
}
}
dependencies {
compile 'org.greenrobot:greendao:3.2.0'
//如果你的数据库不需要加密的话就不需要这句
compile 'net.zetetic:android-database-sqlcipher:3.5.6'
}
另外在greendao{}中还可以指定编译生成的Dao文件的存放路径。默认是在:
也可以加上语句:targetGenDir ‘src/main/java’ ,这样生成的类就会与你所创建的那个数据库实体类在同一包下了。一般不需要修改它生成的代码的话就不需要这么设置了。
三、使用
首先创建一个实体类User
@Entity
public class User {
@Id(autoincrement = true)
private Long id;
@Property(nameInDb = "USER_NAME")
private String name;
@Property(nameInDb = "USER_AGE")
private int age;
}
通过注解来定义各个属性的值,需要注意的是主键id的类型是包装类Long而不是long,不然插入的时候会报错。这里简单介绍一下各种注解标签。
@Entity 标识实体类,greenDAO会映射成sqlite的一个表,表名为实体类名的大写形式
@Id 标识主键,该字段的类型为Long类型,autoincrement设置是否自动增长
@Property 标识该属性在表中对应的列名称, nameInDb设置名称
@Transient 标识该属性将不会映射到表中,也就是没有这列
@NotNull 设置表中当前列的值不可为空
@Convert 指定自定义类型(@linkPropertyConverter)
@Generated greenDAO运行所产生的构造函数或者方法,被此标注的代码可以变更或者下次运行时清除
@Index 使用@Index作为一个属性来创建一个索引;定义多列索引(@link Entity#indexes())
@JoinEntity 定义表连接关系
@JoinProperty 定义名称和引用名称属性关系
@Keep 注解的代码段在GreenDao下次运行时保持不变
1.注解实体类:默认禁止修改此类
2.注解其他代码段,默认禁止修改注解的代码段
@OrderBy 指定排序
@ToMany 定义与多个实体对象的关系
@ToOne 定义与另一个实体(一个实体对象)的关系
@Unique 向数据库列添加了一个唯一的约束
然后build一下工程就可以在上文的路径中找到生成的Dao文件。
接下来就是初始化了。这里我创建了一个管理类来做单例化管理。
GreenDaoManager:
public class GreenDaoManager {
private DaoSession daoSession;
private static class GreenDaoHolder {
private static GreenDaoManager Instance = new GreenDaoManager();
}
public static GreenDaoManager getInstance() {
return GreenDaoHolder.Instance;
}
public void init(Context context, String name) {
DaoMaster.DevOpenHelper devOpenHelper = new DaoMaster.DevOpenHelper(
context, name, null);
SQLiteDatabase writableDatabase = devOpenHelper.getWritableDatabase();
DaoMaster daoMaster = new DaoMaster(writableDatabase);
daoSession = daoMaster.newSession();
}
public DaoSession getDaoSession(){
return daoSession;
}
}
在Application中调用这个init();方法即可。
最后就是关键的增删改查了
UserDao userDao = GreenDaoManager.getInstance().getDaoSession().getUserDao();
// 增
userDao.insert(new User(null,"AmStrong","18"));
userDao.insert(new User(null,"AAA","18"));
// 查
List<User> list = userDao.queryBuilder()
.offset(1)//偏移量,相当于 SQL 语句中的 skip
.limit(3)//只获取结果集的前 3 个数据
.orderAsc(UserDao.Properties.Age)//通过 Age 这个属性进行正序排序
.where(UserDao.Properties.Name.eq("AmStrong"))//数据筛选,只获取 Name = "AmStrong" 的数据。
.build()
.list();
// 改
for (int i = 0; i < list.size(); i++) {
if ("AmStrong".equals(list.get(i).getName())) {
list.get(i).setName("AmStrong_");
userDao.update(list.get(i));
}
}
// 删
for (int i = 0; i < list.size(); i++) {
if ("AAA".equals(list.get(i).getName())) {
userDao.deleteByKey(list.get(i).getId());//通过 Id 来删除数据
// userDao.delete(list.get(i));//通过传入实体类的实例来删除数据
}
}
另外需要多次查询的情况下可以保存Query实例:
Query<User> build = userDao.queryBuilder().build();
List<User> list1 = build.list();
四、加密
如果是需要加密的情况下DaoManager管理类中初始化就要改成:
public void init(Context context, String name) {
DaoMaster.DevOpenHelper devOpenHelper = new DaoMaster.DevOpenHelper(
context, name, null);
DaoMaster daoMaster = new DaoMaster(devOpenHelper.getEncryptedWritableDb(PWD));
daoSession = daoMaster.newSession();
}
这里的PWD就是自己设置的值了。注意设置了密码之后,获取DaoSession对象的时候都需要利用到getEncryptedWritableDb(PWD)方法获取了。
总结
关于GreenDao的简介和基础就介绍到这里。更多复杂的操作就需要在实际项目中去探索了。