Android數據存儲之GreenDao 3.0 詳解

時間 2019-11-22

標籤 android 數據存儲 greendao 3.0 詳解欄目 Android 简体版

原文原文鏈接

前言：

今天一大早收到GreenDao 3.0 正式發佈的消息，自從2014年接觸GreenDao至今，項目中一直使用GreenDao框架處理數據庫操做，本人使用數據庫路線 Sqlite---->OrmLite---->GreenDao。今天白天一直在忙着公司的項目需求，只能晚上加班來學習最新的GreenDao 3.0使用方式了。html

GreenDao 介紹：

greenDAO是一個對象關係映射（ORM）的框架，可以提供一個接口經過操做對象的方式去操做關係型數據庫，它可以讓你操做數據庫時更簡單、更方便。以下圖所示：java

官網地址：http://greenrobot.org/greendao/git

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

GreenDao 優勢：

性能高，號稱Android最快的關係型數據庫數據庫
內存佔用小
庫文件比較小，小於100K，編譯時間低，並且能夠避免65K方法限制app
支持數據庫加密 greendao支持SQLCipher進行數據庫加密有關SQLCipher能夠參考這篇博客Android數據存儲之Sqlite採用SQLCipher數據庫加密實戰框架
簡潔易用的API

GreenDao 3.0改動：

使用過GreenDao的同窗都知道，3.0以前須要經過新建GreenDaoGenerator工程生成Java數據對象（實體）和DAO對象，很是的繁瑣並且也加大了使用成本。maven

GreenDao 3.0最大的變化就是採用註解的方式經過編譯方式生成Java數據對象和DAO對象。性能

GreenDao 3.0使用方式：

1.）在build.gradle添加以下配置

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'org.greenrobot:greendao-gradle-plugin:3.0.0'
    }
}

apply plugin: 'org.greenrobot.greendao'


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

2.）新建實體

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

   //下面省去了 setter/getter
}

此時編譯一下自動生成DaoMaster 、DaoSession、Dao，如圖所示默認位置：單元測試

3.）Gradle 插件配置

好比上面想指定生成DaoMaster 、DaoSession、Dao位置

greendao {
    targetGenDir 'src/main/java'
}

schemaVersion：數據庫schema版本，也能夠理解爲數據庫版本號
daoPackage：設置DaoMaster 、DaoSession、Dao包名
targetGenDir：設置DaoMaster 、DaoSession、Dao目錄
targetGenDirTest：設置生成單元測試目錄
generateTests：設置自動生成單元測試用例

4.）實體@Entity註解

schema：告知GreenDao當前實體屬於哪一個schema
active：標記一個實體處於活動狀態，活動實體有更新、刪除和刷新方法
nameInDb：在數據中使用的別名，默認使用的是實體的類名
indexes：定義索引，能夠跨越多個列
createInDb：標記建立數據庫表

5.）基礎屬性註解

@Id :主鍵 Long型，能夠經過@Id(autoincrement = true)設置自增加
@Property：設置一個非默認關係映射所對應的列名，默認是的使用字段名舉例：@Property (nameInDb="name")
@NotNul：設置數據庫表當前列不能爲空
@Transient ：添加次標記以後不會生成數據庫表的列

6.)索引註解

@Index：使用@Index做爲一個屬性來建立一個索引，經過name設置索引別名，也能夠經過unique給索引添加約束
@Unique：向數據庫列添加了一個惟一的約束

7.）關係註解

@ToOne：定義與另外一個實體（一個實體對象）的關係
@ToMany：定義與多個實體對象的關係

GreenDao 3.0簡單實戰：

1.）經過上面使用方式咱們能夠獲取DaoMaster 、DaoSession、Dao類

這裏聲明一個數據庫管理者單例

public class DBManager {
    private final static String dbName = "test_db";
    private static DBManager mInstance;
    private DaoMaster.DevOpenHelper openHelper;
    private Context context;

    public DBManager(Context context) {
        this.context = context;
        openHelper = new DaoMaster.DevOpenHelper(context, dbName, null);
    }

    /**
     * 獲取單例引用
     *
     * @param context
     * @return
     */
    public static DBManager getInstance(Context context) {
        if (mInstance == null) {
            synchronized (DBManager.class) {
                if (mInstance == null) {
                    mInstance = new DBManager(context);
                }
            }
        }
        return mInstance;
    }
}

2.）獲取可讀可寫數據庫

可讀數據庫

  /**
     * 獲取可讀數據庫
     */
    private SQLiteDatabase getReadableDatabase() {
        if (openHelper == null) {
            openHelper = new DaoMaster.DevOpenHelper(context, dbName, null);
        }
        SQLiteDatabase db = openHelper.getReadableDatabase();
        return db;
    }

可寫數據庫

    /**
     * 獲取可寫數據庫
     */
    private SQLiteDatabase getWritableDatabase() {
        if (openHelper == null) {
            openHelper = new DaoMaster.DevOpenHelper(context, dbName, null);
        }
        SQLiteDatabase db = openHelper.getWritableDatabase();
        return db;
    }

3.）插入數據

 /**
     * 插入一條記錄
     *
     * @param user
     */
    public void insertUser(User user) {
        DaoMaster daoMaster = new DaoMaster(getWritableDatabase());
        DaoSession daoSession = daoMaster.newSession();
        UserDao userDao = daoSession.getUserDao();
        userDao.insert(user);
    }

    /**
     * 插入用戶集合
     *
     * @param users
     */
    public void insertUserList(List<User> users) {
        if (users == null || users.isEmpty()) {
            return;
        }
        DaoMaster daoMaster = new DaoMaster(getWritableDatabase());
        DaoSession daoSession = daoMaster.newSession();
        UserDao userDao = daoSession.getUserDao();
        userDao.insertInTx(users);
    }

4.）刪除數據

 /**
     * 刪除一條記錄
     *
     * @param user
     */
    public void deleteUser(User user) {
        DaoMaster daoMaster = new DaoMaster(getWritableDatabase());
        DaoSession daoSession = daoMaster.newSession();
        UserDao userDao = daoSession.getUserDao();
        userDao.delete(user);
    }

5.）更新數據

 /**
     * 更新一條記錄
     *
     * @param user
     */
    public void updateUser(User user) {
        DaoMaster daoMaster = new DaoMaster(getWritableDatabase());
        DaoSession daoSession = daoMaster.newSession();
        UserDao userDao = daoSession.getUserDao();
        userDao.update(user);
    }

6.）查詢數據

  /**
     * 查詢用戶列表
     */
    public List<User> queryUserList() {
        DaoMaster daoMaster = new DaoMaster(getReadableDatabase());
        DaoSession daoSession = daoMaster.newSession();
        UserDao userDao = daoSession.getUserDao();
        QueryBuilder<User> qb = userDao.queryBuilder();
        List<User> list = qb.list();
        return list;
    }

    /**
     * 查詢用戶列表
     */
    public List<User> queryUserList(int age) {
        DaoMaster daoMaster = new DaoMaster(getReadableDatabase());
        DaoSession daoSession = daoMaster.newSession();
        UserDao userDao = daoSession.getUserDao();
        QueryBuilder<User> qb = userDao.queryBuilder();
        qb.where(UserDao.Properties.Age.gt(age)).orderAsc(UserDao.Properties.Age);
        List<User> list = qb.list();
        return list;
    }

7.）測試程序

 DBManager dbManager = DBManager.getInstance(this);
        for (int i = 0; i < 5; i++) {
            User user = new User();
            user.setId(i);
            user.setAge(i * 3);
            user.setName("第" + i + "人");
            dbManager.insertUser(user);
        }
        List<User> userList = dbManager.queryUserList();
        for (User user : userList) {
            Log.e("TAG", "queryUserList--before-->" + user.getId() + "--" + user.getName() +"--"+user.getAge());
            if (user.getId() == 0) {
                dbManager.deleteUser(user);
            }
            if (user.getId() == 3) {
                user.setAge(10);
                dbManager.updateUser(user);
            }
        }
        userList = dbManager.queryUserList();
        for (User user : userList) {
            Log.e("TAG", "queryUserList--after--->" + user.getId() + "---" + user.getName()+"--"+user.getAge());
        }