Android数据存储之GreenDao 3.0 详解和常见错误解析

GreenDao 介绍：

    greenDAO是一个对象关系映射（ORM）的框架，能够提供一个接口通过操作对象的方式去操作关系型数据库，它能够让你操作数据库时更简单、更方便。如下图所示：

官网地址：http://greenrobot.org/greendao/

github：https://github.com/greenrobot/greenDAO

GreenDao 优点：

• 性能高，号称Android最快的关系型数据库

• 内存占用小

• 库文件比较小，小于100K，编译时间低，而且可以避免65K方法限制

• 支持数据库加密  greendao支持SQLCipher进行数据库加密 有关SQLCipher可以参考这篇博客Android数据存储之Sqlite采用SQLCipher数据库加密实战

• 简洁易用的API

GreenDao 3.0改动：

   使用过GreenDao的同学都知道，3.0之前需要通过新建GreenDaoGenerator工程生成Java数据对象（实体）和DAO对象，非常的繁琐而且也加大了使用成本。

GreenDao  3.0最大的变化就是采用注解的方式通过编译方式生成Java数据对象和DAO对象。

GreenDao 3.0使用方式：

 1.）在model的build.gradle添加如下配置

apply plugin: 'org.greenrobot.greendao'


dependencies {
    compile 'org.greenrobot:greendao:3.0.1'
}

 2.）在工程的build.gradle添加如下配置

buildscript {
    repositories {
        jcenter()
        mavenCentral()
    }

    dependencies {
        classpath 'com.android.tools.build:gradle:2.3.0'
        classpath 'org.greenrobot:greendao-gradle-plugin:3.2.1'
    }
}

3.）新建实体

@Entity
public class User {
    @Id
    private Long id;
    private String name;
    private int age;

   //下面省去了 setter/getter
}

此时make project会自动生成DaoMaster 、DaoSession、Dao，如图所示 默认位置：

4.）Gradle 插件配置

比如上面想指定生成DaoMaster 、DaoSession、Dao位置，可以在model的build.gradle根目录下加入以下配置

greendao {
    schemaVersion 1
    daoPackage 'soft.zut.edu.cn.mygreendaotest.entity'
    targetGenDir 'src/main/java'
}

• schemaVersion： 数据库schema版本，也可以理解为数据库版本号
• daoPackage：设置DaoMaster 、DaoSession、Dao包名
• targetGenDir：设置DaoMaster 、DaoSession、Dao目录
• targetGenDirTest：设置生成单元测试目录
• generateTests：设置自动生成单元测试用例

5.）实体@Entity注解

• schema：告知GreenDao当前实体属于哪个schema
• active：标记一个实体处于活动状态，活动实体有更新、删除和刷新方法
• nameInDb：在数据中使用的别名，默认使用的是实体的类名
• indexes：定义索引，可以跨越多个列
• createInDb：标记创建数据库表

6.）基础属性注解

• @Id :主键 Long型，可以通过@Id(autoincrement = true)设置自增长
• @Property：设置一个非默认关系映射所对应的列名，默认是的使用字段名 举例：@Property (nameInDb="name")
• @NotNul：设置数据库表当前列不能为空
• @Transient ：添加次标记之后不会生成数据库表的列

7.)索引注解

• @Index：使用@Index作为一个属性来创建一个索引，通过name设置索引别名，也可以通过unique给索引添加约束
• @Unique：向数据库列添加了一个唯一的约束

8.）关系注解

• @ToOne：定义与另一个实体（一个实体对象）的关系
• @ToMany：定义与多个实体对象的关系

GreenDao使用

 public class MyApplication extends Application {
 private DaoMaster.DevOpenHelper mHelper;
 private SQLiteDatabase db;
 private DaoMaster mDaoMaster;
 private DaoSession mDaoSession;
 public static MyApplication instances;
 @Override    public void onCreate() {
     super.onCreate();
     instances = this;
     setDatabase();
 }
 public static MyApplication getInstances(){
     return instances;
 }

/**
 * 设置greenDao
 */
private void setDatabase() {
    // 通过 DaoMaster 的内部类 DevOpenHelper，你可以得到一个便利的 SQLiteOpenHelper 对象。
    // 可能你已经注意到了，你并不需要去编写「CREATE TABLE」这样的 SQL 语句，因为 greenDAO 已经帮你做了。
    // 注意：默认的 DaoMaster.DevOpenHelper 会在数据库升级时，删除所有的表，意味着这将导致数据的丢失。
    // 所以，在正式的项目中，你还应该做一层封装，来实现数据库的安全升级。
    mHelper = new DaoMaster.DevOpenHelper(this, "notes-db", null);
    db = mHelper.getWritableDatabase();
    // 注意：该数据库连接属于 DaoMaster，所以多个 Session 指的是相同的数据库连接。 
    mDaoMaster = new DaoMaster(db); 
    mDaoSession = mDaoMaster.newSession();
}
public DaoSession getDaoSession() {
      return mDaoSession;
}
public SQLiteDatabase getDb() {
      return db;
  }
}

获取UserDao对象：

mUserDao = MyApplication.getInstances().getDaoSession().getUserDao();

简单的增删改查实现：

1. 增

mUser = new User((long)2,"anye3");
mUserDao.insert(mUser);//添加一个

2. 删

mUserDao.deleteByKey(id);

3. 改

mUser = new User((long)2,"anye0803");
mUserDao.update(mUser);

4. 查

List<User> users = mUserDao.loadAll();
String userName = "";
for (int i = 0; i < users.size(); i++) {
    userName += users.get(i).getName()+",";
}
mContext.setText("查询全部数据==>"+userName);

greendao中的注解

(一) @Entity 定义实体
@nameInDb 在数据库中的名字，如不写则为实体中类名
@indexes 索引
@createInDb 是否创建表，默认为true,false时不创建
@schema 指定架构名称为实体
@active 无论是更新生成都刷新
(二) @Id
(三) @NotNull 不为null
(四) @Unique 唯一约束
(五) @ToMany 一对多
(六) @OrderBy 排序
(七) @ToOne 一对一
(八) @Transient 不存储在数据库中
(九) @generated 由greendao产生的构造函数或方法

结束语

总体来说,GreenDao3.0在配置上相对于2.0要简单的多。

但有一下几个问题必须注意：

在网上大部分人没有区分model的buildle.gradle和工程的buildle.gradle，将所有greendao的配置信息添加到model的buildle.gradle里面，这样会造成一个问题，在make project会报错

Error:Execution failed for task ':greendaotest:greendao'.
> org.eclipse.jdt.internal.compiler.impl.CompilerOptions.versionToJdkLevel(Ljava/lang/Object;)J

开始我还以为是jdk原因，上网查，也没查出个所以然，后来参考了github上面的讨论链接，才发现，是我把下面代码集成搞混了，

 

 

buildscript {
    repositories {
        jcenter()
        mavenCentral()
    }

    dependencies {
        classpath 'com.android.tools.build:gradle:2.3.0'
classpath 'org.greenrobot:greendao-gradle-plugin:3.2.1'
}
}

开始我添加在了module的buildle.gradle里面，后来我直接移动到工程的buildle.gradle里面再，再在Build里面选中make project成功通过。