一、GreenDao 簡介

greenDAO 是一款開源的面向 Android 的輕便、快捷的 ORM 框架，將 Java 物件對映到 SQLite   資料庫中，我們操作資料庫的時候，不在需要編寫複雜的 SQL語句， 在效能方面，greenDAO 針對 Android 進行了高度優化，   最小的記憶體開銷 、依賴體積小 同時還是支援資料庫加密。

二、GreenDao 特徵：

1、物件對映（ ORM）

greenDAO 是ORM 框架，可以非常便捷的將Java 物件對映到 SQLite  資料庫中儲存。

2、高效能

ORM 框架有很多，比較著名的有 OrmLite ， ActiveAndroid 等，效能也不一樣，下圖是 GreenDao 官方給出的效能對比。

3、支援加密

GreenDao  是支援加密的，可以安全的儲存使用者資料。

4、輕量級

GreenDao  核心庫小於100k ，所以我們並不會擔心新增 GreenDao  後 APK 大小會變的是否龐大。

5、支援 protocol buffer(protobuf) 協議

GreenDao  支援 protocol buffer(protobuf) 協議資料的直接儲存，如果你通過 protobuf 協議與伺服器互動，將不需要任何的對映。

6，程式碼生成

greenDAO 會根據配置資訊自動生成核心管理類以及 DAO 物件

7，開源

三、核心類介紹

DaoMaster：

使用 greenDAO 的入口點。DaoMaster 負責管理資料庫物件(SQLiteDatabase)和 DAO 類(物件)，我們可以通過它內部類 OpenHelper 和 DevOpenHelper SQLiteOpenHelper 建立不同模式的 SQLite 資料庫。

DaoSession :

管理指定模式下的所有 DAO 物件，DaoSession提供了一些通用的永續性方法比如插入、負載、更新、更新和刪除實體。

XxxDAO :

每個實體類 greenDAO  多會生成一個與之對應DAO物件，如：User 實體，則會生成一個一個UserDao 類

Entities

可持久化物件。通常, 實體物件代表一個數據庫行使用標準 Java 屬性(如一個POJO 或 JavaBean )。

核心類之間的關係

四、 整合 GreenDAO

a、設定倉庫與外掛（Project： build.gradle）

1. buildscript {
2.     repositories {
3.         jcenter
   ()
4.         mavenCentral()// add repository
5. }
6.     dependencies {
7.         classpath 'com.android.tools.build:gradle:2.3.2'
8.         classpath 'org.greenrobot:greendao-gradle-plugin:3.2.2'// add plugin
9. }
10. }

b、 配置依賴 ( Module:app  build.gradle  )

1. apply plugin:'com.android.application'
2. apply plugin:'org.greenrobot.greendao'// apply plugin
3. dependencies {
4.     compile 'org.greenrobot:greendao:3.2.2'// add library
5. // This is only needed if you want to use encrypted databases
6.     compile 'net.zetetic:android-database-sqlcipher:3.5.6'//加密庫依賴（可選項）
7. }

c、 配置資料庫相關資訊 ( Module:app  build.gradle  )

1. greendao {
2.     schemaVersion 1//資料庫版本號
3.     daoPackage 'com.speedystone.greendaodemo.db'// 設定DaoMaster、DaoSession、Dao 包名
4.     targetGenDir 'src/main/java'//設定DaoMaster、DaoSession、Dao目錄
5. }

d、點選 ： Sync Project with Gradle Files 按鈕，同步一下工程 ， 配置完成

    

五、快速入門

1, 我們寫一個簡單的實體類（User），測試一下

1. package com.speedystone.greendaodemo.model;
2. import org.greenrobot.greendao.annotation.Entity;
3. import org.greenrobot.greendao.annotation.Id;
4. /**
5.  * Created by Speedy on 2017/6/30.
6.  */
7. @Entity
8. publicclassUser{
9. @Id
10. privatelong id;
11. privateString name;
12. privateint age;
13. //此處省略了getter,setter 方法
14. }

2、點選 Make Project（或者 Make Moudle 'App'） 編譯一下工程 。如果配置正確，會在配置的包目錄下自動會生成 DaoMaster，DaoSession 和 UserDao 類 。

3，初始化 GreenDao ( 通常初始化程式碼寫在我們的 Application 類中)

4，獲取 UserDao

1. MyApp myApp =(MyApp) getApplication();
2. DaoSession daoSession =  myApp.getDaoSession();
3. UserDao userDao = daoSession.getUserDao();

5, 儲存記錄

1. User user =newUser();
2.  user.setUserId(1);
3.  user.setName("小明");
4.  user.setAge(16);
5.   userDao.insert(user);

1. User user =newUser();
2.  user.setUserId(1);
3.  user.setName("小明");
4.  user.setAge(16);
5. //插入或者替換
6.  userDao.insertOrReplace(user);

5, 刪除記錄

1. publicvoiddelete(User user){
2.     userDao.delete(user);
3. }

或者

1. publicvoid deleteByUserId(long userid){
2.      userDao.deleteByKey(1L);
3. }

6，更新記錄

1. publicvoid update(User user){
2.     userDao.update(user);
3. }

7，查詢記錄

1. publicList query(){
2. return userDao.loadAll();// 查詢所有記錄
3. }

1. publicUser query2(){
2. return userDao.loadByRowId(1);//根據ID查詢
3. }

1. publicList query2(){
2. return userDao.queryRaw("where AGE>?","10");//查詢年齡大於10的使用者
3. }

1. //查詢年齡大於10的使用者
2. publicList query4(){
3. QueryBuilder builder = userDao.queryBuilder();
4. return  builder.where(UserDao.Properties.Age.gt(10)).build().list();
5. }

六、註解詳解

@Entity  

表明這個實體類會在資料庫中生成一個與之相對應的表

屬性：

• schema：告知GreenDao當前實體屬於哪個 schema

• schema active：標記一個實體處於活躍狀態，活動實體有更新、刪除和重新整理方法

• nameInDb：在資料庫中使用的別名，預設使用的是實體的類名，

• indexes：定義索引，可以跨越多個列

• createInDb：標記建立資料庫表（預設：true）

• generateConstructors  自動建立全參構造方法（同時會生成一個無參構造方法）（預設：true）

• generateGettersSetters  自動生成 getters and setters 方法（預設：true）

1. @Entity(
2.         schema ="myschema",
3.         active =true,
4.         nameInDb ="AWESOME_USERS"，
5.         indexes ={
6. @Index(value ="name DESC", unique =true)
7. },
8.         createInDb =true,
9.         generateConstructors =false,
10.         generateGettersSetters =true
11. )
12. publicclassUser{
13. ...
14. }

@Id

對應資料表中的 Id 欄位

@Index

使用@Index作為一個屬性來建立一個索引，預設是使用欄位名

1. @Entity
2. publicclassUser{
3. @Id
4. privateLong id;
5. @Index(unique =true)
6. privateString name;
7. }

@Property

設定一個非預設關係對映所對應的列名，預設是使用欄位名,例如：@Property(nameInDb = "userName")

@NotNull  

設定資料庫表當前列不能為空

@Transient

新增此標記後不會生成資料庫表的列

相關推薦