GreenDao3.1的使用教程
最近有几个童鞋问我关于greendao的使用问题,以及碰见的一些坑,所以写这篇文章来说下。
GreenDao是什么?
greenDAO是一个对象关系映射(ORM)的框架,能够提供一个接口通过操作对象的方式去操作关系型数据库,它能够让你操作数据库时更简单、更方便。
官网地址:http://greenrobot.org/greendao/
Github地址:https://github.com/greenrobot/greenDAO
有哪些优势?
1、性能高,号称Android最快的关系型数据库,比sqlite性能高30%.
2、内存占用小
3、库文件比较小,小于100K,编译时间低,而且可以避免65K方法限制
4、支持数据库加密 greendao支持SQLCipher进行数据库加密 有关SQLCipher
5、简洁易用的API,也支持sql语句
使用流程:
第一步在项目的Project 的 buil.gradle 里设置如下
在buildscript- repositories添加配置mavenCentral(),
在dependencies 里添加
classpath 'org.greenrobot:greendao-gradle-plugin:3.1.0'
buildscript {
repositories {
jcenter()
mavenCentral()
}
dependencies {
classpath 'com.android.tools.build:gradle:2.1.2'
classpath 'org.greenrobot:greendao-gradle-plugin:3.1.0'
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
}
}
第二步在自己Module里 buil.gradle 里设置如下
2.1 头部添加
apply plugin:'org.greenrobot.greendao'
2.2 在dependencies 里添加
compile'org.greenrobot:greendao:3.1.0'
compile'org.greenrobot:greendao-generator:3.1.0'
2.3在android里添加
greendao{
schemaVersion 1
daoPackage'com.example.mytest.greendao.gen'
targetGenDir'src/main/java'
}
参数说明:
schemaVersion: 数据库schema版本,也可以理解为数据库版本号
daoPackage:设置DaoMaster、DaoSession、Dao包名
targetGenDir:设置DaoMaster、DaoSession、Dao目录
targetGenDirTest:设置生成单元测试目录
generateTests:设置自动生成单元测试用例
第三步创建实体类TestBean。
在实体类上方写上 @Entity 即可!然后不需要写set get 方法,编译后会自动帮我们生成.
编译后生成的界面
Application里的设置
增删改查的操作
先初始化
TestBeanDao testBeanDao = AppApplication.getApplication().getDaoSession().getTestBeanDao();
新增:
TestBean testBean=newTestBean(null,"zhangsan");
testBeanDao.insert(testBean);
删除:
testBeanDao.delete(testBean);
修改:
testBeanDao.update(testBean);
查询:
List list = testBeanDao.queryBuilder().where(TestBeanDao.Properties.Name.eq("zhangsan")).build().list(); 查询名字叫张三的人。这种可以满足多条件查询。
List list = testBeanDao.loadAll();查询所有
关于查询还有很多方法,如notEq、between、like等一些,大家可以根据需求来用。
注解说明
1.)实体@Entity注解
schema:告知GreenDao当前实体属于哪个schema
active:标记一个实体处于活动状态,活动实体有更新、删除和刷新方法
nameInDb:在数据中使用的别名,默认使用的是实体的类名
indexes:定义索引,可以跨越多个列
createInDb:标记创建数据库表**
2.)基础属性注解
@Id :主键 Long型,可以通过@Id(autoincrement = true)设置自增长
@Property:设置一个非默认关系映射所对应的列名,默认是的使用字段名举例:@Property (nameInDb="name")
@NotNul:设置数据库表当前列不能为空
@Transient:添加次标记之后不会生成数据库表的列
3.)索引注解
@Index:使用@Index作为一个属性来创建一个索引,通过name设置索引别名,也可以通过unique给索引添加约束
@Unique:向数据库列添加了一个唯一的约束
4.)关系注解
@ToOne:定义与另一个实体(一个实体对象)的关系
@ToMany:定义与多个实体对象的关系
(一) @Entity 定义实体
@nameInDb 在数据库中的名字,如不写则为实体中类名
@indexes 索引
@createInDb 是否创建表,默认为true,false时不创建
@schema 指定架构名称为实体
@active 无论是更新生成都刷新
(二) @Id
(三) @NotNull 不为null
(四) @Unique 唯一约束
(五) @ToMany 一对多
(六) @OrderBy 排序
(七) @ToOne 一对一
(八) @Transient 不存储在数据库中
(九) @generated 由greendao产生的构造函数或方法
注意事项:
1、默认数据库升级时会删除所有的表导致数据丢失,所以在正式的项目中需要另外封装一层,来实现数据库的安全升级。
2、3.0之前需要通过新建GreenDaoGenerator工程生成Java数据对象(实体)和DAO对象,对象多的时候操作起来非常麻烦。GreenDao 3.0之后采用注解的方式通过编译方式生成Java数据对象和DAO对象,配置上相对于2.0要简单的多。
3、查询的时候会有缓存,比如第一次和第二次,所有数据改变时需要清除缓存在查询。testBeanDao.detachAll();
数据库的查看可以推荐用facebook的调试工具Stetho,在无root的时候也能看手机里的数据库、缓存、cookie等信息,在开发调试时非常方便,到时候我在下篇文章里会写Stetho的使用教程。