GreenDao 3.2.0 的基本使用

前言

Android開發中我們或多或少都會接觸到數據庫。Android中提供了一個佔用內存極小的關係型數據庫-SQLite。雖然Android系統中提供了許多操作SQLite的API，但是我們還是需要手動去編寫SQL語句，這經常會出現一些莫名其妙的問題（😂,不要問我爲什麼）。所以便出現了許多ORM（對象關係映射）框架。其中比較著名的有GreenDao、OrmLite、Litepal等。下面主要介紹一下GreenDao，我平時用的最多的也是GreenDao。

GreenDao簡介

官網上的介紹，greenDAO 是一個將對象映射到 SQLite 數據庫中的輕量且快速的 ORM 解決方案。（greenDAO is a light & fast ORM solution that maps objects to SQLite databases.）

GreenDao特點

• 性能最大化，可能是Android平臺上最快的ORM框架
• 易於使用的API
• 最小的內存開銷
• 依賴體積小
• 支持數據庫加密
• 強大的社區支持

GreenDao有如此多的有點，我們還有什麼理由不去使用它呢。

GreenDao配置

在build.gradle(Module:app)中添加下面代碼：

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

 apply plugin: 'org.greenrobot.greendao'

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

其他配置

在build.gradle(Module:app)中添加：

greendao {   
        schemaVersion 1//數據庫版本號    
        daoPackage 'com.com.sky.downloader.greendao'//設置DaoMaster、DaoSession、Dao包名    
        targetGenDir 'src/main/java'//設置DaoMaster、DaoSession、Dao目錄   
        //targetGenDirTest：設置生成單元測試目錄    
       //generateTests：設置自動生成單元測試用例
}

上述配置是可選項，如果不配置，則默認生成在build下：

GreenDao的基本配置就已經完成了，下面我們編寫一個實體類。

實體類User

  @Entity
  public class User {   
        @Id(autoincrement = true)   
        private Long id;   
        private String name;   
        private int age;
}

相關注解說明：

• 實體@Entity註解

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

• 基礎屬性註解

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

• 索引註解

  @Index：使用@Index作爲一個屬性來創建一個索引，通過name設置索引別名，也可以通過unique給索引添加約束
  @Unique：向數據庫添加了一個唯一的約束

• 關係註解

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

當我們編寫好實體類並添加自己需要的註解之後，點擊Make Project或者Make Module 'app'，就會項目的build目錄下或者自己設定的目錄下看到生成的三個類文件：

• DaoMaster
• DaoSession
• UserDao

後面的數據庫操作需要藉助這三個類來進行，同時在我們的實體類中自動生成了各個屬性的get、set方法。

初始化GreenDao

一般建議在Application中初始化數據庫

DevOpenHelper有兩個重載方法：

• DevOpenHelper(Context context,String name)
• DevOpenHelper(Context context,String name,CursorFactory factory)
  context上下文這個不用多說，name數據庫的名字，cursorFactory遊標工廠，一般不用，傳入null或者使用兩個參數的方法即可。我們對外提供一個getDaoSession()的方法供外部使用。

增

注意：Long型id，如果傳入null，則GreenDao會默認設置自增長的值。

• insert(User entity)：插入一條記錄
  

刪

• deleteBykey(Long key) ：根據主鍵刪除一條記錄。
• delete(User entity) ：根據實體類刪除一條記錄，一般結合查詢方法，查詢出一條記錄之後刪除。
• deleteAll()： 刪除所有記錄。
  

改

• update(User entity)：更新一條記錄
  

查

• loadAll()：查詢所有記錄
• load(Long key)：根據主鍵查詢一條記錄
• queryBuilder().list()：返回：List
• queryBuilder().where(UserDao.Properties.Name.eq("")).list()：返回：List
• queryRaw(String where,String selectionArg)：返回：List

總結

至此，GreenDao的基本使用方法就這些了，後面還有一些關於數據的升級等問題，後面再具體介紹。