Android開源：數據庫ORM框架GreenDao學習心得及使用總結
最近在對開發項目的性能進行優化。因爲項目裏涉及了大量的緩存處理和數據庫運用，須要對數據庫進行頻繁的讀寫、查詢等操做。所以首先想到了對整個項目的數據庫框架進行優化。java
原先使用android自己內置的sqllite，也就是用的最基本的SQLiteOpenHelper方法，這種方法對本身來講比較方便易懂。可是在使用過程當中感受很繁瑣，從建表到對錶的增刪改查等操做，若是表對象的屬性不少，就須要使用大量的代碼來執行建表、插入等。在代碼執行中還須要對數據庫和遊標的進行及時關閉(開啓使用，用完關閉)，並且還須要部分sql語言，這在開發中產生bug進行調試時尤爲不方便。android
目前android常常用的orm框架主要有greenDAO、OrmLite、AndrORM。 綜合了網上的各類評價，greenDAO的運行效率最高，內存消耗最少，性能最佳。所以決定採用greenDAO框架，對項目的orm框架進行改進。git
greenDAO與ORMLite性能對比 github
通過兩天的修改，終於將項目裏的數據庫相關的都優化完了。在這過程當中，發現greenDAO的性能確實不錯，並且使用至關方便，再也不須要涉及到任何的sql語言，能夠直接經過對象類進行建表、增刪改查等，尤爲是api接口又方便易懂。在摸索學習中發現國內相關學習資料實在實在是太少，遂決定在此記錄下本身對使用這個orm框架的一些心得和方法總結。sql
1、greenDAO相關數據庫
1.greenDAO官網：http://greendao-orm.com/api
2.項目下載地址：https://github.com/greenrobot/greenDAO（或者官網）緩存
greenDAO是一個能夠幫助Android開發者快速將Java對象映射到SQLite數據庫的表單中的ORM解決方案，經過使用一個簡單的面向對象API，開發者能夠對Java對象進行存儲、更新、刪除和查詢。app
greenDAO的主要設計目標：框架
*最大性能（最快的Android ORM）
*易於使用API
*高度優化
*最小內存消耗
2、使用步驟
官方Demo裏共有六個工程目錄，分別爲：
(1).DaoCore：庫目錄，即jar文件greendao-1.3.0-beta-1.jar的代碼；
(2).DaoExample：android範例工程；
(3).DaoExampleGenerator：DaoExample工程的DAO類構造器，java工程；
(4).DaoGenerator：DAO類構造器，java工程；
(5).DaoTest、PerformanceTestOrmLite：其餘測試相關的工程。
（一）DAO類構造
首先須要新建一個java工程來生成DAO類文件，該工程須要導入greendao-generator.jar和freemarker.jar文件到項目中。
package de.greenrobot.daogenerator.gentest;
import de.greenrobot.daogenerator.DaoGenerator;
import de.greenrobot.daogenerator.Entity;
import de.greenrobot.daogenerator.Property;
import de.greenrobot.daogenerator.Schema;
import de.greenrobot.daogenerator.ToMany;
/**
* Generates entities and DAOs for the example project DaoExample.
*
* Run it as a Java application (not Android).
*
* @author Markus
*/
public class ExampleDaoGenerator
{
public static void main(String[] args) throws Exception
{
Schema schema = new Schema(3, "de.greenrobot.daoexample");
addNote(schema);
addCustomerOrder(schema);
new DaoGenerator().generateAll(schema, "../DaoExample/src-gen");
}
private static void addNote(Schema schema)
{
Entity note = schema.addEntity("Note");
note.addIdProperty();
note.addStringProperty("text").notNull();
note.addStringProperty("comment");
note.addDateProperty("date");
}
private static void addCustomerOrder(Schema schema)
{
Entity customer = schema.addEntity("Customer");
customer.addIdProperty();
customer.addStringProperty("name").notNull();
Entity order = schema.addEntity("Order");
order.setTableName("ORDERS"); // "ORDER" is a reserved keyword
order.addIdProperty();
Property orderDate = order.addDateProperty("date").getProperty();
Property customerId = order.addLongProperty("customerId").notNull().getProperty();
order.addToOne(customer, customerId);
ToMany customerToOrders = customer.addToMany(order, customerId);
customerToOrders.setName("orders");
customerToOrders.orderAsc(orderDate);
}
}
在main方法中，
Schema schema = new Schema(3, "de.greenrobot.daoexample");
該方法第一個參數用來更新數據庫版本號，第二個參數爲要生成的DAO類所在包路徑。
而後進行建表和設置要生成DAO文件的目標工程的項目路徑。
addNote(schema); addCustomerOrder(schema); new DaoGenerator().generateAll(schema, "../DaoExample/src-gen");
其中src-gen這個目錄名須要在運行前手動建立，不然會報錯。
若是運行後出現如下錯誤，則導入DaoGenerator項目的dao.ftl文件便可(或者直接使用DaoGenerator來生成DAO文件)。
Exception in thread "main" java.io.FileNotFoundException: Template "dao.ftl" not found.
at freemarker.template.Configuration.getTemplate(Configuration.java:742)
at freemarker.template.Configuration.getTemplate(Configuration.java:665)
at de.greenrobot.daogenerator.DaoGenerator.<init>(DaoGenerator.java:68)
at de.greenrobot.daogenerator.gentest.ExampleDaoGenerator.main(ExampleDaoGenerator.java:41)
運行後出現如下的提示說明DAO文件自動生成成功了，刷新一下DaoExample項目便可看到。
greenDAO Generator Copyright 2011-2013 Markus Junginger, greenrobot.de. Licensed under GPL V3. This program comes with ABSOLUTELY NO WARRANTY Processing schema version 3... Written F:\Android_Ex\work_10\DaoExample\src-gen\de\greenrobot\daoexample\NoteDao.java Written F:\Android_Ex\work_10\DaoExample\src-gen\de\greenrobot\daoexample\Note.java Written F:\Android_Ex\work_10\DaoExample\src-gen\de\greenrobot\daoexample\CustomerDao.java Written F:\Android_Ex\work_10\DaoExample\src-gen\de\greenrobot\daoexample\Customer.java Written F:\Android_Ex\work_10\DaoExample\src-gen\de\greenrobot\daoexample\OrderDao.java Written F:\Android_Ex\work_10\DaoExample\src-gen\de\greenrobot\daoexample\Order.java Written F:\Android_Ex\work_10\DaoExample\src-gen\de\greenrobot\daoexample\DaoMaster.java Written F:\Android_Ex\work_10\DaoExample\src-gen\de\greenrobot\daoexample\DaoSession.java Processed 3 entities in 204ms
運行後能夠看到，DaoExample項目src-gen下面自動生成了8個文件，3個實體對象，3個dao，1個DaoMaster,1個DaoSession.
(二)建立表
1.建立一個實體類
Entity note = schema.addEntity("Note");
默認表名就是類名，也能夠自定義表名
dao.setTableName("NoteList");
greenDAO會自動根據實體類屬性建立表字段，並賦予默認值。例如在數據庫方面的表名和列名都來源於實體類名和屬性名。默認的數據庫名稱是大寫使用下劃線分隔單詞，而不是在Java中使用的駝峯式大小寫風格。例如，一個名爲「CREATIONDATE」屬性將成爲一個數據庫列「CREATION_DATE」。
設置一個自增加ID列爲主鍵：
dao.addIdProperty().primaryKey().autoincrement();
設置其餘各類類型的屬性：
dao.addIntProperty("cityId");
dao.addStringProperty("infoType").notNull();//非null字段
dao.addDoubleProperty("Id");
在生成的實體類中,int類型爲自動轉爲long類型。
若是在編譯過程當中出現如下錯誤，那麼有多是主鍵的類型錯誤所致：
java.lang.ClassCastException: java.lang.Integer cannot be cast to java.lang.String
在使用greenDAO時，一個實體類只能對應一個表，目前無法作到一個表對應多個實體類，或者多個表共用一種對象類型。後續的升級也不會針對這一點進行擴展。
(二)表的增刪改查
增刪改查至關方便，徹底的面向對象，不須要涉及到任何的sql語言。
1.查詢
範例1：查詢某個表是否包含某個id:
public boolean isSaved(int ID)
{
QueryBuilder<SaveList> qb = saveListDao.queryBuilder();
qb.where(Properties.Id.eq(ID));
qb.buildCount().count();
return qb.buildCount().count() > 0 ? true : false;
}
範例2：獲取整個表的數據集合,一句代碼就搞定！
public List<PhotoGalleryDB> getPhotoGallery()
{
return photoGalleryDao.loadAll();// 獲取圖片相冊
}
範例3：經過一個字段值查找對應的另外一個字段值(爲簡便直接使用下面方法，也許有更簡單的方法，還沒有嘗試)
/** 經過圖片id查找其目錄id */
public int getTypeId(int picId)
{
QueryBuilder<PhotoGalleryDB> qb = photoGalleryDao.queryBuilder();
qb.where(Properties.Id.eq(picId));
if (qb.list().size() > 0)
{
return qb.list().get(0).getTypeId();
}
else
{
return -1;
}
}
範例4：查找全部第一姓名是「Joe」而且以lastname排序。
List joes = userDao.queryBuilder()
.where(Properties.FirstName.eq("Joe"))
.orderAsc(Properties.LastName)
.list();
範例5：多重條件查詢
(1)獲取id爲cityId而且infotype爲HBContant.CITYINFO_SL的數據集合：
public List<CityInfoDB> getSupportingList(int cityId)
{
QueryBuilder<CityInfoDB> qb = cityInfoDao.queryBuilder();
qb.where(qb.and(Properties.CityId.eq(cityId),Properties.InfoType.eq(HBContant.CITYINFO_SL)));
qb.orderAsc(Properties.Id);// 排序依據
return qb.list();
}
(2)獲取firstname爲「Joe」而且出生於1970年10月之後的全部user集合:
QueryBuilder qb = userDao.queryBuilder();
qb.where(Properties.FirstName.eq("Joe"),
qb.or(Properties.YearOfBirth.gt(1970),
qb.and(Properties.YearOfBirth.eq(1970), Properties.MonthOfBirth.ge(10))));
List youngJoes = qb.list();
範例6：獲取某列對象
picJsonDao.loadByRowId(picId);
2.增添/插入、修改
插入數據更加簡單，也是隻要一句代碼便能搞定!
public void addToPhotoTable(Photo p)
{
photoDao.insert(p);
}
插入時須要new一個新的對象，範例以下:
DevOpenHelper helper = new DaoMaster.DevOpenHelper(this, "notes-db", null); db = helper.getWritableDatabase(); daoMaster = new DaoMaster(db); daoSession = daoMaster.newSession(); noteDao = daoSession.getNoteDao(); Note note = new Note(null, noteText, comment, new Date()); noteDao.insert(note);
修改更新：
photoDao.insertOrReplace(photo); photoDao.insertInTx(photo);
3.刪除:
(1)清空表格數據
/** 清空相冊圖片列表的數據 */
public void clearPhoto()
{
photoDao.deleteAll();
}
(2)刪除某個對象
public void deleteCityInfo(int cityId)
{
QueryBuilder<DBCityInfo> qb = cityInfoDao.queryBuilder();
DeleteQuery<DBCityInfo> bd = qb.where(Properties.CityId.eq(cityId)).buildDelete();
bd.executeDeleteWithoutDetachingEntities();
}
參考：https://github.com/greenrobot/greenDAO/issues/34
由上可見，使用greenDAO進行數據庫的增刪改查時及其方便，並且性能極佳。
(三)經常使用方法筆記
1.在Application實現獲得DaoMaster和DaoSession的方法：
private static DaoMaster daoMaster;
private static DaoSession daoSession;
/**
* 取得DaoMaster
*
* @param context
* @return
*/
public static DaoMaster getDaoMaster(Context context)
{
if (daoMaster == null)
{
OpenHelper helper = new DaoMaster.DevOpenHelper(context, HBContant.DATABASE_NAME, null);
daoMaster = new DaoMaster(helper.getWritableDatabase());
}
return daoMaster;
}
/**
* 取得DaoSession
*
* @param context
* @return
*/
public static DaoSession getDaoSession(Context context)
{
if (daoSession == null)
{
if (daoMaster == null)
{
daoMaster = getDaoMaster(context);
}
daoSession = daoMaster.newSession();
}
return daoSession;
}
2.增刪改查工具類:
public class DBHelper
{
private static Context mContext;
private static DBHelper instance;
private CityInfoDBDao cityInfoDao;
private DBHelper()
{
}
public static DBHelper getInstance(Context context)
{
if (instance == null)
{
instance = new DBHelper();
if (mContext == null)
{
mContext = context;
}
// 數據庫對象
DaoSession daoSession = HBApplication.getDaoSession(mContext);
instance.cityInfoDao = daoSession.getCityInfoDBDao();
}
return instance;
}
/** 添加數據 */
public void addToCityInfoTable(CityInfo item)
{
cityInfoDao.insert(item);
}
/** 查詢 */
public List<EstateLoveListJson> getCityInfoList()
{
QueryBuilder<CityInfo> qb = cityInfoDao.queryBuilder();
return qb.list();
}
/** 查詢 */
public List<CityInfo> getCityInfo()
{
return cityInfoDao.loadAll();// 查找圖片相冊
}
/** 查詢 */
public boolean isSaved(int Id)
{
QueryBuilder<CityInfo> qb = cityInfoDao.queryBuilder();
qb.where(Properties.Id.eq(Id));
qb.buildCount().count();
return qb.buildCount().count() > 0 ? true : false;// 查找收藏表
}
/** 刪除 */
public void deleteCityInfoList(int Id)
{
QueryBuilder<CityInfo> qb = cityInfoDao.queryBuilder();
DeleteQuery<CityInfo> bd = qb.where(Properties.Id.eq(Id)).buildDelete();
bd.executeDeleteWithoutDetachingEntities();
}
/** 刪除 */
public void clearCityInfo()
{
cityInfoDao.deleteAll();
}
/** 經過城市id查找其類型id */
public int getTypeId(int cityId)
{
QueryBuilder<CityInfo> qb = cityInfoDao.queryBuilder();
qb.where(Properties.Id.eq(cityId));
if (qb.list().size() > 0)
{
return qb.list().get(0).getTypeId();
}
else
{
return 0;
}
}
/** 多重查詢 */
public List<CityInfo> getIphRegionList(int cityId)
{
QueryBuilder<CityInfoDB> qb = cityInfoDao.queryBuilder();
qb.where(qb.and(Properties.CityId.eq(cityId), Properties.InfoType.eq(HBContant.CITYINFO_IR)));
qb.orderAsc(Properties.Id);// 排序依據
return qb.list();
}
}
另外，還有多表關聯、惰性加載等功能，待後續研究。
參考資料：
1.https://github.com/greenrobot/greenDAO
2.http://greendao-orm.com/documentation/how-to-get-started/
3.http://blog.csdn.net/krislight/article/details/9391455
4.http://blog.loadlimits.info/2013/01/androidのorm、greendaoを使ってみた/
5.http://leebart.tumblr.com/post/58408230144/how-to-daogenerator
6.http://www.androidanalyse.com/greendao-an-android-orm-for-sqlite/
博客地址:http://glblong.blog.51cto.com/3058613/1354953
- 1. Android 數據庫ORM框架GreenDao學習心得及使用總結
- 2. 【轉載】Android開源：數據庫ORM框架GreenDao學習心得及使用總結
- 3. Android數據庫GreenDao的使用總結
- 4. 數據庫開源框架之GreenDAO
- 5. Android 用於操作SQLite 數據庫的開源框架GreenDao
- 6. Android_開源框架總結（一）：GreenDao
- 7. Android GreenDao數據庫使用
- 8. Android ORM 框架：GreenDao 數據庫升級
- 9. Android數據庫框架之greenDAO
- 10. Android中GreenDao數據庫框架的使用
- 更多相關文章...
- • Docker 資源彙總 - Docker教程
- • XML 總結 下一步學習什麼呢？ - XML 教程
- • Flink 數據傳輸及反壓詳解
- • 適用於PHP初學者的學習線路和建議
-
每一个你不满意的现在，都有一个你没有努力的曾经。
- 1. Android 數據庫ORM框架GreenDao學習心得及使用總結
- 2. 【轉載】Android開源：數據庫ORM框架GreenDao學習心得及使用總結
- 3. Android數據庫GreenDao的使用總結
- 4. 數據庫開源框架之GreenDAO
- 5. Android 用於操作SQLite 數據庫的開源框架GreenDao
- 6. Android_開源框架總結（一）：GreenDao
- 7. Android GreenDao數據庫使用
- 8. Android ORM 框架：GreenDao 數據庫升級
- 9. Android數據庫框架之greenDAO
- 10. Android中GreenDao數據庫框架的使用