编写GreenDao所需要的实体类
实体类编写
GreenDAO 3使用注释来定义架构和实体。
1)创建实体类,使用@Entity对类进行注解
2)定义类中的字段,并且对字段进行不同方式的注解
例如创建一个Student实体类,采用如下方式进行如下定义:
@Entity(nameInDb = "student_tb",createInDb = true)
public class Student {
@Id
private Long id;
@Property(nameInDb = "NAME")
private String name;
@Transient
private int temp;
}
实体注解
- @Entity
@Entity表示这个实体类在数据库中生成对应的表,告诉GreenDao该对象为实体只有被@Entity的实体类才能被dao类操作,这还将指示GreenDAO生成必要的代码(例如DAO)。 - 实体注解的属性
@Entity(
// 如果有一个以上的模式，可以告诉greendao实体属于哪个模式（选择任何字符串作为名称）。
//3.2版本采用注解生成Java数据对象和DAO对象,都是默认schema="default",改成其他会报错
schema = "default",
// 标志允许实体类可有更新，删除，刷新方法
active = true,
//指定数据库中表的名称,默认情况下，该表的名称是实体类名。
nameInDb = "teacher_tb",
//定义索引,在这里定义多个列的索引,可以跨越多个列
indexes = {
@Index(value = "name DESC", unique = true)
},
// true表示greenDAO创建数据库表(默认为true)，如果不用greenDAO创建表，将此设置为false。
createInDb = true,
// 是否应该生成所有的属性构造函数。无参构造函数总是要生成的
generateConstructors = true,
// 是否生成属性的getter和setter
generateGettersSetters = true
)
基础属性注解:
示例代码:
@Entity
public class User {
@Id(autoincrement = true)
private Long id;
@Property(nameInDb = "USERNAME")
private String name;
@NotNull
private int repos;
@Transient
private int tempUsageCount;
...
}
- @Id
表示该字段是id,注意该字段的数据类型为Long或long,(autoincrement = true)表示主键会自增
当前，实体必须具有作为其主键的long或Long属性。
这是Android和SQLite的推荐做法。 - @Property
则表示该属性将作为表的一个字段,其中nameInDb属性值是在数据库中对应的字段名称,可以自定义字段名,例如可以定一个跟实体对象字段不一样的字段名 - @Transient
汉语意思:短暂的,临时的!该注解表示这个属性将不会作为数据表中的一个字段,也就是意味着不存储在数据库中 - @NotNull
表示该字段不可以为空
索引注解:
- @Index
使用@Index作为属性的注解,表示为相应的数据库列创建数据库索引。- name: 如果您不喜欢GreenDAO为索引生成的默认名称，可以在这里指定您的名称。
- unique: 向索引添加唯一约束，强制所有值都是唯一的,即该列的每一行都不会用重复的数据内容
@Entity
public class User {
@Id private Long id;
@Index(unique = true)
private String name;
}
- @Unique
单列唯一约束
汉语意思:唯一的,独一无二的.使用该注解表示该字段唯一!
在一列上添加唯一约束，主要是让该列在表中只能有唯一的一行，例如注册邮箱时的邮箱名、手机号等信息，相关操作如下：
@Entity
public class User {
@Id private Long id;
@Unique private String phone;//该列在表中只能有唯一的一行
}
其他注解:
- @Generated
由greendao产生的构造函数或方法,构造函数、方法等不能被修改 - @Keep
注解的代码段在GreenDao下次运行时保持不变
注解实体类：默认禁止修改此类
注解其他代码段，默认禁止修改注解的代码段
关系注解:
编译项目工程!
编辑操作Build-->MakeProject-->进行编译重新构建工程
或者使用as快捷键Ctrl+F9-->进行编译重新构建工程
重新编译构建之后:
- 1)实体类生成方法
Student实体类会自动生成get,set方法以及无参数构造方法和有参数的构造方法. - 2)生成类
在工程目录\app\build\generated\source\greendao\com\think\greendao
生成三个类StudentDao,DaoMaster,DaoSession
参考文献
Modelling entities
http://greenrobot.org/greendao/documentation/modelling-entities/
