Android数据库GreenDao
项目配置
1、项目目录下.gradle
文件配置:
buildscript {
repositories {
google()
jcenter()
// GreenDao仓库
mavenCentral()
}
dependencies {
// ....
// GreenDao插件
classpath 'org.greenrobot:greendao-gradle-plugin:3.3.0'
}
}
2、app目录下.gradle
配置
apply plugin: 'com.android.application'
//GreenDao插件
apply plugin: 'org.greenrobot.greendao'
dependencies {
implementation 'org.greenrobot:greendao:3.3.0' //GreenDao依赖添加
}
greendao {
// 数据库版本号,注意更新
schemaVersion 1
// 生成数据库文件的目录
// targetGenDir 'src/main/java'
// 生成的数据库相关文件的包名
// daoPackage 'com.nianlun.greendao.gen'
}
使用说明
1、首先新建用户实体类,如下:
@Entity
public class User {
@Id(autoincrement = true)//设置自增长
private Long id;
@Index(unique = true)//设置唯一性
private String perNo;
private String name;
private String sex;
}
实体类中详细注解说明:
-
@Entity:表明这个实体类会在数据库中生成一个与之相对应的表,其中可配置项:
nameInDb:可以自定义表名,表明该实体对应数据库中的那张表,默认为实体类名;
indexes:定义索引,这里可跨越多个列;
createInDb:如果是有多个实体都关联这个表,可以把多余的实体里面设置为false避免重复创建(默认是true);
schema:一个项目中有多个schema时,表明要让这个dao属于哪个schema;
active:是否应该生成更新/删除/刷新方法。如果Entity定义了 @ToOne 或 @ToMany关系,那么独立于该值是有效的。意为是否支持实体类之间update,refresh,delete等操作。
-
@Id:对应数据表中的主键,是一条数据的唯一标识。如果实体没有声明主键,默认创建Long类型主键"_id"自增。使用Long类型主键时可以通过@Id(autoincrement = true)设置为自增。
-
@Property(nameInDb = “USER_NAME” ):可以自定义字段名,注意外键不能使用该属性。表明这个属性对应数据表中的 USER_NAME 字段。
-
@NotNull:该属性值不能为空。
-
@Transient:该属性不会被存入数据库中。
-
@Unique:表明该属性在数据库中只能有唯一值。
-
@Index:创建一个索引。通过name设置索引别名,也可以通过unique给索引添加约束。
-
@Convert:指定一个PropertyConverter用于支持自定义类型(没用过)。
-
@ToOne:定义自己与一个实体对象的关系。
-
@ToMany:定义自己与多个实体对象的关系(可不与@ToOne联合使用)。@ToMany的属性referencedJoinProperty,类似于外键约束。
-
@JoinProperty:对于更复杂的关系,可以使用这个注解标明目标属性的源属性,起关联作用。
-
@JoinEntity:如果你在做多对多的关系,有其他的表或实体参与,可以给目标属性添加这个额外的注解。
-
@OrderBy:指定{@ToMany}关系的相关集合的排序,(propertyA, propertyB)默认为按主键ASC排序。
-
@Generated:这个是build后greendao自动生成的,这个注解理解为防止重复,每一块代码生成后会加个hash作为标记。
2、实体类建完毕后,点击Android Studio中的Make Project
GreenDao
会自己为User实体类生成了对应的Getter
、Setter
方法以及两个构造函数,同时在我们配置的com.example.greendaodemo.bean
包下生成了三个对应类文件DaoMaster
、DaoSession
和UserDao
,之后所有相关的数据库操作都依靠这三个文件了:
- DaoMaster:使用greenDAO的切入点。DaoMaster保存数据库对象(SQLiteDatabase)并管理特定模式的DAO类(而不是对象)。 它具有静态方法来创建表或将它们删除。 其内部类OpenHelper和DevOpenHelper是在SQLite数据库中创建模式的SQLiteOpenHelper实现。一个DaoMaster就代表着一个数据库的连接;
- DaoSession:管理特定模式的所有可用DAO对象,您可以使用其中一个getter方法获取。 DaoSession还为实体提供了一些通用的持久性方法,如插入,加载,更新,刷新和删除。 DaoSession可以让我们使用一些Entity的基本操作和获取Dao操作类,DaoSession可以创建多个,每一个都是属于同一个数据库连接的;
- XxDAO:数据访问对象(DAO)持续存在并查询实体。 对于每个实体,GreenDAO生成一个DAO。 它比DaoSession有更多的持久化方法,例如:count,loadAll和insertInTx等。
3、数据库操作
(1)编写DaoManager
,用于创建数据库、创建数据库表、包含增删改查的操作。
(2)编写CommonDaoUtils
,用于完成对数据表的操作。
(3)编写DaoUtilsStore
,用于存放及提取DaoUtils
。
(4)调用DaoUtilsStore
,进行数据操作及查看。