greenDao基础使用

time：2020.08.12

一、简介

1.greenDAO 是一个将对象映射到 SQLite 数据库中的轻量且快速的 ORM 解决方案，GreenDao特点：
性能最大化，可能是Android平台上最快的ORM框架

• 易于使用的API
• 最小的内存开销
• 依赖体积小
• 支持数据库加密
• 强大的社区支持

2.Github地址

https://github.com/greenrobot/greenDAO

二、环境搭建
1.在根目录的 build.gradle 添加

buildscript {
    repositories {
        jcenter()
        mavenCentral() // add repository
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:3.5.3'
        classpath 'org.greenrobot:greendao-gradle-plugin:3.3.0' // add plugin
    }
}

2.在app的 build.gradle 添加

apply plugin: 'com.android.application'
apply plugin: 'org.greenrobot.greendao' // apply plugin
 
dependencies {
    implementation 'org.greenrobot:greendao:3.3.0' // add library
}

3.greenDao 3 采用注解的方式来定义实体类，可按如下设置生成文件的目录，在app的 build.gradle 添加

greendao {
    // 指定数据库schema版本号，迁移等操作会用到
    schemaVersion 1
    // 设置生成数据库文件的目录，默认是在build中，可以将生成的文件放到我们的java目录中
    targetGenDir 'src/main/java'
    // 设置生成的数据库相关文件的包名，默认为entity所在的包名
    daoPackage 'com.shufeng.greendao.gen'
}

好得，配置信息就是这么简单 我们可以Sync Now即可 也可以Rebuild

配置搞好了，我们怎么来使用呢，现在我们在使用之前 我们来了解下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)来表示数据库的对象。目前不支持Kotlin

注解含义：

• @Entity：将我们的java普通类变为一个能够被greenDAO识别的数据库类型的实体类;
• @nameInDb：在数据库中的名字，如不写则为实体中类名；
• @Id：选择一个long / Long属性作为实体ID。 在数据库方面，它是主键。 参数autoincrement是设置ID值自增；
• @Property 用于设置属性在数据库中的列名（默认不写就是保持一致）
• @NotNull：使该属性在数据库端成为“NOT NULL”列。 通常使用@NotNull标记原始类型（long，int，short，byte）是有意义的；
• @Transient：表明这个字段不会被写入数据库，只是作为一个普通的java类字段，用来临时存储数据的，不会被持久化。

@Entity(nameInDb = "CHILD")
public class DBChild implements Serializable {

    private static final long serialVersionUID = 4885291165634480161L;
    /**
     * 下面字段 切记 【不可以改变顺序,修改表列名等任何修改】 。切记！！！
     * 有新增字段往后追加
     */
    @Id
    @Property(nameInDb = "ID")
    protected Long id;
    @Property(nameInDb = "USER_ID")
    protected Long userId;//用户ID
    @Property(nameInDb = "HEAD_URL")
    protected String headUrl;//头像地址
    @Property(nameInDb = "NICK_NAME")
    protected String nickName;//昵称
    @Property(nameInDb = "NAME")
    protected String name;//姓名
    @Property(nameInDb = "GENDER")
    protected int gender;//性别 0-女  1-男
    @Property(nameInDb = "BIRTHDAY")
    protected String birthday;//生日
    @Property(nameInDb = "CODE_TYPE")
    protected int codeType;//扫码类型 1儿童编码 2接种证条码 3手机号码
      }
    ```
    
```java
public class DBFactory {

    private static DaoMaster.DevOpenHelper devOpenHelper;
    private static DaoSession sharedSession;

    public static DaoSession sharedSessions() {
        if (devOpenHelper == null) {
            devOpenHelper = new YMDevOpenHelper(YeemiaoApp.getApp(), "my-db", null);
        }
        if (sharedSession == null) {
            DaoMaster daoMaster = new DaoMaster(devOpenHelper.getWritableDb());
            sharedSession = daoMaster.newSession();
        }
        return sharedSession;
    }

    /**
     * **** 切记 数据升级 【字段的位置】必须与对象的【字段位置】一致 *****
     * **** 切记 数据升级 【字段的位置】必须与对象的【字段位置】一致 *****
     * **** 切记 数据升级 【字段的位置】必须与对象的【字段位置】一致 *****
     * **** 切记 数据升级 【字段的位置】必须与对象的【字段位置】一致 *****
     */
    public static class YMDevOpenHelper extends DaoMaster.DevOpenHelper {

        public final int DB_VERSION_1_4_4 = 1000;
        
        public YMDevOpenHelper(Context context, String name, SQLiteDatabase.CursorFactory factory) {
            super(context, name, factory);
        }

        @Override
        public void onUpgrade(Database db, int oldVersion, int newVersion) {
            Log.i("greenDAO", "Upgrading schema from version " + oldVersion + " to " + newVersion + " by dropping all tables");
           ......
              }
           }
           }

删除所有儿童

 try {
            DBFactory.sharedSessions().getDBChildDao().deleteAll();
        } catch (Exception e) {
            e.printStackTrace();
        }

增加或替换更新儿童数据

 try {
            DBFactory.sharedSessions().getDBChildDao().insertOrReplace(this);
        } catch (Exception e) {
            e.printStackTrace();
        }

查询

        DBChildDao dao = null;
        try {
            dao = DBFactory.sharedSessions().getDBChildDao();
         Child child = dao.queryBuilder().where(DBChildDao.Properties.Id.eq(child.getId()));
        
        } catch (Exception e) {
            e.printStackTrace();
        }

 public DBTicket queryByAppointmentCode(String code) {
        List<DBTicket> ticketList = DBFactory.sharedSessions().getDBTicketDao()
                .queryBuilder()
                .where(DBTicketDao.Properties.AppointmentCode.eq(code))
                .list();
        if (ticketList != null && ticketList.size() > 0) {
            return ticketList.get(0);
        }
        return null;
    }