GreenDao 介紹：
greenDAO是一個對象關(guān)系映射（ORM）的框架恒序，能夠提供一個接口通過操作對象的方式去操作關(guān)系型數(shù)據(jù)庫即纲，它能夠讓你操作數(shù)據(jù)庫時更簡單篱瞎、更方便顾稀。如下圖所示：
官網(wǎng)地址：http://greenrobot.org/greendao/
github：https://github.com/greenrobot/greenDAO
GreenDao 優(yōu)點：
性能高达罗，號稱Android最快的關(guān)系型數(shù)據(jù)庫
內(nèi)存占用小
庫文件比較小，小于100K静秆，編譯時間低粮揉，而且可以避免65K方法限制
支持?jǐn)?shù)據(jù)庫加密 greendao支持SQLCipher進行數(shù)據(jù)庫加密 有關(guān)SQLCipher可以參考這篇博客Android數(shù)據(jù)存儲之Sqlite采用SQLCipher數(shù)據(jù)庫加密實戰(zhàn)
簡潔易用的API
GreenDao 3.0改動：
使用過GreenDao的同學(xué)都知道，3.0之前需要通過新建GreenDaoGenerator工程生成Java數(shù)據(jù)對象（實體）和DAO對象诡宗，非常的繁瑣而且也加大了使用成本滔蝉。
GreenDao 3.0最大的變化就是采用注解的方式通過編譯方式生成Java數(shù)據(jù)對象和DAO對象。
三大改變就是：1.換包名 2.實體注解 3.加密支持的優(yōu)化
本文里面會遇到一些代碼示例塔沃，就摘了官方文檔和demo里的例子了，因為他們的例子已經(jīng)寫的很好了阳谍。
一蛀柴、GreenDao3的配置
3.0相比2.0的配置較為方便，不用新建Module等一系列操作矫夯，可以直接在build.gradle里配置并新建實體用添加注解的方式生成
步驟1/2
build.gradle下添加這些配置（v7包下面的3個是greendao的）
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'org.greenrobot:greendao-gradle-plugin:3.0.0'
}
}
apply plugin: 'org.greenrobot.greendao'
dependencies {
compile fileTree(dir: 'libs', include: ['*.jar'])
testCompile 'junit:junit:4.12'
compile 'com.android.support:appcompat-v7:23.4.0'
compile 'org.greenrobot:greendao:3.0.1'
compile 'org.greenrobot:greendao-generator:3.0.0'
compile 'net.zetetic:android-database-sqlcipher:3.5.2'
}
greendao {
targetGenDir 'src/main/java'
daoPackage 'com.XXXX.dao.db'
}
步驟2/2
2.2版本是在maingen里使用addEntity鸽疾，addProperty等方法，3.0只需要手動創(chuàng)建一個實體類加上注解即可（下面會詳細說）
build項目训貌，自動生成DaoMaster,Daosession,UserDao等文件制肮，接下來就可以在代碼中正常使用了。
二递沪、實體注解
大部分的注解都能找到之前與2.0對應(yīng)的語法
2.1常用注解
@Entity
public class User {
@Id(autoincrement = true)
private Long id;
@Property(nameInDb = "USERNAME")
private String name;
@NotNull
private int repos;
@Transient
private int tempUsageCount;
...
}
其中
@Entity 用于標(biāo)識這是一個需要Greendao幫我們生成代碼的bean
@Id 標(biāo)明主鍵豺鼻，括號里可以指定是否自增 相當(dāng)于2.2版本的
Entity entity = schema.addEntity("User");
entity.addLongProperty("id").primaryKey().autoincrement();
@Property 用于設(shè)置屬性在數(shù)據(jù)庫中的列名（默認(rèn)不寫就是保持一致）
@NotNull 非空
@Transient 標(biāo)識這個字段是自定義的不會創(chuàng)建到數(shù)據(jù)庫表里 相當(dāng)于2.2版本的
schema.enableKeepSectionsByDefault();
會生成下列代碼
// KEEP INCLUDES - put your custom includes here
// KEEP INCLUDES END
// KEEP FIELDS - put your custom fields here
// KEEP FIELDS END
// KEEP METHODS - put your custom methods here
// KEEP METHODS END
之前想自定義的屬性和其getset方法需要寫在注釋中，現(xiàn)在這個注解就能代替作用
2.2實體類注解
@Entity(
schema = "myschema",
active = true,
nameInDb = "AWESOME_USERS",
indexes = {
@Index(value = "name DESC", unique = true)
},
createInDb = false
)
public class User {
...
}
其中
schema是一個項目中有多個schema時 標(biāo)明要讓這個dao屬于哪個schema
active 是標(biāo)明是否支持實體類之間update款慨，refresh儒飒，delete等操作 相當(dāng)于2.2版本的
1
schema.enableActiveEntitiesByDefault();
nameInDb 就是寫個存在數(shù)據(jù)庫里的表名（不寫默認(rèn)是一致）
indexes 定義索引，這里可跨越多個列
CreateInDb 如果是有多個實體都關(guān)聯(lián)這個表檩奠，可以把多余的實體里面設(shè)置為false避免重復(fù)創(chuàng)建（默認(rèn)是true）
2.3索引注解
@Entity
public class User {
@Id private Long id;
@Index(unique = true)
private String name;
}
@Entity
public class User {
@Id private Long id;
@Unique private String name;
}
其中
@Index 通過這個字段建立索引
@Unique 添加唯一約束桩了，上面的括號里unique=true作用相同
2.4關(guān)系注解
@Entity
public class Order {
@Id private Long id;
private long customerId;
@ToOne(joinProperty = "customerId")
private Customer customer;
}
@Entity
public class Customer {
@Id private Long id;
}
@ToOne 是將自己的一個屬性與另一個表建立關(guān)聯(lián)附帽，相當(dāng)于2.2版本的
1
Property property = entity.addLongProperty("customerId").getProperty();
entity.addToOne(Customer, property);
@ToMany 的使用場景有些多，下面的代碼默認(rèn)折疊起來
- View Code
@ToMany的屬性referencedJoinProperty井誉，類似于外鍵約束蕉扮。
@JoinProperty 對于更復(fù)雜的關(guān)系，可以使用這個注解標(biāo)明目標(biāo)屬性的源屬性颗圣。
@JoinEntity 如果你在做多對多的關(guān)系慢显，有其他的表或?qū)嶓w參與，可以給目標(biāo)屬性添加這個額外的注解（感覺不常用吧）
2.5派生注解
@Generated 這個是build后greendao自動生成的欠啤，這個注解理解為防止重復(fù)荚藻，每一塊代碼生成后會加個hash作為標(biāo)記。 官方不建議你去碰這些代碼洁段，改動會導(dǎo)致里面代碼與hash值不符应狱。
三、數(shù)據(jù)庫加密
在Greendao的迭代流程中可以看到這么一個庫
1
compile 'org.greenrobot:greendao-generator-encryption:3.0.0beta3'
Greendao3 與下面這個加密庫合作祠丝，encryption:3.0.0beta-3相當(dāng)于一個適配層疾呻，之后迭代中并入greendao主庫的3.0.1版本，對database相關(guān)的api進行了統(tǒng)一写半。
1
compile 'net.zetetic:android-database-sqlcipher:3.5.2'
之前的版本也是支持加密的岸蜗，但是可以理解為在相互api傳遞數(shù)據(jù)的時候面臨各種類型轉(zhuǎn)換，3.0將其統(tǒng)一叠蝇，使用更加流暢璃岳。
可以直接看寫代碼使用
User man1 = new User();
man1.setId(10001);
man1.setName("kobe");
DaoMaster.DevOpenHelper a = new DaoMaster.DevOpenHelper(this,"database_name",null);
try {
daoSession = new DaoMaster(a.getEncryptedWritableDb(MY_PWD)).newSession();
daoSession.getUserDao().insert(man1);
}catch (Exception e){
Log.d("e", String.valueOf(e));
}
// 若干代碼邏輯后。悔捶。铃慷。
DaoSession normalSession = new DaoMaster(a.getWritableDb()).newSession();
Log.d("無法取數(shù)據(jù)",normalSession.getUserDao().loadAll().toString());
DaoSession encryptedSession = new DaoMaster(a.getEncryptedWritableDb(MY_PWD)).newSession();
Log.d("可以取數(shù)據(jù)",encryptedSession.getUserDao().loadAll().toString());
如上方代碼所示，相比于之前的方法getWriteableDb蜕该，加密的方法是用了getEncryptedWritableDb犁柜。 并在得到DB并getSession時需要輸入密鑰。 其他的步驟和之前類似堂淡。
在取數(shù)據(jù)時使用的session必須也是使用相同的密鑰new出來的馋缅，否則只能看到空數(shù)據(jù)。
07-27 /com.XXX.dsx.testgreendao3 D/無法取數(shù)據(jù): []
07-27 /com.XXX.dsx.testgreendao3 D/可以取數(shù)據(jù): [com.XXX.dsx.testgreendao3.User@2ae5190]
上面的那個MY_PWD是一個靜態(tài)變量绢淀，建議使用本設(shè)備的唯一標(biāo)識類似于UUID的字段做個加密獲得萤悴，這樣每個機器的密鑰是不同的，并且不會發(fā)生改變更啄。
如果把加密后的數(shù)據(jù)庫的本地文件扒出來稚疹，也是查不到內(nèi)容的， 使用dump僅僅可以看到表結(jié)構(gòu)和列名。
如果覺得還不滿意内狗，可以對列名再進行加密怪嫌。在建表時就對列名加密，后續(xù)使用可能會比較麻煩柳沙，建議加密一些關(guān)鍵表如USER,ACCOUNT岩灭。
Gradle 插件配置
比如上面想指定生成DaoMaster 、DaoSession赂鲤、Dao位置
greendao { targetGenDir 'src/main/java'}
schemaVersion： 數(shù)據(jù)庫schema版本噪径，也可以理解為數(shù)據(jù)庫版本號
daoPackage：設(shè)置DaoMaster 、DaoSession数初、Dao包名
targetGenDir：設(shè)置DaoMaster 找爱、DaoSession、Dao目錄
targetGenDirTest：設(shè)置生成單元測試目錄
generateTests：設(shè)置自動生成單元測試用例
4.）實體@Entity注解
schema：告知GreenDao當(dāng)前實體屬于哪個schema
active：標(biāo)記一個實體處于活動狀態(tài)泡孩，活動實體有更新车摄、刪除和刷新方法
****nameInDb：****在數(shù)據(jù)中使用的別名，默認(rèn)使用的是實體的類名
******indexes：******定義索引仑鸥，可以跨越多個列
********createInDb：******標(biāo)記創(chuàng)建數(shù)據(jù)庫表**
5.）基礎(chǔ)屬性注解
@Id :主鍵 Long型吮播，可以通過@Id(autoincrement = true)設(shè)置自增長
@Property：設(shè)置一個非默認(rèn)關(guān)系映射所對應(yīng)的列名，默認(rèn)是的使用字段名 舉例：@Property (nameInDb="name")
@NotNul：設(shè)置數(shù)據(jù)庫表當(dāng)前列不能為空
@Transient ：添加次標(biāo)記之后不會生成數(shù)據(jù)庫表的列
6.)索引注解
@Index：使用@Index作為一個屬性來創(chuàng)建一個索引眼俊，通過name設(shè)置索引別名意狠，也可以通過unique給索引添加約束
@Unique：向數(shù)據(jù)庫列添加了一個唯一的約束
7.）關(guān)系注解
@ToOne：定義與另一個實體（一個實體對象）的關(guān)系
@ToMany：定義與多個實體對象的關(guān)系
出處
http://www.cnblogs.com/dsxniubility/archive/2016/07/28/5699543.html
使用參考
step1 創(chuàng)建表對象
@Entity
public class User {
@Id
private Long id;
private String name;
private int age;
//下面省去了 setter/getter
}
step3 創(chuàng)建DB幫助類
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;
}
/**
* 獲取可讀數(shù)據(jù)庫
*/
private SQLiteDatabase getReadableDatabase() {
if (openHelper == null) {
openHelper = new DaoMaster.DevOpenHelper(context, dbName, null);
}
SQLiteDatabase db = openHelper.getReadableDatabase();
return db;
}
/**
* 獲取可寫數(shù)據(jù)庫
*/
private SQLiteDatabase getWritableDatabase() {
if (openHelper == null) {
openHelper = new DaoMaster.DevOpenHelper(context, dbName, null);
}
SQLiteDatabase db = openHelper.getWritableDatabase();
return db;
}
/**
* 插入一條記錄
*
* @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);
}
/**
* 刪除一條記錄
*
* @param user
*/
public void deleteUser(User user) {
DaoMaster daoMaster = new DaoMaster(getWritableDatabase());
DaoSession daoSession = daoMaster.newSession();
UserDao userDao = daoSession.getUserDao();
userDao.delete(user);
}
/**
* 更新一條記錄
*
* @param user
*/
public void updateUser(User user) {
DaoMaster daoMaster = new DaoMaster(getWritableDatabase());
DaoSession daoSession = daoMaster.newSession();
UserDao userDao = daoSession.getUserDao();
userDao.update(user);
}
/**
* 查詢用戶列表
*/
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;
}
}
step2 調(diào)用db幫助類,測試GreenDao框架
DBManager dbManager = DBManager.getInstance(this);
for (int i = 0; i < 5; i++) {
User user = new User();
user.setId((long) 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());
}
}