GreenDao3.0 学习笔记——导入以及注解

前言：

本文是我自己的学习笔记，有很多地方还没有深入的了解，所以会有错误及描述不全的地方，这也是我的第一篇博客，希望得到指正，以下是我学习过程中找到的两个比较好的博客

Android ORM——初识greenDAO 3及使用greenDAO 3前应该掌握的一些知识点（一）

android greendao3.0 多表关联踩坑实践

文中对于ToOne以及ToMany两个注解没有说明，可以参考以上两个博客，基本讲的比较清楚

 

导入

一，在as中导入相关的包

compile'org.greenrobot:greendao:3.0.1'compile'org.greenrobot:greendao-generator:3.0.0'

二，在build.gradle中进行配置：

apply plugin: 'org.greenrobot.greendao'

buildscript {

repositories {

mavenCentral()

}

dependencies {

classpath 'org.greenrobot:greendao-gradle-plugin:3.0.0'

}

}

//设置自动生成代码的位置，说明上是可以不填，默认生成位置是build文件夹下面

//如果不加这段，就需要加上资源目录，否则编译时会找不到相关生成的class文件

greendao {

schemaVersion 1

daoPackage 'com.anye.greendao.gen'

targetGenDir 'src/main/java'

}

注解

1，@Entity

告诉代码集成器，该实体是与数据库关联的，需要生成相关代码，写完之后同步，代码自动生成

相关属性：

@nameInDb 在数据库中的名字，如不写则为实体中类名

@indexes 索引，对索引的解释自行百度

@createInDb 是否创建表，默认为true,false时不创建

@schema 指定架构，即数据库的名称，默认会生成一个数据库，如果存在多个数据库，不同数据库中的实体不能存在联系

@active //todo

注：实体必须为java，用kotlin会无法生成代码

2，@Id

标识该元素为该表的主键，可以不存在主键，主键不能重复，insert插入相同主键的实体会报错，如果不能确定，可以使用insertOrReplace方法

相关属性：

@autoincrement 设置主键自增，只有在主键是long的时候生效，设置自增会导致额外的开销，在greendao的使用方式中看不出设置自增有什么用

3，@Property

修饰该元素

相关属性：

@nameInDb 设置该元素在表中的键名，不设置时默认为元素的变量名的全大写形式（根据驼峰原则加入下划线，如：userName => USER_NAME）

4，@NotNull

该元素值不能为null，否则报错

5， @Transient

忽视该元素，即不存入数据库

6，@OrderBy

排序，该注解用于注解变量

相关属性：

@OrderBy("属性A 排序方式，属性B，属性C 排序方式") 排序方式：ASC升序 DESC降序，默认升序

7，@Keep

标注实体，标注后不会重新为该实体集成代码

8，@Unique

唯一约束，也可以在index属性了添加，不要两者同时添加，会导致性能变差

9，@Generated

标识改方法由greenDao自己生成，不是用户代码，示例代码中删除了大部分该注解下的代码

10，@Convert

如果成员变量是自定义实体，那么需要标注该属性

相关属性：

@converter

用于转换的类

@columnType,数据库中实际存储的类型

写法：

@Convert(converter =BookConverter.class,columnType = String.class)

其中BookConverter需要实现PropertyConverter<T,D>

@Entity(indexes = {@Index(value = "userName ASC",unique = true)})
public class User {
    @Id
    private String phone;
    
    @Unique
    private String id;
   
    private String userName;

    @NotNull
    private String passWord;

    private String bookId;

    @ToOne(joinProperty = "bookId" )
    private Book hisBook;
    
    @ToMany(referencedJoinProperty = "phone")
    private List<Wife> mWife;

}

@Entity
public class Book {
    @Id
    private String bookId;
    private String name;
    @Generated(hash = 105794982)
    public Book(String name, String bookId) {
        this.name = name;
        this.bookId = bookId;
    }
    @Generated(hash = 1839243756)
    public Book() {
    }

}

@Entity
public class Wife  {
    private String wifePhone;
    private String phone;
    @Id
    private String sheName;
}