GreenDAO簡介

Android本身自帶的SQLite，大家一定都用過，然而在使用它時，我們往往需要做許多額外的工作，像編寫 SQL 語句與解析查詢結果等。所以，適用於 Android 的ORM框架也就孕育而生了，現在市面上主流的框架有 OrmLite、SugarORM、Active Android、Realm 與 GreenDAO。簡單的講，greenDAO 是一個將對象映射到 SQLite 數據庫中的輕量且快速的 ORM 解決方案。

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

 

一、 在 ANDROID 工程中配置「GREENDAO GENERATOR」模塊

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

 

 

2、配置 Android 工程（app）的 build.gradle，如圖分別添加sourceSets與dependencies。

 

二. 新建「GREENDAO GENERATOR」模塊 (純 JAVA 工程）

1、通過 File -> New -> New Module -> Java Library -> 填寫相應的包名與類名 -> Finish

 

2、配置 daogenerator 工程的 build.gradle，添加 dependencies.

 

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

 

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

public class DaoExampleGenerator {
public static void main(String[] args) throws Exception {
// 正如你所見的，你創建了一個用於添加實體（Entity）的模式（Schema）對象。
// 兩個參數分別代表：數據庫版本號與自動生成代碼的包路徑。
Schema schema = new Schema(1, "com.example.greendao");
//當然，如果你願意，你也可以分別指定生成的 Bean 與 DAO 類所在的目錄，只要如下所示：
//Schema schema = new Schema(1, "com.example.bean");
//schema.setDefaultJavaPackageDao("com.example.dao");

// 模式（Schema）同時也擁有兩個默認的 flags，分別用來標示 entity 是否是 activie 以及是否使用 keep sections。
// schema2.enableActiveEntitiesByDefault();
// schema2.enableKeepSectionsByDefault();

// 一旦你擁有了一個 Schema 對象後，你便可以使用它添加實體（Entities）了。
addTables(schema);

// 最後我們將使用 DAOGenerator 類的 generateAll() 方法自動生成代碼，此處你需要根據自己的情況更改輸出目錄（既之前創建的 java-gen)。
// 其實，輸出目錄的路徑可以在 build.gradle 中設置，有興趣的朋友可以自行搜索，這裡就不再詳解。
new DaoGenerator().generateAll(schema, "../GreenDAO/app/src/main/java-gen");
}

/**
* @param schema
*/
private static void addTables(Schema schema) {
// 一個實體（類）就關聯到數據庫中的一張表，此處表名為「User」（既類名）
Entity user = schema.addEntity("User");
// 你也可以重新給表命名
// user.setTableName("USER");

// greenDAO 會自動根據實體類的屬性值來創建表字段，並賦予默認值
// 實體類有多種屬性字段，自然也有多個方法，可以自己看看，接下來你便可以設置表中的字段：
user.addIdProperty();
user.addStringProperty("name").notNull();
// 與在 Java 中使用駝峰命名法不同，默認數據庫中的命名是使用大寫和下劃線來分割單詞的。
// For example, a property called “creationDate” will become a database column “CREATION_DATE”.
user.addDateProperty("birthday");

//我們是可以創建多個表的，只要再重新創建一個實體類即可
// Entity user1 = schema.addEntity("User1");
// user1.addIdProperty();
// user.addStringProperty("name").notNull();
}
}

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

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

 

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

 

 

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

 

官方推薦將獲取DaoMaster對象的方法放到Application層，這樣將避免多次創建生成Session對象，我們寫一個Application類

 

public class DaoApplication extends Application {
private static DaoApplication instance;
public static DaoApplication getInstance() {
return instance;
}
private DaoMaster.DevOpenHelper helper;
private SQLiteDatabase db;
private DaoMaster daoMaster;
private DaoSession daoSession;
private UserDao userDao;

@Override
public void onCreate() {
super.onCreate();
instance = this;
setupDatabase();
}

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

public DaoSession getDaoSession() {
return daoSession;
}
public UserDao getUserDao() {
return userDao;
}
public SQLiteDatabase getDb() {
return db;
}
}

下面簡單寫個例子，實現一些基本操作，布局如下：

 

 

    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical">

            android:id="@+id/linearLayout1"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:orientation="horizontal">

                    android:id="@+id/et_main_user"
            android:layout_width="0dp"
            android:layout_height="wrap_content"
            android:layout_weight="1"
            android:hint="Enter new user"
            android:inputType="text"/>

                    android:id="@+id/btn_main_add"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:onClick="onMyButtonClick"
            android:text="Add"/>

                    android:id="@+id/btn_main_search"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:onClick="onMyButtonClick"
            android:text="Search"/>
    

            android:id="@+id/lv_main_content"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"/>

MainActivity如下：

 

 

public class MainActivity extends AppCompatActivity {
    private EditText mEditText;
    private ListView mListView;
    private Cursor mCursor;
    private DaoApplication instance;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        mEditText = (EditText) findViewById(R.id.et_main_user);
        mListView = (ListView) findViewById(R.id.lv_main_content);
        instance = DaoApplication.getInstance();
        String nameColumn = UserDao.Properties.Name.columnName;
        String birthColumn = UserDao.Properties.Birthday.columnName;
        mCursor = instance.getDb().query(instance.getUserDao().getTablename(),
                instance.getUserDao().getAllColumns(), null, null, null, null, null);
        String[] from = {nameColumn, birthColumn};
        int[] to = {android.R.id.text1, android.R.id.text2};

        SimpleCursorAdapter adapter = new SimpleCursorAdapter(this, android.R.layout.simple_list_item_2, mCursor, from,
                to, CursorAdapter.FLAG_REGISTER_CONTENT_OBSERVER);
        mListView.setAdapter(adapter);
        mListView.setOnItemLongClickListener(new AdapterView.OnItemLongClickListener() {
            @Override
            public boolean onItemLongClick(AdapterView adapterView, View view, int i, long l) {
                // 刪除操作，你可以通過「id」也可以一次性刪除所有
                instance.getUserDao().deleteByKey(l);
//        instance.getUserDao().deleteAll();
                mCursor.requery();
                return true;
            }
        });
    }

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

    private void addUser() {
        String str = mEditText.getText().toString();
        mEditText.setText("");
        final DateFormat df = DateFormat.getDateTimeInstance(DateFormat.MEDIUM, DateFormat.MEDIUM);
        String birthday = df.format(new Date());

        // 插入操作，簡單到只要你創建一個 Java 對象
        User user = new User(null, str, new Date(), "f");
        instance.getUserDao().insert(user);
        mCursor.requery();
    }

    private void search() {
        // Query 類代表了一個可以被重復執行的查詢
        String str = mEditText.getText().toString();
        Query query = instance.getUserDao().queryBuilder()
                .where(UserDao.Properties.Name.eq(str))
                .orderAsc(UserDao.Properties.Birthday)
                .build();
//      查詢結果以 List 返回
        List list = query.list();
        Toast.makeText(MainActivity.this, "長度為" + list.size(), Toast.LENGTH_SHORT).show();
        // 在 QueryBuilder 類中內置兩個 Flag 用於方便輸出執行的 SQL 語句與傳遞參數的值
        QueryBuilder.LOG_SQL = true;
        QueryBuilder.LOG_VALUES = true;
    }


}

效果如下：

 

 

當然這是最簡單的一些介紹，更深層次的挖掘還得需要各位共同努力了，如有不當之處，請不吝賜教