一、關于greenDAO
greenDAO應該算是當前最火的數據庫開源框架了，它是一個將對象映射到SQLite數據庫中的輕量且快速的ORM（object / relational mapping）解決方案。
關于greenDAO的其他相關信息可以看官網greenDAO、
githubgreenDAO地址、官方的配置GreenDAO英文文檔
二、greenDAO理解
DAO的core library中有以下幾個核心類，也是后面常用到的，先來大概了解下他們的結構，不然直接看他們的使用會云里霧里。
DaoMaster：Dao中的管理者。它保存了sqlitedatebase對象以及操作DAO classes（注意：不是對象）。其提供了一些創建和刪除table的靜態方法，其內部類OpenHelper和DevOpenHelper實現了
SQLiteOpenHelper，并創建數據庫的框架。DaoSession：會話層。操作具體的DAO對象（注意：是對象），比如各種getter方法。
Daos：實際生成的某某DAO類，通常對應具體的java類，比如NoteDao等。其有更多的權限和方法來操作數據庫元素。
Entities：持久的實體對象。通常代表了一個數據庫row的標準java properties。
三、greenDAO優勢
1、一個精簡的庫
2、性能最大化
3、內存開銷最小化
4、易于使用的 APIs
5、對 Android 進行高度優化
有興趣的可以看下官網的 greenDAO Features
四、greenDAO使用
greenDAO3.0采用注解的方式來定義實體類，通過gradle插件生成相應的代碼。
1，首先在project的gradle文件中引入greenDAO插件，引入之后如下：
// In your root build.gradle file:
buildscript {
repositories {
jcenter()
mavenCentral() // add repository
}
dependencies {
classpath 'com.android.tools.build:gradle:3.0.0'
classpath 'org.greenrobot:greendao-gradle-plugin:3.2.2' // add plugin
}
}
2，然后在module的gradle文件中添加greenDAO的插件，并引入相關類庫，修改之后如下：
// In your app projects build.gradle file:
apply plugin: 'com.android.application'
apply plugin: 'org.greenrobot.greendao' // apply plugin
android {
...
...
greendao{
schemaVersion 1
daoPackage 'com.greendao.gen'
targetGenDir 'src/main/java'
}
}
dependencies {
...
...
implementation 'org.greenrobot:greendao:3.2.2' // add library
}
在gradle的根模塊中加入上述代碼，就完成了我們的基本配置了。
屬性介紹：
schemaVersion--> 指定數據庫schema版本號，遷移等操作會用到;
daoPackage --> dao的包名，包名默認是entity所在的包；
targetGenDir --> 生成數據庫文件的目錄;
3，創建一個User的實體類
@Entity
public class User {
@Id
private Long id;
@Property(nameInDb = "NAME")
private String name;
@Transient
private int tempUsageCount; // not persisted
}
- @Entity 表示這個實體類一會會在數據庫中生成對應的表，
- @Id 表示該字段是id，注意該字段的數據類型為包裝類型Long
- @Property 則表示該屬性將作為表的一個字段，其中nameInDb看名字就知道這個屬性在數據庫中對應的數據名稱。
- @Transient 該注解表示這個屬性將不會作為數據表中的一個字段。
- @NotNull 表示該字段不可以為空
- @Unique 表示該字段唯一。小伙伴們有興趣可以自行研究。
4，MakeProject
編譯項目（Android快捷鍵：Ctrl+F9），User實體類會自動編譯，生成get、set方法并且會在com.greendao.gen目錄下生成三個文件,并且還會在我們的包下生成DaoMaster和DaoSession。
五、greenDAO使用
步驟：即：先創建了一個SQLiteOpenHelper并創建連接到一個具體數據庫；再根據具體的datebase創建一個master對象用于；最后通過master創建一個數據庫的會話操作。
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;
}
}
獲取UserDao對象：
UserDao mUserDao = MyApplication.getInstances().getDaoSession().getUserDao();
六、簡單的增刪改查實現：
- 增
mUser = new User((long)2,"anye3");
mUserDao.insert(mUser);//添加一個
- 刪
mUserDao.deleteByKey(id);
- 改
mUser = new User((long)2,"anye0803");
mUserDao.update(mUser);
- 查
List<User> users = mUserDao.loadAll();
String userName = "";
for (int i = 0; i < users.size(); i++) {
userName += users.get(i).getName()+",";
}
mContext.setText("查詢全部數據==>"+userName);
更多的操作就不一一介紹了，大家可以根據需要去查找資料；
七、greenDAO中的注解
(一) @Entity 定義實體
@nameInDb 在數據庫中的名字，如不寫則為實體中類名
@indexes 索引
@createInDb 是否創建表，默認為true,false時不創建
@schema 指定架構名稱為實體
@active 無論是更新生成都刷新
(二) @Id
(三) @NotNull 不為null
(四) @Unique 唯一約束
(五) @ToMany 一對多
(六) @OrderBy 排序
(七) @ToOne 一對一
(八) @Transient 不存儲在數據庫中
(九) @generated 由greenDAO產生的構造函數或方法
八、數據庫升級
數據庫的升級其實就兩個步驟我們來看看：
8.1 修改gradle文件
首先在module的gradle文件中修改版本號：
//這里改為最新的版本號
schemaVersion 2
targetGenDir 'src/main/java'
8.2修改實體類
@Entity
public class User {
@Property
private int age;
@Property
private String password;
@Id
private Long id;
@Property(nameInDb = "USERNAME")
private String username;
@Property(nameInDb = "NICKNAME")
private String nickname;
}
重現編譯項目運行即可。
一般的數據庫升級這樣就可以了，特殊情況可能需要自己編寫數據庫遷移腳本，這種時候可以自定義DBHelper，定義方式如下，注意繼承類：
public class DBHelper extends DaoMaster.OpenHelper {
public static final String DBNAME = "lenve.db";
public DBHelper(Context context) {
super(context, DBNAME, null);
}
@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
super.onUpgrade(db, oldVersion, newVersion);
}
}
可以在onUpgrade方法中進行數據庫的遷移，如果自定義了DBHelper，則數據庫的初始化變為如下方式：
DBHelper devOpenHelper = new DBHelper(this);
DaoMaster daoMaster = new DaoMaster(devOpenHelper.getWritableDb());
DaoSession daoSession = daoMaster.newSession();
userDao = daoSession.getUserDao();
九.結束語
總體來說,greenDAO在配置上相對于2.0要簡單的多。
本文 Demo 下載鏈接：greenDAODemo，如果喜歡的話可以star一下。
本教程旨在介紹 greenDAO3.0的基本用法與配置，更高級與詳細的使用，請參見官網如本文有任何問題歡迎指正。
