Android ORM 框架之 greenDAO

我相信，在平時的開發過程中，大家一定會或多或少地接觸到 SQLite。然而在使用它時，我們往往需要做許多額外的工作，像編寫 SQL 語句與解析查詢結果等。所以，適用於 Android 的ORM 框架也就孕育而生了，現在市面上主流的框架有 OrmLite、SugarORM、Active Android、Realm 與 GreenDAO。而今天的主角便是 greenDAO，下面，我將詳解地介紹如何在 Android Studio 上使用 greenDAO，並結合代碼總結一些使用過程中的心得。

簡單的講，greenDAO 是一個將對象映射到 SQLite 數據庫中的輕量且快速的 ORM 解決方案。（greenDAO is a light & fast ORM solution that maps objects to SQLite databases.）
而關於 ORM （Object Relation Mapping - 對象關系映射）的概念，可參見 Wikipedia。<喎?/kf/ware/vc/" target="_blank" class="keylink">vcD4NCjxwPkdSRUVOREFPIMnovMa1xNb30qrEv7HqPGJyIC8+DQoxLtK7uPa+q7zytcS/4jwvcD4NCjxwPjIu0NTE3NfutPO7rzwvcD4NCjxwPjMuxNq05r+qz/rX7tChu688L3A+DQo8cD40LtLX09rKudPDtcQgQVBJczwvcD4NCjxwPjUuttQgQW5kcm9pZCC9+NDQuN+2yNPFu688L3A+DQo8cD5HUkVFTkRBTyDJ6LzGtcTW99KqzNi14zxiciAvPg0KMS5ncmVlbkRBTyDQ1MTc1LbUtrjf09rNrMDgtcQgT1JNTGl0ZaOsvt/M5bLiytS94bn7v8m8+7nZzfg8L3A+DQo8cD4yLmdyZWVuREFPINans9YgcHJvdG9jb2wgYnVmZmVyKHByb3RvYnVmKSDQrdLpyv2+3bXE1rG907TmtKKjrMjnufvE482ouf0gcHJvdG9idWYg0K3S6dPrt/7O8cb3vbu7paOsvauyu9Do0qrIzrrOtcTTs8nkoaM8L3A+DQo8cD4zLtPrIE9STUxpdGUgtcjKudPD16K94re9yr21xCBPUk0gv/K83LK7zayjrGdyZWVuREFPIMq508OhuENvZGUgZ2VuZXJhdGlvbqG5tcS3vcq9o6zV4tKyysfG5NDUxNzE3LTzt/nM4cn9tcTUrdLyoaM8L3A+DQo8cD7OqsHL1NrO0sPHtcQgQW5kcm9pZCC5pLPM1tDKudPDIGdyZWVuREFPIKOsztLDx9Do0qrB7b2o0ru49rS/IEphdmEgUHJvamVjdKOs08PT2tfUtq/J+rPJuvO8zCBBbmRyb2lkILmks8zW0NDo0qrKudPDtb21xCBCZWFuoaJEQU+hokRhb01hc3RlcqGiRGFvU2Vzc2lvbiC1yMDgoaM8L3A+DQo8cD652NPa0tTJz7y4uPbA4LXEz+C52LjFxO7T69f308OjrM7SvavU2s/Cw+a1xLT6wuujqNeiys2jqdbQz+rPuL2yveKhozxiciAvPg0KtbHIu6OsxOPSsr/J0tTU2iC52c34INbQ1dK1vc/gudi96cncoaM8L3A+DQo8cD6/qsq8PT09PT09PT09PT09PT09PT09PGJyIC8+DQrSuy4g0MK9qNK7uPZhbmRyb2lkz+7Ev6OsZ3JlZW5EQU8gyfqzybXEIEJlYW6hokRBT6GiRGFvTWFzdGVyoaJEYW9TZXNzaW9uILXIwOC688Pmu+G05tTa1eK49mFuZHJvaWTP7sS/1tChozxiciAvPg0Ktv4uINDCvaihuEdSRUVOREFPIEdFTkVSQVRPUqG5xKO/6SAotL8gSkFWQSC5pLPMo6k8YnIgLz4NCjEuzai5/SBGaWxlIC0mZ3Q7IE5ldyAtJmd0OyBOZXcgTW9kdWxlIC0mZ3Q7IEphdmEgTGlicmFyeSAtJmd0OyDM7tC0z+DTprXEsPzD+9PrwODD+yAtJmd0OyBGaW5pc2guPGJyIC8+DQo8aW1nIGFsdD0="這裡寫圖片描述" src="/uploadfile/Collfiles/20160504/20160504090245271.png" title="\" />

2.編寫 ExampleDaoGenerator 類，注意： 我們的 Java 工程只有一個類，它的內容決定了「GreenDao Generator」的輸出，你可以在這個類中通過對象、關系等創建數據庫結構，下面我將以注釋的形式詳細講解代碼內容。

package com.example;

import de.greenrobot.daogenerator.DaoGenerator;
import de.greenrobot.daogenerator.Entity;
import de.greenrobot.daogenerator.Schema;

public class ExampleDaoGenerator {
    public static void main(String[] args) throws Exception {
        // 正如你所見的，你創建了一個用於添加實體（Entity）的模式（Schema）對象。
        // 兩個參數分別代表：數據庫版本號與自動生成代碼的包路徑。
        Schema schema = new Schema(1, "teach.focus.testgreendao");
//      當然，如果你願意，你也可以分別指定生成的 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);
//        addNotes(schema);
        // 最後我們將使用 DAOGenerator 類的 generateAll() 方法自動生成代碼，此處你需要根據自己的情況更改輸出目錄，目前會在android項目中src/main/java/teach.focus.testgreendao下面生成。
        // 其實，輸出目錄的路徑可以在 build.gradle 中設置，有興趣的朋友可以自行搜索，這裡就不再詳解。
        new DaoGenerator().generateAll(schema, "app/src/main/java");
    }

    /**
     * @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");
    }
    /**
     * @param schema
     */
    private static void addNotes(Schema schema) {
        // 一個實體（類）就關聯到數據庫中的一張表，此處表名為「Note」（既類名）
        Entity note = schema.addEntity("Notes");
        // 你也可以重新給表命名
        // 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");
    }
}

三. 生成 DAO 文件（數據庫）

執行 generator 工程，如一切正常，你將會在控制台看到如下日志，並且在主工程「java-gen」下會發現生成了DaoMaster、DaoSession、NoteDao、Note共4個類文件。

如果在此處出錯，你可以依據錯誤日志進行排查，主要看是否輸出目錄存在?其他配置是否正確?等

四. 在 ANDROID 工程中進行數據庫操作

NoteActivity.java

public class NoteActivity extends ListActivity {
    private SQLiteDatabase db;
    private EditText editText;
    private DaoMaster daoMaster;
    private DaoSession daoSession;
    private Cursor cursor;
    public static final String TAG = "DaoExample";

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_note);
        // 官方推薦將獲取 DaoMaster 對象的方法放到 Application 層，這樣將避免多次創建生成 Session 對象
        setupDatabase();
        // 獲取 NoteDao 對象
        getNoteDao();

        String textColumn = NoteDao.Properties.Text.columnName;
        String orderBy = textColumn + " COLLATE LOCALIZED ASC";
        cursor = db.query(getNoteDao().getTablename(), getNoteDao().getAllColumns(), null, null, null, null, orderBy);
        String[] from = {textColumn, NoteDao.Properties.Comment.columnName};
        int[] to = {android.R.id.text1, android.R.id.text2};

        SimpleCursorAdapter adapter = new SimpleCursorAdapter(this, android.R.layout.simple_list_item_2, cursor, from,
                to);
        setListAdapter(adapter);

        editText = (EditText) findViewById(R.id.editTextNote);
    }

    private void setupDatabase() {
        // 通過 DaoMaster 的內部類 DevOpenHelper，你可以得到一個便利的 SQLiteOpenHelper 對象。
        // 可能你已經注意到了，你並不需要去編寫「CREATE TABLE」這樣的 SQL 語句，因為 greenDAO 已經幫你做了。
        // 注意：默認的 DaoMaster.DevOpenHelper 會在數據庫升級時，刪除所有的表，意味著這將導致數據的丟失。
        // 所以，在正式的項目中，你還應該做一層封裝，來實現數據庫的安全升級。
        DaoMaster.DevOpenHelper helper = new DaoMaster.DevOpenHelper(this, "notes-db", null);
        db = helper.getWritableDatabase();
        // 注意：該數據庫連接屬於 DaoMaster，所以多個 Session 指的是相同的數據庫連接。
        daoMaster = new DaoMaster(db);
        daoSession = daoMaster.newSession();
    }

    private NoteDao getNoteDao() {
        return daoSession.getNoteDao();
    }

    /**
     * Button 點擊的監聽事件
     *
     * @param view
     */
    public void onMyButtonClick(View view) {
        switch (view.getId()) {
            case R.id.buttonAdd:
                addNote();
                break;
            case R.id.buttonSearch:
                search();
                break;
            default:
                Log.d(TAG, "what has gone wrong ?");
                break;
        }
    }

    private void addNote() {
        String noteText = editText.getText().toString();
        editText.setText("");

        final DateFormat df = DateFormat.getDateTimeInstance(DateFormat.MEDIUM, DateFormat.MEDIUM);
        String comment = "Added on " + df.format(new Date());

        // 插入操作，簡單到只要你創建一個 Java 對象
        Note note = new Note(null, noteText, comment, new Date());
        getNoteDao().insert(note);
        Log.d(TAG, "Inserted new note, ID: " + note.getId());
        cursor.requery();
    }

    private void search() {
        // Query 類代表了一個可以被重復執行的查詢
        Query query = getNoteDao().queryBuilder()
                .where(NoteDao.Properties.Text.eq("Test1"))
                .orderAsc(NoteDao.Properties.Date)
                .build();

//      查詢結果以 List 返回
//      List notes = query.list();
        // 在 QueryBuilder 類中內置兩個 Flag 用於方便輸出執行的 SQL 語句與傳遞參數的值
        QueryBuilder.LOG_SQL = true;
        QueryBuilder.LOG_VALUES = true;
    }

    /**
     * ListView 的監聽事件，用於刪除一個 Item
     * @param l
     * @param v
     * @param position
     * @param id
     */
    @Override
    protected void onListItemClick(ListView l, View v, int position, long id) {
        // 刪除操作，你可以通過「id」也可以一次性刪除所有
        getNoteDao().deleteByKey(id);
//        getNoteDao().deleteAll();
        Log.d(TAG, "Deleted note, ID: " + id);
        cursor.requery();
    }
}

五. 運行結果
一切就緒，讓我們看看效果吧！運行程序，分別執行添加按鈕、刪除（點擊 List 的 Item）與查詢按鈕，可以在控制台得到如下日志：