碼上歡樂
相關內容    簡體    繁體

Android 數據庫ORM框架GreenDao學習心得及使用總結<一>

本文轉載自   查看原文   2015-03-25 09:40   4012    Android_NB封裝庫

轉：

http://www.it165.net/pro/html/201401/9026.html

 

  • 最近在對開發項目的性能進行優化。由於項目里涉及了大量的緩存處理和數據庫運用，需要對數據庫進行頻繁的讀寫、查詢等操作。因此首先想到了對整個項目的數據庫框架進行優化。

    原先使用android本身內置的sqllite，也就是用的最基本的SQLiteOpenHelper方法，這種方法對自己來說比較方便易懂。但是在使用過程中感覺很繁瑣，從建表到對表的增刪改查等操作，如果表對象的屬性很多，就需要使用大量的代碼來執行建表、插入等。在代碼執行中還需要對數據庫和游標的進行及時關閉(開啟使用，用完關閉)，而且還需要部分sql語言，這在開發中產生bug進行調試時尤其不方便。

    目前android經常用的orm框架主要有greenDAO、OrmLite、AndrORM。 綜合了網上的各種評價，greenDAO的運行效率最高，內存消耗最少，性能最佳。因此決定采用greenDAO框架，對項目的orm框架進行改進。

    wKioL1LjvcbQqp7UAALzTaGquzw329.jpg

    greenDAO與ORMLite性能對比

     

    經過兩天的修改，終於將項目里的數據庫相關的都優化完了。在這過程中，發現greenDAO的性能確實不錯，而且使用相當方便，不再需要涉及到任何的sql語言，可以直接通過對象類進行建表、增刪改查等，尤其是api接口又方便易懂。在摸索學習中發現國內相關學習資料實在實在是太少，遂決定在此記錄下自己對使用這個orm框架的一些心得和方法總結。

     

    一、greenDAO相關

    1.greenDAO官網：http://greendao-orm.com/

    2.項目下載地址：https://github.com/greenrobot/greenDAO（或者官網）

    greenDAO是一個可以幫助Android開發者快速將Java對象映射到SQLite數據庫的表單中的ORM解決方案，通過使用一個簡單的面向對象API，開發者可以對Java對象進行存儲、更新、刪除和查詢。

    greenDAO的主要設計目標：

    *最大性能（最快的Android ORM）

    *易於使用API

    *高度優化

    *最小內存消耗

    二、使用步驟

    官方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文件到項目中。

     

    01. package de.greenrobot.daogenerator.gentest;
    02. import de.greenrobot.daogenerator.DaoGenerator;
    03. import de.greenrobot.daogenerator.Entity;
    04. import de.greenrobot.daogenerator.Property;
    05. import de.greenrobot.daogenerator.Schema;
    06. import de.greenrobot.daogenerator.ToMany;
    07. /**
    08. * Generates entities and DAOs for the example project DaoExample.
    09. *
    10. * Run it as a Java application (not Android).
    11. *
    12. * @author Markus
    13. */
    14. public class ExampleDaoGenerator
    15. {
    16.  
    17. public static void main(String[] args) throws Exception
    18. {
    19. Schema schema = new Schema(3, "de.greenrobot.daoexample");
    20.  
    21. addNote(schema);
    22. addCustomerOrder(schema);
    23.  
    24. new DaoGenerator().generateAll(schema, "../DaoExample/src-gen");
    25. }
    26.  
    27. private static void addNote(Schema schema)
    28. {
    29. Entity note = schema.addEntity("Note");
    30. note.addIdProperty();
    31. note.addStringProperty("text").notNull();
    32. note.addStringProperty("comment");
    33. note.addDateProperty("date");
    34. }
    35.  
    36. private static void addCustomerOrder(Schema schema)
    37. {
    38. Entity customer = schema.addEntity("Customer");
    39. customer.addIdProperty();
    40. customer.addStringProperty("name").notNull();
    41.  
    42. Entity order = schema.addEntity("Order");
    43. order.setTableName("ORDERS"); // "ORDER" is a reserved key<a href="http://www.it165.net/edu/ebg/" target="_blank" class="keylink">word</a>
    44. order.addIdProperty();
    45. Property orderDate = order.addDateProperty("date").getProperty();
    46. Property customerId = order.addLongProperty("customerId").notNull().getProperty();
    47. order.addToOne(customer, customerId);
    48.  
    49. ToMany customerToOrders = customer.addToMany(order, customerId);
    50. customerToOrders.setName("orders");
    51. customerToOrders.orderAsc(orderDate);
    52. }
    53.  
    54. }

     

    在main方法中，

     

    1. 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文件)。

     

    1. Exception in thread "main" java.io.FileNotFoundException: Template "dao.ftl" not found.
    2. at freemarker.template.Configuration.getTemplate(Configuration.java:742)
    3. at freemarker.template.Configuration.getTemplate(Configuration.java:665)
    4. at de.greenrobot.daogenerator.DaoGenerator.<init>(DaoGenerator.java:68)
    5. at de.greenrobot.daogenerator.gentest.ExampleDaoGenerator.main(ExampleDaoGenerator.java:41)

     

    運行后出現以下的提示說明DAO文件自動生成成功了，刷新一下DaoExample項目即可看到。

     

    01. greenDAO Generator
    02. Copyright 2011-2013 Markus Junginger, greenrobot.de. Licensed under GPL V3.
    03. This program comes with ABSOLUTELY NO WARRANTY
    04. Processing schema version 3...
    05. Written F:\Android_Ex\work_10\DaoExample\src-gen\de\greenrobot\daoexample\NoteDao.java
    06. Written F:\Android_Ex\work_10\DaoExample\src-gen\de\greenrobot\daoexample\Note.java
    07. Written F:\Android_Ex\work_10\DaoExample\src-gen\de\greenrobot\daoexample\CustomerDao.java
    08. Written F:\Android_Ex\work_10\DaoExample\src-gen\de\greenrobot\daoexample\Customer.java
    09. Written F:\Android_Ex\work_10\DaoExample\src-gen\de\greenrobot\daoexample\OrderDao.java
    10. Written F:\Android_Ex\work_10\DaoExample\src-gen\de\greenrobot\daoexample\Order.java
    11. Written F:\Android_Ex\work_10\DaoExample\src-gen\de\greenrobot\daoexample\DaoMaster.java
    12. Written F:\Android_Ex\work_10\DaoExample\src-gen\de\greenrobot\daoexample\DaoSession.java
    13. Processed 3 entities in 204ms

     

    運行后可以看到，DaoExample項目src-gen下面自動生成了8個文件，3個實體對象，3個dao，1個DaoMaster,1個DaoSession.

     

    (二)創建表

    1.創建一個實體類

     

    Entity note = schema.addEntity("Note");

    默認表名就是類名，也可以自定義表名

     

    1. dao.setTableName("NoteList");

    greenDAO會自動根據實體類屬性創建表字段，並賦予默認值。例如在數據庫方面的表名和列名都來源於實體類名和屬性名。默認的數據庫名稱是大寫使用下划線分隔單詞，而不是在Java中使用的駝峰式大小寫風格。例如，一個名為“CREATIONDATE”屬性將成為一個數據庫列“CREATION_DATE”。

     

    設置一個自增長ID列為主鍵：

     

    1. dao.addIdProperty().primaryKey().autoincrement();

     

    設置其他各種類型的屬性：

     

    dao.addIntProperty("cityId");
dao.addStringProperty("infoType").notNull();//非null字段
dao.addDoubleProperty("Id");

    在生成的實體類中,int類型為自動轉為long類型。

    如果在編譯過程中出現以下錯誤，那么有可能是主鍵的類型錯誤所致：

    1. java.lang.ClassCastException: java.lang.Integer cannot be cast to java.lang.String

     

    在使用greenDAO時，一個實體類只能對應一個表，目前沒法做到一個表對應多個實體類，或者多個表共用一種對象類型。后續的升級也不會針對這一點進行擴展。

     

    (二)表的增刪改查

    增刪改查相當方便，完全的面向對象，不需要涉及到任何的sql語言。

    1.查詢

    范例1：查詢某個表是否包含某個id:

     

    1. public boolean isSaved(int ID)
    2. {
    3. QueryBuilder<SaveList> qb = saveListDao.queryBuilder();
    4. qb.where(Properties.Id.eq(ID));
    5. qb.buildCount().count();
    6. return qb.buildCount().count() > 0 ? true : false;
    7. }

     

    范例2：獲取整個表的數據集合,一句代碼就搞定！

     

    public List<PhotoGalleryDB> getPhotoGallery()
{
    return photoGalleryDao.loadAll();// 獲取圖片相冊
}

     

    范例3：通過一個字段值查找對應的另一個字段值(為簡便直接使用下面方法，也許有更簡單的方法，尚未嘗試)

     

     

    01. /** 通過圖片id查找其目錄id */
    02. public int getTypeId(int picId)
    03. {
    04. QueryBuilder<PhotoGalleryDB> qb = photoGalleryDao.queryBuilder();
    05. qb.where(Properties.Id.eq(picId));
    06. if (qb.list().size() > 0)
    07. {
    08. return qb.list().get(0).getTypeId();
    09. }
    10. else
    11. {
    12. return -1;
    13. }
    14. }

     

    范例4：查找所有第一姓名是“Joe”並且以lastname排序。

     

    1. List joes = userDao.queryBuilder()
    2. .where(Properties.FirstName.eq("Joe"))
    3. .orderAsc(Properties.LastName)
    4. .list();

     

    范例5：多重條件查詢

    (1)獲取id為cityId並且infotype為HBContant.CITYINFO_SL的數據集合：

     

     

    1. public List<CityInfoDB> getSupportingList(int cityId)
    2. {
    3. QueryBuilder<CityInfoDB> qb = cityInfoDao.queryBuilder();
    4. qb.where(qb.and(Properties.CityId.eq(cityId),Properties.InfoType.eq(HBContant.CITYINFO_SL)));
    5. qb.orderAsc(Properties.Id);// 排序依據
    6. return qb.list();
    7. }

     

    (2)獲取firstname為“Joe”並且出生於1970年10月以后的所有user集合:

     

    1. QueryBuilder qb = userDao.queryBuilder();
    2. qb.where(Properties.FirstName.eq("Joe"),
    3. qb.or(Properties.YearOfBirth.gt(1970),
    4. qb.and(Properties.YearOfBirth.eq(1970), Properties.MonthOfBirth.ge(10))));
    5. List youngJoes = qb.list();

     

    范例6：獲取某列對象

    1. picJsonDao.loadByRowId(picId);

     

     

    2.增添/插入、修改

    插入數據更加簡單，也是只要一句代碼便能搞定!

     

    1. public void addToPhotoTable(Photo p)
    2. {
    3. photoDao.insert(p);
    4. }

     

    插入時需要new一個新的對象，范例如下:

     

    1. DevOpenHelper helper = new DaoMaster.DevOpenHelper(this, "notes-db", null);
    2. db = helper.getWritableDatabase();
    3. daoMaster = new DaoMaster(db);
    4. daoSession = daoMaster.newSession();
    5. noteDao = daoSession.getNoteDao();
    6. Note note = new Note(null, noteText, comment, new Date());
    7. noteDao.insert(note);

     

    修改更新：

    1. photoDao.insertOrReplace(photo);
    2. photoDao.insertInTx(photo);

     

    3.刪除:

    (1)清空表格數據

     

    1. /** 清空相冊圖片列表的數據 */
    2. public void clearPhoto()
    3. {
    4. photoDao.deleteAll();
    5. }

     

    (2)刪除某個對象

    1. public void deleteCityInfo(int cityId)
    2. {
    3. QueryBuilder<DBCityInfo> qb = cityInfoDao.queryBuilder();
    4. DeleteQuery<DBCityInfo> bd = qb.where(Properties.CityId.eq(cityId)).buildDelete();
    5. bd.executeDeleteWithoutDetachingEntities();
    6. }

     

    參考：https://github.com/greenrobot/greenDAO/issues/34

     

    由上可見，使用greenDAO進行數據庫的增刪改查時及其方便，而且性能極佳。

     

    (三)常用方法筆記

    1.在Application實現得到DaoMaster和DaoSession的方法：

     

    01. private static DaoMaster daoMaster;
    02. private static DaoSession daoSession;
    03. /**
    04. * 取得DaoMaster
    05. *
    06. * @param context
    07. * @return
    08. */
    09. public static DaoMaster getDaoMaster(Context context)
    10. {
    11. if (daoMaster == null)
    12. {
    13. OpenHelper helper = new DaoMaster.DevOpenHelper(context, HBContant.DATABASE_NAME, null);
    14. daoMaster = new DaoMaster(helper.getWritableDatabase());
    15. }
    16. return daoMaster;
    17. }
    18. /**
    19. * 取得DaoSession
    20. *
    21. * @param context
    22. * @return
    23. */
    24. public static DaoSession getDaoSession(Context context)
    25. {
    26. if (daoSession == null)
    27. {
    28. if (daoMaster == null)
    29. {
    30. daoMaster = getDaoMaster(context);
    31. }
    32. daoSession = daoMaster.newSession();
    33. }
    34. return daoSession;
    35. }

     

    2.增刪改查工具類:

    01. public class DBHelper
    02. {
    03. private static Context mContext;
    04. private static DBHelper instance;
    05.  
    06. private CityInfoDBDao cityInfoDao;
    07.  
    08. private DBHelper()
    09. {
    10. }
    11.  
    12. public static DBHelper getInstance(Context context)
    13. {
    14. if (instance == null)
    15. {
    16. instance = new DBHelper();
    17. if (mContext == null)
    18. {
    19. mContext = context;
    20. }
    21.  
    22. // 數據庫對象
    23. DaoSession daoSession = HBApplication.getDaoSession(mContext);
    24. instance.cityInfoDao = daoSession.getCityInfoDBDao();
    25. }
    26. return instance;
    27. }
    28.  
    29. /** 添加數據 */
    30. public void addToCityInfoTable(CityInfo item)
    31. {
    32. cityInfoDao.insert(item);
    33. }
    34.  
    35. /** 查詢 */
    36. public List<EstateLoveListJson> getCityInfoList()
    37. {
    38. QueryBuilder<CityInfo> qb = cityInfoDao.queryBuilder();
    39. return qb.list();
    40. }
    41.  
    42. /** 查詢 */
    43. public List<CityInfo> getCityInfo()
    44. {
    45. return cityInfoDao.loadAll();// 查找圖片相冊
    46. }
    47.  
    48. /** 查詢 */
    49. public boolean isSaved(int Id)
    50. {
    51. QueryBuilder<CityInfo> qb = cityInfoDao.queryBuilder();
    52. qb.where(Properties.Id.eq(Id));
    53. qb.buildCount().count();
    54. return qb.buildCount().count() > 0 ? true : false;// 查找收藏表
    55. }
    56.  
    57. /** 刪除 */
    58. public void deleteCityInfoList(int Id)
    59. {
    60. QueryBuilder<CityInfo> qb = cityInfoDao.queryBuilder();
    61. DeleteQuery<CityInfo> bd = qb.where(Properties.Id.eq(Id)).buildDelete();
    62. bd.executeDeleteWithoutDetachingEntities();
    63. }
    64.  
    65. /** 刪除 */
    66. public void clearCityInfo()
    67. {
    68. cityInfoDao.deleteAll();
    69. }
    70.  
    71. /** 通過城市id查找其類型id */
    72. public int getTypeId(int cityId)
    73. {
    74. QueryBuilder<CityInfo> qb = cityInfoDao.queryBuilder();
    75. qb.where(Properties.Id.eq(cityId));
    76. if (qb.list().size() > 0)
    77. {
    78. return qb.list().get(0).getTypeId();
    79. }
    80. else
    81. {
    82. return 0;
    83. }
    84. }
    85.  
    86. /** 多重查詢 */
    87. public List<CityInfo> getIphRegionList(int cityId)
    88. {
    89. QueryBuilder<CityInfoDB> qb = cityInfoDao.queryBuilder();
    90. qb.where(qb.and(Properties.CityId.eq(cityId), Properties.InfoType.eq(HBContant.CITYINFO_IR)));
    91. qb.orderAsc(Properties.Id);// 排序依據
    92. return qb.list();
    93. }
    94. }

     

     

    另外，還有多表關聯、惰性加載等功能，待后續研究。

    參考資料：

    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


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 Android ORM 框架之 greenDAO 使用心得 Android數據庫GreenDao的使用總結 數據庫的學習心得 ORM數據庫框架 greenDAO SQLite MD Android數據庫框架-----GreenDao3的相關使用和版本升級更新 android_orm框架之greenDAO(二) android_orm框架之greenDAO（一） Android_數據庫_Room_GreenDao的基本使用 Android數據庫GreenDao使用說明 Android之greenDao,一個orm的使用
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM