1. 前言

• 主要介紹GreenDao的基本應用。
• 本文資料來源網路公開資源，並根據個人實踐見解純手打整理，如有錯誤請隨時指出。
• 本文主要用於個人積累及分享，文中可能引用其他技術大牛文章（僅引用連結不轉載），如有侵權請告知必妥善處理。

2. 應用層原理簡介

• 如果這部分看起來感覺抽象難懂，可以先看之後的實操部分，操作一遍之後再回頭看，更容易理解此部分。

2.1. 編譯後自動注入的檔案有哪些

GreenDao是什麼我想已無需多解釋，關鍵是瞭解它在一個事務發起時是怎樣去執行一系列程式碼的。
首先需要了解編譯後，GreenDao注入的java檔案，主要有哪些，功能是什麼。

• 在《GreenDao配置流程》中，schema配置了”daoPackage ‘xx.xxx.xxxxx.greendao.dao’”，當rebuild後，daoPackage所指定的包路徑下，我們可以找到自動生成的檔案有：
  
  • DaoMaster.java
    
    • 入口類，在任何情況下操作資料庫的入口。
    • 包含註冊XxxxBeanDao類，建立DaoSession例項，操作DatabaseOpenHelper相關的建立表、刪除表、更新資料庫等操作
    • 建立對映關係
  • DaoSession.java
    
    • 建立所有Bean類對應的Dao類的例項，完成對映關係
  • 每個Bean類對應的Dao類
    
    • 資料庫操作類，繼承自抽象類AbstractDao

2.2. 獲取一個Dao物件的過程

2.2.1. 程式碼示例：

DaoSession daoSession = new DaoMaster(new DaoMaster.DevOpenHelper(context, DATA_BASE_NAME).getWritableDb()).newSession();
daoSession.getXxxxBeanDao();

2.2.2. 分段解釋建立過程

• new DaoMaster(…);

  • DaoMaster類的構造方法中，傳入的Database例項使用DaoMaster中DevOpenHelper建立，自定義DATA_BASE_NAME

  • DaoMaster類的構造方法中，進入registerDaoClass(…)方法，可以看到這一操作實際上是將XxxxBeanDao.class加入其抽象父類AbstractDaoMaster的一個map：daoConfigMap中，以把DaoConfig和XxxxBeanDao.class繫結，如下圖：

    

  • 進入DaoConfig類，可以看到，構造方法中程式碼實際上是一個建立反射機制的過程，這為每個Dao準備好TableName、Property、Pk等一系列引數。每個Dao都將建立一個對應的DaoConfig與之繫結，具體程式碼不再截圖，此類比較簡單，但非常重要，後面也會提到。

• newSession();

  • 接續上面的內容，回到DaoMaster類，看到daoConfigMap實際是用來建立DaoSession例項的引數，如下圖：

    

  • 建立DaoSession例項時，進入DaoSession類的方法可以看到，呼叫了daoConfigMap的clone()方法得到所有對應Dao檔案的daoConfig，並對其建立快取入口，這個快取建立的方法是DaoConfig類中initIdentityScope(IdentityScopeType type)

  • 在DaoSession建立中，將建立所有Bean類對應的Dao類的例項，並將XxxxBean.class和對應的Dao類繫結，到此為止GreenDao框架內部基本已完成了物件關係對映處理

• 此時可以 2.2.1. 的示例程式碼，可以輕鬆獲得Bean類的操作類XxxxBeanDao的例項。

3. 關於註解

4. 基本應用

4.1. 建立一個Bean

參看如下PeopleBean.java程式碼和註釋

//注意：準備做資料庫儲存的Bean，必須新增@Entity註解
@Entity
public class PeopleBean {
    @Id
    //此處有坑，務必注意
    //注意：必須使用包裝型別Long，而非基本型別long
    private Long id;
    @NotNull
    private String name;
    private int age;
    private String province;
    private boolean isMale;
    @Unique
    private String idCard;

    //注意：get、set方法，無需自己生成，當此類建立完成後，rebuild專案，將自動生成

    //注意：toString是需要自己建立生成的
    @Override
    public String toString() {
        return "PeopleBean{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", age=" + age +
                ", province='" + province + '\'' +
                ", isMale=" + isMale +
                ", idCard='" + idCard + '\'' +
                '}';
    }
}

4.2. 獲取Dao例項

前提：rebuild專案

4.2.1. 獲取DaoSession例項

• 需要注意的是，DaoSession例項包含該專案中所有已被@Entity註解的Bean所建立的Dao類例項，故DaoSession例項最好為單例模式，並加鎖
• 或者，將DaoSession建立在該工程的Application類中，也可以形成事實上的單例

這裡示例程式碼展示建立一個單例的工具類，用來獲取DaoSession例項：

public class GreenDaoUtil {
    private static DaoSession daoSession;
    private final static String DATA_BASE_NAME = "test_01.db";

    public synchronized static DaoSession getDaoSession(Context context) {
        if (daoSession == null) {
            daoSession = new DaoMaster(new DaoMaster.DevOpenHelper(context, DATA_BASE_NAME).getWritableDb()).newSession();
        }
        return daoSession;
    }

}

4.2.2. 獲取Dao例項

GreenDaoUtil.getDaoSession(activity).getPeopleBeanDao();

4.2.3. Dao操作增刪改查示例

複雜應用不一一示例，後面系列文章將逐漸體現

GreenDaoUtil.getDaoSession(activity).getPeopleBeanDao().insert(peopleBean);

GreenDaoUtil.getDaoSession(activity).getPeopleBeanDao().deleteByKey(peopleBean.getId());

GreenDaoUtil.getDaoSession(activity).getPeopleBeanDao().update(peopleBean);

//全部
List<PeopleBean> peopleBeanList = GreenDaoUtil.getDaoSession(activity).getPeopleBeanDao()
                        .queryBuilder()
                        .list();

//條件查
List<PeopleBean> peopleBeanList = GreenDaoUtil.getDaoSession(activity).getPeopleBeanDao()
                        .queryBuilder()
                        .where(PeopleBeanDao.Properties.Age.gt(30), PeopleBeanDao.Properties.IsMale.eq(true))
                        .list();

注意：
查詢方法返回的 List，從原始碼上看，永不為null，可以省略對其null判斷，直接foreach使用

5. 結語

這一部分基本沒有什麼坑，比較簡單，還是總結下關鍵點，如下：

• 對於應用層的一些較淺層原始碼，最好還是熟悉下，便於以後的應用
• 對註解的需要熟悉
• 主鍵Id，必須包裝類Long型，避免各種坑
• DaoSession例項需要單例
• 當Bean變數被改變（或任何涉及資料庫的改變），rebuild後資料庫對應的表結構也會隨之改變，這時必須schema配置必須將schemaVersion +1