一. 简介

GreenDAO是一款开源且面向Android的轻便、快捷的ORM框架,可以将对象映射到SQLite数据库中.它针对Android进行了高度优化,性能最大化且内存消耗极少同时还支持数据库加密.

二. 特点

• 高质保障：greendao大约从2011年开始被无数著名的应用程序使用验证
• 简单：简洁明了的API，在V3带有注释
• 体积小：总体积小于150K和普通的java jar相当（不含CPU相关的native部分）
• 快速：可能是Android最快的ORM，智能生成代码
• 安全多样：QueryBuilder使用特性常数避免错别字
• 强大连接：跨实体查询，甚至是复杂关系的链连接
• 类型灵活：可以使用自定义的类或枚举来表示你的实体数据
• 支持加密：支持SQLCipher加密数据库

三. 环境配置

在本地app项目的build.gradle内添加以下代码(repository/plugin/library)

// In your root build.gradle file:
buildscript {
    repositories {
        jcenter()
        mavenCentral() // add repository
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.3.3'
        classpath 'org.greenrobot:greendao-gradle-plugin:3.2.2' // add plugin
    }
}
 
// In your app projects build.gradle file:
apply plugin: 'com.android.application'
apply plugin: 'org.greenrobot.greendao' // apply plugin
 
dependencies {
    compile 'org.greenrobot:greendao:3.2.2' // add library
}

还可以配置greendao的生成文件,写不写都行

greendao {  
    schemaVersion 1  // 版本  
    daoPackage '生成文件包名' // 一般为app包名+生成文件的文件夹名  
    targetGenDir 'src/main/java' //生成文件路径  
} 

四. 使用方法

首先我们在自己的项目里创建一个数据实体类,记得带上@Entity.只需要写好类的属性,GreeDao会自动帮我们创建构造器,get/set方法,以及数据库工具类.

1. 创建数据实体类

@Entity
public class DownloadInfo {
    @Id
    private long id;
    private String url;
    ...
}

2. Greendao注解含义

Greendao有些注解,我们可以直接点进去查看源码里注解的介绍:

greedDao的注解

• @Entity实体注解

@nameInDb 在数据库中的名字，如不写则为实体中类名
@indexes 索引
@createInDb 是否创建表,默认为true,false时不创建
@schema 指定架构名称为实体
@active 无论是否更新都刷新,默认false

• 其他注解

@Id 每条数据对应的位置，必写项
@Property(nameInDb = "") 表示该属性将作为表的一个字段,其中nameInDb属性值是在数据库中对应的字段名称,可以自定义字段名,例如可以定一个跟实体对象字段不一样的字段名
@NotNull 不为null
@Transient 不保存于数据库,添加此标记后不会生成数据库表的列
@Index 作为一个属性来创建一个索引，通过name设置索引别名，也可以通过unique给索引添加约束
@Unique 唯一约束,该属性值必须在数据库中是唯一值
@ToOne 一对一 关系表
@ToMany 一对多
@OrderBy 排序
@Generated 由greendao产生的构造函数或方法,此注释标记的所有代码元素都可以在生成的下一次运行中更改/删除

当我们编写好实体类并添加自己需要的注解之后，点击build --> Make Project，就会自动生成相应的 setter 和 getter 方法，至于那些 hash 值是自动赋值上去的。并且在项目的build目录下(或者自己设定的目录:src/main/java)下看到生成的三个类文件：

greedDao自动生成的工具类

3. 创建工具类支持增删改查

greenDAO帮我们省去了建表/增/删/改/查逻辑的SQL语句部分,直接封装为各个接口供我们调用.
下面贴上我封装好的整个工具类代码:

public class DBUtil {

    private static DBUtil sDB;
    private final static String DB_NAME = "xxx_xxx_db";
    private DaoMaster.DevOpenHelper mOpenHelper;
    private DownloadInfoDao mWritableInfo;
    private DownloadInfoDao mReadableInfo;

    public DBUtil() {
        // 通过 DaoMaster 的内部类 DevOpenHelper,得到一个便利的SQLiteOpenHelper对象.
        // 这里并不需要去编写「CREATE TABLE」这样的 SQL 语句，因为 greenDAO 已经帮你做了。
        mOpenHelper = new DaoMaster.DevOpenHelper(
                xxx.getContext(), DB_NAME, null);
    }

   // 单例模式获取实例
    public static DBUtil getInstance() {
        if (sDB == null) {
            synchronized (DBUtil.class) {
                if (sDB == null) {
                    sDB = new DBUtil();
                }
            }
        }
        return sDB;
    }

  // 写入数据
    private DownloadInfoDao getWritableInfo() {
        if (mWritableInfo == null) {
            SQLiteDatabase db = mOpenHelper.getWritableDatabase();
            DaoMaster daoMaster = new DaoMaster(db);
            DaoSession daoSession = daoMaster.newSession();
            mWritableInfo = daoSession.getDownloadInfoDao();
        }
        return mWritableInfo;
    }

  // 读数据
    private DownloadInfoDao getReadableInfo() {
        if (mReadableInfo == null) {
            SQLiteDatabase db = mOpenHelper.getReadableDatabase();
            DaoMaster daoMaster = new DaoMaster(db);
            DaoSession daoSession = daoMaster.newSession();
            mReadableInfo = daoSession.getDownloadInfoDao();
        }
        return mReadableInfo;
    }

   // 增
    protected void save(DownloadInfo info) {
        if (queryById(info.getId()) == null) {
            getWritableInfo().insert(info);
        } else {
            getWritableInfo().update(info);
        }
    }

   // 删
    protected void delete(DownloadInfo info) {
        getWritableInfo().delete(info);
    }

   // 改
    protected void update(DownloadInfo info) {
        getWritableInfo().update(info);
    }

   // 查
    public DownloadInfo queryById(long Id) {
        List<DownloadInfo> list = getReadableInfo().queryBuilder()
                .where(DownloadInfoDao.Properties.Id.eq(Id))
                .build()
                .list();
        return list.isEmpty() ? null : list.get(0);
    }
}

使用的时候直接new 一个info对象,就可以用该工具类进行操作了:

DownloadInfo info = new DownloadInfo(url);
DBUtil.getInstance().save(info);

五. 参考资料

Greendao官网
Greendao的github源码

好了,GreeDao就简单介绍到这里,探索更多内容还待大家多多实践.