Android ORM 架構之 greenDAO

From:http://blog.csdn.net/kpioneer123/article/details/51354436

GreenDao是一個用於Android開發的對象/關係映射(ORM)工具。它向SQLite資料庫提供了一個對象導向的介面。像GreenDao這樣的ORM工具不僅為你省去了很多的重複工作，而且提供了更簡便的操作介面。 greenDAO 代碼產生的工程結構圖

GREENDAO 設計的主要目標

一個精簡的庫

效能最大化

記憶體開銷最小化

便於使用的 APIs

對 Android 進行高度最佳化 GREENDAO 設計的主要特點

greenDAO 效能遠遠高於同類的 ORMLite。

greenDAO 支援 protocol buffer(protobuf) 協議資料的直接儲存，如果你通過 protobuf 協議與伺服器互動，將不需要任何的映射。

與 ORMLite 等使用註解方式的 ORM 架構不同，greenDAO 使用「Code generation」的方式，這也是其效能能大幅提升的原因。 DAO CODE GENERATION PROJECT

這是其核心概念：為了在我們的 Android 工程中使用 greenDAO ，我們需要另建一個純 Java Project，用於自動產生後繼 Android 工程中需要使用到的 Bean、DAO、DaoMaster、DaoSession 等類。

為了在你的Android項目中使用GreenDao，你需要建立一個二級工程：“generator project”，它的任務就是為你的domain產生具體的代碼。這個產生器工程就是一個普通的java工程。確保greenDao 的greenDao-generator.jar和 freemarker.jar 在classpath中。建立一個可執行檔java類，構建你的實體模型並觸發代碼產生器，更多細節，可以參看 modelling文檔。

核心類

一旦產生了指定的代碼，就可以在你的android工程中使用greenDao了。別忘記在你的android工程中引入greenDao的核心jar包：greenDao.jar。以下是GreenDao的一些必要介面。

DaoMaster：

daomaster以一定的模式持有資料庫物件（SQLiteDatabase）並管理一些DAO類（而不是對象）。

有一個靜態方法建立和drop資料庫表。它的內部類OpenHelper和DevOpenHelper是SQLiteOpenHelper的實作類別，用於建立SQLite資料庫的模式。

DaoSession：

管理指定模式下所有可用的DAO對象，你可以通過某個get方法擷取到。DaoSession提供一些通用的持久化方法，比如對實體進行插入，載入，更新，重新整理和刪除。最後DaoSession對象會跟蹤identity scope，更多細節，可以參看 session文檔。

DAOs（Data access objects）:

Data Access Objects，用於實體的持久化和查詢。對於每一個實體，greenDao會產生一個DAO，相對於DaoSession它擁有更多持久化的方法，比如：載入全部，插入（insertInTx，語境不明了，暫且簡單的翻譯成插入）。

具體操作步驟：

Step1：在 ANDROID 工程中配置「GREENDAO GENERATOR」模組

1.在 .src/main 目錄下建立一個與 java 同層級的「java-gen」目錄，用於存放由 greenDAO 產生的 Bean、DAO、DaoMaster、DaoSession 等類。

   new->Directory  (mingjava-gen)

2.配置 Android 工程（app）的 build.gradle，在android{}結構體中分別添加 sourceSets 與dependencies。 

[java] view plain copy sourceSets {          main {              java.srcDirs = ['src/main/java', 'src/main/java-gen']          }      }      compile 'org.greenrobot:greendao:2.2.0'  
Step2： 建立「GREENDAO GENERATOR」模組 (純 JAVA 工程） 1.通過 File -> New -> New Module -> Java Library -> 填寫相應的包名與類名 -> Finish.


通過這種方式產生的Module結構(我起名為greendao_generator )與一般情況不同
2.配置greendao_generator 工程的 build.gradle，添加 dependencies. [java] view plain copy compile 'org.greenrobot:greendao-generator:2.2.0'  
3.編寫 MyClass類，注意： 我們的 Java 工程只有一個類，它的內容決定了「GreenDao Generator」的輸出，你可以在這個類中通過對象、關係等建立資料庫結構，下面我將以注釋的形式詳細講解代碼內容。 [java] view plain copy package com.example;      import de.greenrobot.daogenerator.DaoGenerator;   import de.greenrobot.daogenerator.Entity;   import de.greenrobot.daogenerator.Schema;      public class MyClass{          public static void main(String[] args) throws Exception {           // 正如你所見的，你建立了一個用於添加實體（Entity）的模式（Schema）對象。           // 兩個參數分別代表：資料庫版本號碼與自動產生代碼的包路徑。           Schema schema = new Schema(1, "com.xionghu.greendao");   //      當然，如果你願意，你也可以分別指定產生的 Bean 與 DAO 類所在的目錄，只要如下所示：   //      Schema schema = new Schema(1, "me.itangqi.bean");   //      schema.setDefaultJavaPackageDao("me.itangqi.dao");              // 模式（Schema）同時也擁有兩個預設的 flags，分別用來標示 entity 是否是 activie 以及是否使用 keep sections。           // schema2.enableActiveEntitiesByDefault();           // schema2.enableKeepSectionsByDefault();              // 一旦你擁有了一個 Schema 對象後，你便可以使用它添加實體（Entities）了。           addNote(schema);              // 最後我們將使用 DAOGenerator 類的 generateAll() 方法自動產生代碼，此處你需要根據自己的情況更改輸出目錄（既之前建立的 java-gen)。           // 其實，輸出目錄的路徑可以在 build.gradle 中設定，有興趣的朋友可以自行搜尋，這裡就不再詳解。           new DaoGenerator().generateAll(schema, "D:\\android_studio_4_6\\MyGreenDAO\\app\\src\\main\\java-gen");       }          /**       * @param schema       */       private static void addNote(Schema schema) {           // 一個實體（類）就關聯到資料庫中的一張表，此處表名為「Note」（既類名）           Entity note = schema.addEntity("Note");           // 你也可以重新給表命名           // note.setTableName("NODE");              // greenDAO 會自動根據實體類的屬性值來建立表欄位，並賦予預設值           // 接下來你便可以設定表中的欄位：           note.addIdProperty();           note.addStringProperty("text").notNull();           // 與在 Java 中使用駝峰命名法不同，預設資料庫中的命名是使用大寫和底線來分割單詞的。           // For example, a property called “creationDate” will become a database column “CREATION_DATE”.           note.addStringProperty("comment");           note.addDateProperty("date");       }      }  
Step3： 產生 DAO 檔案（資料庫） 執行 generator 工程，如一切正常，你將會在控制台看到如下日誌，並且在主工程「java-gen」下會發現產生了DaoMaster、DaoSession、NoteDao、Note共4個類檔案。 在這裡需要對運行條件進行配置Android Studio 運行java程式