序言

(写分享前的序言)
大家好.很高兴能为大家分享Android之GreenDao笔记,也希望能和大家一起学习进步.
        之前用过ormlite android,现在觉得GreenDAO 3.x特别好用,在网上搜索有关GreenDAO的文章都很不错,在大量浏览优秀文章后加上自己使用的总结,写下一份比较详细的GreenDAO的笔记和大家分享一下

(写分享中的序言)
写到一半的时候觉得有点写不下去了,几度写写停停,心里动摇不坚定.有时候就会觉得那些写原创技术博客的大牛好厉害,有很强的毅力,有时候觉得我是不是不适合写博客.总之还是非常感谢那些无私奉献技术的大牛们

---

简介

现在GreenDao已经成为Android数据库高活跃的最佳选择.最近写在一个项目,做的本地缓存比较多,使用了GreenDao.

GreenDao3.X是采用注解的方式来定义实体类,通过gradle插件编译方式生成Java数据对象和DAO对象。

GreenDAO是一个轻量级且快速的ORM框架(ORM>>>对象关系映射 英语：ObjectRelationMapping，简称ORM，或O/RM，或O/Rmapping，是一种程序技术，用于实现面向对象编程语言里不同类型系统的数据之间的转换),专门为Android高度优化和定制,它能够支持每秒数千条记录的CRUD操作,

GreenDAO优势:
    号称是Android 最快的关系型数据库.
    1.一个精简的库
    2.性能最大化
    3.内存开销最小化
    4.编译时间段，也就是运行操作时间短。
    5.方便简单的操作方式。（API）
    6.还可以支持加密操作。
    7.能够让代码更加简洁。
    8.效率很高，插入和更新的速度是sqlite的2倍，加载实体的速度是ormlite的4.5倍。
    9.文件较小，占用更少的内存，但是需要create Dao，
    10.操作实体灵活：支持get，update，delete等操作
    11.对Android进行高度优化
    12.现GreenDao 3.X已集成RxJava(其最大的特点就是在增删改查等基本操作时返回Observable,用于RxJava的流式逻辑写法，其最大的优点便于流式开发，提高代码的可读性)

总之两个字 好用

---

目录

Android studio配置使用方法
创建实体(创建表)
封装DatabaseManage
封装调用入口(使用方便)
关系的映射
实体自带的操作(方法)
普通的增删改查
异步增删改查
合并事务
数据库升级,迁移
RxJava
数据加密

---

Android studio配置使用方法

1.工作空间的gradle文件配置(必填1/2)

//GreenDAO插件到构建文件中将会自动创建一系列构建任务(必填)
classpath 'org.greenrobot:greendao-gradle-plugin:3.2.1'

2.App的gradle文件配置(必填2/2)

//在dependencies节点下加入(必填1/2)
compile 'org.greenrobot:greendao:3.2.0'
//在gradle文件中加入：(必填2/2)
apply plugin: 'org.greenrobot.greendao'

//数据库加密时添加配置(非必填)①
(compile 'net.zetetic:android-database-sqlcipher:3.5.1')
//使用数据库升级辅助GreenDaoUpgradeHelper时添加配置(非必填)①
(compile 'com.github.yuweiguocn:GreenDaoUpgradeHelper:v1.2.0')

3.自定义路径以及 相关配置(无需求,建议不添加)①

//在App的gradle文件可以选择添加(无需求建议不添加)①
greendao{
//数据库schema版本，也可以理解为数据库版本号
schemaVersion 1

//设置DaoMaster、DaoSession、Dao包名
daoPackage'***.***.***'

//设置DaoMaster、DaoSession、Dao目录
targetGenDir 'src/main/java'

//设置生成单元测试目录
targetGenDirTest

//设置自动生成单元测试用例
generateTests
}

在gradle的根模块中加入上述(必填)代码，就完成了我们的基本配置了。

如果 需要数据库版本升级  将schemaVersion 1 改成  2 就会触发onUpgrade(SQLiteDatabase  sqLiteDatabase,int  oldVersion,int  newVersion)方法;

---

创建一个学生实体类(学生表)-----------(注意细节和详细参考)

//实体属性的注释有很多种, 详细参考 ㊟
@Entity(active=true,nameInDb="StudentEntity")
public class StudentEntity {

//传入 null  id会默认自增 (注意需要自增的话 id 的类型 一定要是大写Long 类型),参考属性字段注解
@Id(autoincrement =true)//默认就是true ,false代表不自增
Long id;

@Property( nameInDb ="name")
String name;

@Property( nameInDb ="age")
int age;

@Property ( nameInDb ="sex")
String sex;
}

㊕细节:
       首先创建一个实体类,加上 @Entity  代表创建一张表,类的属性就是表的字段;
(创建实体类后需要 点击Build->Make project (Ctrl+F9),就会生成 DaoMaster㊟,DaoSession㊟和实体类的数据访问对象Dao㊟)

㊟实体类和属性的注释:
    -->@Entity实体类的注解参数
  schema ="myschema",     //如果该实体属于多个表单，可以使用该参数;
  active =true,     // 该实体属于激活状态，激活状态的实体有更新，删除，刷新方法;
  nameInDb ="name",    // 给这个表指定一个名字，默认情况下是名字是类名
  indexes = {@Index(value ="name DESC", unique =true) },    // 可以给多个属性定义索引和其他属性.
  createInDb =false,    //是否使用GreenDao创建该表.
  generateConstructors =true,    // 是否所有的属性构造器都应该被生成，无参构造器总是被要求
  generateGettersSetters =true,    // 如果该类中没有set get方法是否自动生成

-->实体属性的注解及参数
@Id    //一般会选择long/Long属性作为Entity ID（即数据库中的主键）autoincrement=true表示主键会自增如果false就会使用旧值
@Property    //可以自定义一个该属性在数据库中的名称，默认情况下数据库中该属性名称是Bean对象中的 属性名但是不是以驼峰式而是以大写与下划线组合形式来命名的比如：customName将命名为 CUSTOM_NAME;注意：外键不能使用该属性；
@NotNull    //确保属性值不会为null值;
@Transient    //使用该注释的属性不会被存入数据库中;
@Unique     //唯一约束
@ToMany     //一对多
@OrderBy     //排序
@ToOne      //一对一
@generated  //由greendao产生的构造函数或方法

---

封装DatabaseManage

1.创建MyDatabaseOpenHelp类继承 DaoMaster.OpenHelper (创建实体类后需要 点击Build->Make project (Ctrl+F9),就会生成 DaoMaster)(创建数据库和更新数据库的类)

public  class  MyDatabaseOpenHelper  extends  DaoMaster.OpenHelper{

private  static  final  StringDB_NAME = "MainApp.db" ;
   public  MyDatabaseOpenHelper (Context  context,SQLiteDatabase.CursorFactory  factory){
   super(context,DB_NAME,factory);
}

@Override
public  void  onUpgrade(SQLiteDatabase  sqLiteDatabase,int  oldVersion,int  newVersion){
//数据库升级使用,需要在gradle配置compile 'com.github.yuweiguocn:GreenDaoUpgradeHelper:v1.2.0'
  //  MigrationHelper.getInstance().migrate(db,TestDataDao.class,TestData2Dao.class，TestData3Dao.class);
}
}

---

一个数据库对应一个OpenHelp类.

2.创建DBManager (单利模式,创建helper 需要上下文,本章采取是写一个静态的Application实例)

public class DBManager {

//单例模式
private static DBManager dbManager;

/**
*创建MyDatabaseOpenHelper
*使用的上下文,
*可以 静态一个Application实例(比较灵活) (采取的方案)
*也可以 写一个初始方法 在Application中调用()
*也可以 在调用的时候传入 上下文
*/

private MyDatabaseOpenHelper myDatabaseOpenHelper;
//会话
private DaoSession daoSession;

//私有构造器
private DBManager() {}

/**
*获取DB管理单一实例
*@return  DB管理单一实例
*/
public static DBManager getInstance() {
     if (null == dbManager) {
              synchronized (DBManager.class) {
                    if (null == dbManager) {
                          dbManager = new DBManager();
                                }
                   }
      }
      return dbManager;
}

/**
*获取会话
*@return   DaoSession
*/
public  DaoSession   getDaoSession() {
  if(null==daoSession) {
       synchronized(DBManager.class) {
          if(null==daoSession) {
               myDatabaseOpenHelper=newMyDatabaseOpenHelper(BaseApplication.getInstance());
              DaoMasterdaoMaster=newDaoMaster(myDatabaseOpenHelper.getWritableDatabase());
                //传入IdentityScopeType.None代表 不使用缓存.
                daoSession= daoMaster.newSession(IdentityScopeType.None);
               }
        }
        }
     returndaoSession;
    }
}

//daoMaster.newSession(IdentityScopeType.None);//传入IdentityScopeType.None代表 不使用缓存 ,不传参数默认缓存.

//自定义Application创建Application静态实例  (切记要在AndroidManifest修改application的name)
public class  BaseApplication   extends   Application {

    private static  BaseApplication  baseApplication;

@Override
public void  onCreate() {
     super.onCreate();
     baseApplication=this;
}
/**

*获取Application实例
*@return
*/
public static  BaseApplication  getInstance(){
      if(  null==  baseApplication){
             baseApplication=new  BaseApplication();
     }
      return  baseApplication;
     }
}

greenDao核心类构成

DaoMaster:

是GreenDao的入口也是greenDao顶级对象,对于一个指定的表单持有数据库对象（SQLite数据库）并且能够管理DAO类- 能够创建表和删除表

其内部类OpenHelper 与DevOpenHelper是创建SQlite数据库的SQLiteOpenHelper的具体实现

DaoSession:

对于一个指定的表单可以管理所有的Dao 对象。

也能够对实体类执行 insert ,load，update,refresh.delete操作。

DaoSession也能跟踪 identity scope：即session查询后的实体会存在缓存中，并给该实体生成一个flag来追踪该实体，下次再次查询时会直接从缓存中取出来而不是从数据库中取出来

DAOS

能够持久访问和查询实体类

比起DaoSession有更多的持久化方法 count, loadAll,insertInt等等；

Entities- 自动生成的代码，一般情况下与javaBean对象的属性一一对应。

3.创建StudentCRUD(增删改查)(这个是自己又封装了一层,数据业务对接层)

public class Student_CRUD {
private StudentEntityDao  studentEntityDao;
public DaoSession daoSession;
//构造方法
public Student_CRUD (DaoSession daoSession) {
  this.daoSession= daoSession;
  studentEntityDao= daoSession.getStudentEntityDao();
}
//=========以下 是对 学生表的增删改查=========
//====增增增增增增增===的方法
    //插入或更新一个学生实体
    public void addStudent(StudentEntity studentEntity) {
        if(null!= studentEntity) {
            studentEntityDao.insertOrReplace(studentEntity);
        }
    }
    //插入或更新一个学生实体集合
    public void  addStudentList(List<StudentEntity> studentEntityList) {
        if(null!= studentEntityList && studentEntityList.size() >0) {
            studentEntityDao.insertOrReplaceInTx(studentEntityList);
        }
    }
//=====删删删删删删删删===的方法
    //删除 一条学生数据根据ID
    public void delStudent(long id) {
        studentEntityDao.deleteByKey(id);
    }
//====改改改改改改改改===的方法
    //修改一条数据
    public void updateStudent(StudentEntity studentEntity) {
        if(null!= studentEntity) {
            studentEntityDao.update(studentEntity);
           }
    }
//====查查查查查查查查======的方法
    //查询 学生对象根据ID
    public StudentEntity getStudent(long id){
            return studentEntityDao.load(id);
     }

    //获取所有 学生数据
    public List<StudentEntity> getAll(){
        return studentEntityDao.loadAll();
     }
}

未完待续目录剩下的部分,望大家多多指点,共同进步,

eq()：==

noteq()：!=

gt()： >

lt()：<

ge：>=

le:<=

like()：包含

between：俩者之间

in：在某个值内

notIn：不在某个值内

---