GreenDao使用步骤
1 引入GreenDao
先在project的build.gradle中引入GreenDao支持插件
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'org.greenrobot:greendao-gradle-plugin:3.2.2'
}
}
然后在app的build.gradle中添加依赖
implementation 'org.greenrobot:greendao:3.2.2'
2配置GreenDao
同样是在app的build.gradle中的android{}外面添加配置
apply plugin: 'org.greenrobot.greendao'
在app的build.gradle中的android{}里面添加配置
greendao {
schemaVersion 1
daoPackage 'com.rangeidc.android.alarm.database.db'
targetGenDir 'src/main/java'
}
targetGenDir 表示greenDAO生成的DAOMaster和DaoSession的位置
daoPackage 表示根据数据库实体类生成的XXXDao类的路径
然后Sync Now即可。
到这里为止,GreenDao的基本配置就差不多了。
3建立数据库实体类
当实体类创建成功之后, studio会根据此实体类,自动生成XXXDao类并保存在在build.gradle中配置的daoPackage路径下
@Entity
public class User {
@Id(autoincrement = true)//设置自增长
private Long id;
@Property(nameInDb = "USERNAME")
private String name; //人员姓名
@Index(unique = true)//设置唯一性
private String perNo;//人员编号
private String sex;//人员性别
}
@Entity 表示这个实体类一会会在数据库中生成对应的表
@Id 表示该字段是id ,它是主键,通过这个注解标记的字段必须是Long类型的,这个字段在数据库中表示它就是主键,并且它默认就是自增的
@Property 则表示该属性将作为表的一个字段,其中nameInDb看名字就知道这个属性在数据库中对应的数据名称
@Index(unique = true)//设置唯一性
更多注解可以参考GreenDaoDemo中的User类
在我们Make Project后,实体内的变化如下所示:
@Entity
public class PersonInfor {
@Id(autoincrement = true)//设置自增长
private Long id;
@Index(unique = true)//设置唯一性
private String perNo;//人员编号
private String name;//人员姓名
private String sex;//人员姓名
@Generated(hash = 1311768890)
public PersonInfor(Long id, String perNo, String name, String sex) {
this.id = id;
this.perNo = perNo;
this.name = name;
this.sex = sex;
}
@Generated(hash = 1362534400)
public PersonInfor() {
}
public Long getId() {
return this.id;
}
public void setId(Long id) {
this.id = id;
}
public String getPerNo() {
return this.perNo;
}
public void setPerNo(String perNo) {
this.perNo = perNo;
}
public String getName() {
return this.name;
}
public void setName(String name) {
this.name = name;
}
public String getSex() {
return this.sex;
}
public void setSex(String sex) {
this.sex = sex;
}
}
我们可以看到编译后1.自动生成无参,有参构造。2.自动生成getter,setter方法。
4 数据库初始化
// 首先获取一个DevOpenHelper对象,这个类有点类似于我们使用的SqliteOpenHelper
DaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(this, "user.db");
// 通过Helper类获取DaoMaster类
DaoMaster daoMaster = new DaoMaster(helper.getWritableDb());
// 通过DaoMaster获取DaoSession类,此类是操作数据库的关键
DaoSesson daoSession = daoMaster.newSession();
5 操作数据库
首先通过DaoSession获取响应的XXXDao对象
UserDao userDao = daoSession.getUserDao();
插入数据
User user = new User();
user.setName(editName.getText().toString());
userDao.insert(user);
查询数据
List users = userDao.queryBuilder().list();
=======================分割线=======================
至此,GreenDao的简单调用就完成了。现在我来带大家简单分析一下。
在Android开发过程中,有时候我们需要使用SQLite数据库去本地存储一些临时文件,之前,我们的做法是通过SQLiteOpenHelper实现创建数据库,以及迭代开发中的数据库数据 内容 字段 变更时处理。
优点
1.通常我们在使用GreenDao的时候,我们只需定义数据模型,GreenDao框架将创建数据对象(实体)和DAO(数据访问对象),能够节省部分代码。
2.不向性能妥协,使用了GreenDao,大多数实体可以以每秒几千个实体的速率进行插入,更新和加载。
3.GreenDao支持加密数据库来保护敏感数据。
4.微小的依赖库,GreenDao的关键依赖库大小不超过100kb.
5.如果需要,实体是可以被激活的。而活动实体可以透明的解析关系(我们要做的只是调用getter即可),并且有更新、删除和刷新方法,以便访问持久性功能。
6.GreenDao允许您将协议缓冲区(protobuf)对象直接保存到数据库中。如果您通过protobuf通话到您的服务器,则不需要另一个映射。常规实体的所有持久性操作都可以用于protobuf对象。所以,相信这是
GreenDao的独特之处。
7.自动生成代码,我们无需关注实体类以及Dao,因为GreenDao已经帮我们生成了。
8.开源 有兴趣的同学可以查看源码,深入去了解机制。
GreenDao对外提供的核心类简介
1.DaoMaster
DaoMaster保存数据库对象(SQLiteDatabase)并管理特定模式的Dao类。它具有静态方法来创建表或将他们删除。其内部类OpenHelper和DevOpenHelper是在SQLite数据库中创建模式的SQLiteOpenHelper实现。
2.DaoSession
管理特定模式的所有可用Dao对象,您可以使用其中一个getter方法获取。DaoSession还为实体提供了一些通用的持久性方法,如插入,加载,更新,刷新和删除。最后,DaoSession对象也跟踪一个身份范围。
3.Dao层
数据访问对象(Dao)持续存在并查询实体。对于每个实体,GreenDao生成一个Dao,它比DaoSession有更多的持久化方法,例如:count,loadAll和insertInTx。
4.实体
持久对象,通常实体是使用标准Java属性(如POJO或JavaBean)来表示数据库的对象。
GreenDao的介绍和使用就到此为止了,这个框架很方便,值得一用。
GreenDao的简单封装
1.GreenDao管理类的封装
网上也有很多类似的GreenDao的管理,用于数据库的增删改查,我这里简单做个封装,增强它的扩展性。
package com.rangeidc.android.alarm.database;
import android.content.Context;
import com.rangeidc.android.alarm.database.db.DaoMaster;
import com.rangeidc.android.alarm.database.db.DaoSession;
import org.greenrobot.greendao.query.QueryBuilder;
/**
* Created by zhangbowen on 2019/1/30.
**/
public class DaoManager {
private static final String DB_NAME = "day_week.db";
private static final String TAG = DaoManager.class.getSimpleName();
private static volatile DaoManager daoManager; //多线程 使用单例模式
private static DaoMaster daoMaster;
private static DaoSession daoSession;
private static DaoMaster.DevOpenHelper helper;
private Context context;
/*
* 使用单例模式 保证数据库的安全
* */
public static DaoManager getInstance() {
DaoManager instance = null;
if (daoManager == null) {
synchronized (DaoManager.class) {
if (instance == null) {
instance = new DaoManager();
}
daoManager = instance;
}
}
return daoManager;
}
/*
* 初始化daomanager
* */
public void init(Context context) {
this.context = context;
}
/**
* 判断是否存在数据库,如果没有则创建数据库
*
* @return
*/
public DaoMaster getDaoMaster() {
if (daoMaster == null) {
helper = new DaoMaster.DevOpenHelper(context, DB_NAME, null);
daoMaster = new DaoMaster(helper.getWritableDatabase());
}
return daoMaster;
}
/**
* 完成对数据库的添加 修改 查询 的操作 仅仅是一个接口
*
* @return
*/
public DaoSession getDaoSession() {
if (daoSession == null) {
if (daoMaster == null) {
daoMaster = getDaoMaster();
}
daoSession = daoMaster.newSession();
}
return daoSession;
}
/*
* 是否打印 数据库的日志信息 默认不开启
* */
public void setDebug(Boolean isDebug) {
if (isDebug) {
QueryBuilder.LOG_SQL = true;
QueryBuilder.LOG_VALUES = true;
} else {
QueryBuilder.LOG_SQL = true;
QueryBuilder.LOG_VALUES = true;
}
}
/*
* 关闭 help
* */
public void closeHelper() {
if (helper != null) {
helper.close();
helper = null;
}
}
/*
* 关闭 会话
* */
public void closeSession() {
if (daoSession != null) {
daoSession.clear();
daoSession = null;
}
}
/*
* 关闭所有的操作 数据库用完的时候必须关闭 节省资源
*/
public void closeConnection() {
closeHelper();
closeSession();
}
}
**2.定义一个MyApplication用于GreenDao的初始化操作
public class AppContext extends Application implements SSContextProvider {
public static AppContext appContext;
public static AppContext getInstance() {
return appContext;
}
@Override
public void onCreate() {
super.onCreate();
appContext = this;
// * 配置数据库
new DailyDao(appContext);
}
- 初始化数据库
- 把DaoSession写在单例的Application里,以后调用的时候就不需要new了
3.封装的使用
// 插入到数据库
DailyDao.insertDaily(dailyWeeklyDateBeans);
// 查询数据是否有此时间地址的数据
DailyWeeklyDateBean fromLocal = DailyDao.findFromLocal(reportType, time, address);
// 删除所有
DailyDao.deleteAllDaily();
//修改数据
DailyDao.updateDaily(dailyWeeklyDateBeans);
可以通过MyApplication拿到DaoSession对象,在拿到你的Dao对象,如果你本地有多个实体类,Make Project会生成多个dao对象,一个实体类就是一张表
拿到你想操作的表的Dao对象(如果你本地有多张表的时候)
在传入GreenDaoManager管理器,生成对象
通过对象进行增删改查操作
总结
以上就是我对GreenDao的简单封装,当你本地有多张表的时候使用起来就非常方便了,扩展性很强,有知道还可以在优化的小伙伴欢迎私信我~
最后附上[源码]