上一篇講了GreenDao的配置,本篇著重于API的各種使用,并附上Demo。
類的關系
大家還記得上一篇講到的代碼自動生成的四個類,DaoMaster
,DaoSession
,Dao
,User
,排除最后一個User
實體類不說,其他三個的關系應該是非常明確的。
從圖上看出,得到User對象的步驟。其中還有些細節需要說明。
獲取DaoMaster
用過數據庫的程序圓都清楚,我們需要DaoSession
對象來進行對數據庫的增刪改查。
從DaoMaster
中有newSession()
的方法可以幫我們實現。
所以我們應該先實例化DaoMaster
,具體代碼是
public DaoMaster(SQLiteDatabase db) {
super(db, SCHEMA_VERSION);
registerDaoClass(UserDao.class);
}
噢,需要一個SQLiteDatabase
實例,請拼命想一想怎么獲取一個SQLiteDatabase
實例?
沒錯,通過SQLiteOpenHelper
,再仔細看一下DaoMaster
,好像已經提供了抽象類OpenHelper
繼承了SQLiteOpenHelper
。
Cool!
可以獲取DevOpenHelper
,具體代碼是
/**
* WARNING: Drops all table on Upgrade! Use only during development.
*/
public static class DevOpenHelper extends OpenHelper {
public DevOpenHelper(Context context, String name, CursorFactory factory) {
super(context, name, factory);
}
@Override
public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
Log.i("greenDAO", "Upgrading schema from version " + oldVersion + " to " + newVersion + " by dropping all tables");
dropAllTables(db, true);
onCreate(db);
}
}
先不管警告的注釋(當數據庫升級的時候會刪除所有表,僅限于開發時使用)。
只要簡單兩行代碼。
DaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(context, DB_NAME, null);
DaoMaster daoMaster = new DaoMaster(mHelper.getReadableDatabase());
//也可以使用mHelper.getWritableDatabase();
注意:getReadabledatabase()與getWritableDatabase()其實返回的實例都是一樣的,只是當內存空間不足的時候,就不能繼續寫入數據,更為重要的是,它們都是耗時耗時耗時操作!更為詳細的解釋
獲取DaoSession
接著,我們來獲取DaoSession
。
DaoSession daoSession = daoMaster.newSession();
//異步查詢,異步查詢,異步查詢
AsyncSession asyncSession = daoSession.startAsyncSession();
夠簡單嗎?獲得DaoSession
后可以干什么?其實增刪改查的基本功能已經齊全。
只是有三個缺點:
- 顆粒度太大
- API不是很方便
- 官網注釋說只是用于快捷操作
所以UserDao
登場吧
獲取UserDao
UserDao userDao = daoSession.getUserDao();
好了,下面就可以隨心所欲地操作數據庫了。
操作數據庫
增
/**
* 插入一個User對象
*
* @param user
* @return 插入對象的列id
*/
public long insert(User user) {
UserDao userDao = getUserDao();
return userDao.insert(user);
}
查查查***重點
具體方法有
-
queryXXX(...)
,指明各種條件 - 使用
QueryBuilder
(單次查詢),Query
(多次查詢) - 其他等
這里著重講QueryBuilder
和Query
,個人用得非常順手,因為自己對SQL語句并不喜歡,so...
看一個簡單例子
/**
* 通過id取得用戶。此處使用QueryBuider,并沒有構造Query
*
* @param id
* @return
*/
public User getUserById(long id) {
UserDao userDao = getUserDao();
//獲取QueryBuilder
QueryBuilder qb = userDao.queryBuilder();
//聲明條件,屬性在UserDao中已經存在
qb.where(UserDao.Properties.Id.eq(id));
//返回唯一數據
return (User) qb.unique();
}
而QueryBuilder
只是用來創建Query
而已,Query
更使用于相同的查詢,所以QueryBuilder
就不要隨便用了。
Quert
特點如下
-
Query
通過QueryBuilder.build()
獲取,它是使用Builder模式設計的,支持多次查詢,多線程查詢//實際按照要求具體操作 Query<User> query = userDao.queryBuilder().orderDesc().where().count().build(); //返回單一結果 query.unique() //返回一個非null的實體。否則就會拋出一個DaoException。 query.uniqueOrThrow() //所有查詢都加載到內存 query.list(); //實體按照需求加載進入內存。一旦列表中的一個元素被第一次訪問,它將被加載同時緩存以便以后使用。必須close。 query.listLazy(); //多線程查詢,為當前線程獲取一個Query實例 query.forCurrentThread();
支持
equal
,in
,between
等等一系列比較符Query
可重用
先創建如下Query
,根據id = 123和age = 10進行查找(示例)
UserDao userDao = getUserDao();
QueryBuilder<User> queryBuilder = userDao.queryBuilder().where(UserDao.Properties.Id.eq(123));
queryBuilder.where(UserDao.Properties.Age.eq(10)).unique();
Query query = queryBuilder.build();
query.unique();
下一次同樣需要根據id = 321和age = 100來進行查找,就可以
//設置id和age的值
query.setParameter(321, 100);
//返回唯一結果
//query.unique()
//設置多個查找目標
query.setParameter(111, 180);
//返回list
query.list();
注意:當Query沒有返回語氣結果,故障排查可以設置QueryBuilder.LOG_SQL = true;
和QueryBuilder.LOG_VALUES = true;
,打印出SQL語句
更多高級用法請查看官方API文檔。
改
基本原則是根據主鍵來修改,比較簡單的兩種情況是
- 已知主鍵
直接能用API的都基本上已知主鍵的
/**
* 更新user信息
*
* @param newUser 新User,主鍵必須存在
*/
public void update(User newUser) {
UserDao userDao = getUserDao();
userDao.update(newUser);
}
- 未知主鍵,知道其他值
先根據主鍵查找(復習查找的知識),再重復情況一
刪
同理,跟改操作基本一致。
/**
* 根據主鍵刪除User
*
* @param id User的主鍵Id
*/
public void deleteUserById(long id) {
UserDao userDao = getUserDao();
userDao.deleteByKey(id);
}
總結
GreenDao給我們簡化了編寫大量重復代碼的步驟,作為輕量級的ORM框架速度飛快,值得深入學習。
GreenDao底層并不保證線程安全,這意味著多線程環境下還需要我們程序圓來控制 ;)