GreenDao的使用

工具使用

GreenDao

前言

GreenDao，目前性能最好，速度最快的ORM框架。想要学习这个框架有一些时间了。一直忙于项目，所以之前选择学习成本相对较低的Sugar、xUtils、LitePal框架。
今天正式开始学习这个框架，由此记下学习的内容。

八种基本类型：

byte，boolean，char，short，int，float，long，double

1. GreenDao配置

在项目build.gradle中

dependencies {
        classpath 'com.android.tools.build:gradle:3.0.1'
        classpath 'org.greenrobot:greendao-gradle-plugin:3.2.0'
        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }

App的build.gradle中

apply plugin: 'org.greenrobot.greendao'
greendao {
    //数据库的版本号
    schemaVersion 1
    /*
        生成DaoMaster、DaoSession、以及ModelDao的地址，建议设置
        com.martin.studygreendao:包名
        greendao：包下地址
     */
    daoPackage 'com.martin.studygreendao.greendao'
    //进入数据库的Model类所在的地址（父类地址）
    targetGenDir 'src/main/java'
}
//并且在dependencies中引入 
    compile 'org.greenrobot:greendao:3.2.0'
//    compile 'org.greenrobot:greendao-generator:3.2.0'

如此配置完成之后，创建一个包entity，存放需要做数据库存储的Model类:UserModel.class

public class UserModel {
     @Id
    private Long id;//这里设置id，必须使用Long型
    private String userName;
    private String gender;
    private String age;
}

这些准备工作都完成之后，运行一下项目，就会在greendao包下生成配置文件

到这里，关于GreenDao的基础配置就完成了。

数据库使用

GreenDao官方推荐将GreenDao的初始化放在Application里面全局使用，避免重复创建，即我们在Application文件中，实现：

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;
    }
}

关于数据库的操作无非是：增、删、改、查

private int userId = 0;
private UserModelDao dao = MyApplication.getInstances().getDaoSession().getUserModelDao();

增

UserModel model = new UserModel();
model.setId(userId);
userId += 1;
model.setUserName("王小双" + userId);
dao.insert(model);

删

// 删除第一条数据
List<UserModel> loadAll = dao.loadAll();
if (loadAll.size() > 0) {
    // 根据Id删除数据
    dao.deleteByKey(loadAll.get(0).getId());
    //根据Model对象删除
    //dao.delete(loadAll.get(0));
}

改

//更新第一条数据的名字
List<UserModel> loadAll = dao.loadAll();
if (loadAll.size() > 0) {
    long id = loadAll.get(0).getId();
    UserModel userModel = new UserModel();
    userModel.setId(id);
    userModel.setUserName("改名叫 王双双");
    dao.update(userModel);
}

查

//查询出所有数据
 List<UserModel> list = daoSession.getUserModelDao().loadAll();
StringBuilder buffer = new StringBuilder();
buffer.append("开始查询数据\n");
for (int i = 0; i < list.size(); i++) {
    UserModel model = list.get(i);
    buffer.append("id = ")
            .append(model.getId())
            .append(" name = ")
            .append(model.getUserName())
            .append("\n");
}
//UI的TextView控件，用于数据显示
tvContent.setText(buffer.toString());

除了上面查询出所有数据的方法外，GreenDao还提供了一个强大的查询类QueryBuilder：

// 查询出 id = 19 的数据，这里返回内容是个数据封装
 Query<UserModel> build = dao.queryBuilder()
                        .where(UserModelDao.Properties.Id.eq("19"))
                        .build();

数据库升级

数据库的基本功能实现后，就要面临一个不可避免的问题，数据库升级。但是GreenDao在数据库升级时，会删除掉修改的数据库表，重新建表，这是程序不能容忍的BUG。

前人栽树后人乘凉，我在网上找了几种方法，这里记下最简单的一种：

GreenDaoUpgradeHelper

亲测可用！

但是，其中有个大Bug：

增加的字段，不可以为八种基本类型，不然数据库升级成功，但是数据还是被删空

项目地址