GreenDao應用解析

一、概論

GreenDao是一種對象關系映射（ORM）型數據庫，在Android開發中使用較為廣泛，比其他關系映射數據庫性能更加良好。

GreenDao的Github源碼地址：https://github.com/greenrobot/greenDAO

GreenDao的官方地址：http://greenrobot.org/greendao/

Tips：國外網站存在被牆的問題，相信這不會影響大家對實現原理的探究。

二、在Android中配置使用GreenDao

配置GreenDao需要兩個步驟：

通過Java工程生成實體類和相應的管理類；

將第一步生成的實體類和管理類加到Android項目中，就可以使用了。

注意：這兩個步驟，不管使用Eclipse還是Android Studio，都需要加入依賴的jar包。

步驟一用到的jar包，有下邊兩個：

步驟二用到的jar包，是GreenDao.jar

下面詳細介紹兩個步驟：

生成類

Main方法中的代碼：

public static void main(String[] args) throws IOException, Exception {
        Schema schema = new Schema(1, "de.greenrobot.daoexample");  //生成的實體類的目錄

        addSeason(schema);//添加實體類

        addMatchClass(schema); //添加實體類

        new DaoGenerator().generateAll(schema, "D://DaoExamples");//生成的實體類目錄要保存的路徑，也可以是本地途徑，例如“./daoExamples”，就會把生成的內容保存到daoExamples下，目錄結構為de.greenrobot.daoexample。
    }

addSeason(schema)類中的代碼：

private static void addSeason(Schema schema) {
         season = schema.addEntity("Season");
         season.addLongProperty("seasonId").notNull().primaryKey();
         season.addStringProperty("seasonName");
         season.addStringProperty("description");
    }

addMatchClass(schema)類中的代碼：

private static void addMatchClass(Schema schema) {
        matchClass = schema.addEntity("MatchClass");
        matchClass.addLongProperty("classId").notNull().primaryKey();
        matchClass.addStringProperty("className");
        matchClass.addStringProperty("description");

        Property propertySeasonId = matchClass.addLongProperty("seasonId").getProperty();
        matchClass.addToOne(season, propertySeasonId);//將MatchClass的seasonId屬性和Season關聯
    }

在addMatchClass(schema)類中我麼用到了關聯數據庫的基本操作，即：建“外鍵”。

此處使用的是一對一的關聯，還有一對多、多對多的關聯，不過多介紹

使用類

將生成的類加入到Android項目中，加入greendao.jar包後，就可以使用。

DaoMaster.java：持有數據庫對象（SQLiteDatabase）並管理一些DAO類（而不是對象），以靜態方式創建和drop數據庫表。它的內部類OpenHelper和DevOpenHelper是SQLiteOpenHelper的實現類，用於創建SQLite數據庫的模式。

DaoSession.java：管理Dao對象，執行增刪改查這些操作。

Season.java：實體類。

SeasonDao.java：數據訪問對象，用於實體的持久化和查詢。

三、數據庫升級

默認的升級方法會刪除原來所有的表，然後重建。為了避免數據丟失，我們需要對每個表進行手動操作，但是這樣也太麻煩，所以這裡給出一個對數據庫升級的工具類

import android.database.Cursor;
import android.database.sqlite.SQLiteDatabase;
import android.text.TextUtils;
import android.util.Log;

import com.crashlytics.android.Crashlytics;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import de.greenrobot.dao.AbstractDao;
import de.greenrobot.dao.internal.DaoConfig;
import greendao.DaoMaster;


/**
 * Created by pokawa on 18/05/15.
 */
public class MigrationHelper {

    private static final String CONVERSION_CLASS_NOT_FOUND_EXCEPTION = "MIGRATION HELPER - CLASS DOESN'T MATCH WITH THE CURRENT PARAMETERS";
    private static MigrationHelper instance;

    public static MigrationHelper getInstance() {
        if(instance == null) {
            instance = new MigrationHelper();
        }
        return instance;
    }

    public void migrate(SQLiteDatabase db, Class>... daoClasses) {
        generateTempTables(db, daoClasses);//建立臨時數據庫
        DaoMaster.dropAllTables(db, true);//刪除數據庫
        DaoMaster.createAllTables(db, false);//創建新數據庫
        restoreData(db, daoClasses);//將臨時數據庫的數據添加到新數據庫，並將臉是數據庫刪除
    }

    private void generateTempTables(SQLiteDatabase db, Class>... daoClasses) {
        for(int i = 0; i < daoClasses.length; i++) {
            DaoConfig daoConfig = new DaoConfig(db, daoClasses[i]);

            String divider = "";
            String tableName = daoConfig.tablename;
            String tempTableName = daoConfig.tablename.concat("_TEMP");
            ArrayList properties = new ArrayList<>();

            StringBuilder createTableStringBuilder = new StringBuilder();

            createTableStringBuilder.append("CREATE TABLE ").append(tempTableName).append(" (");

            for(int j = 0; j < daoConfig.properties.length; j++) {
                String columnName = daoConfig.properties[j].columnName;

                if(getColumns(db, tableName).contains(columnName)) {
                    properties.add(columnName);

                    String type = null;

                    try {
                        type = getTypeByClass(daoConfig.properties[j].type);
                    } catch (Exception exception) {
                        Crashlytics.logException(exception);
                    }

                    createTableStringBuilder.append(divider).append(columnName).append(" ").append(type);

                    if(daoConfig.properties[j].primaryKey) {
                        createTableStringBuilder.append(" PRIMARY KEY");
                    }

                    divider = ",";
                }
            }
            createTableStringBuilder.append(");");

            db.execSQL(createTableStringBuilder.toString());

            StringBuilder insertTableStringBuilder = new StringBuilder();

            insertTableStringBuilder.append("INSERT INTO ").append(tempTableName).append(" (");
            insertTableStringBuilder.append(TextUtils.join(",", properties));
            insertTableStringBuilder.append(") SELECT ");
            insertTableStringBuilder.append(TextUtils.join(",", properties));
            insertTableStringBuilder.append(" FROM ").append(tableName).append(";");

            db.execSQL(insertTableStringBuilder.toString());
        }
    }

    private void restoreData(SQLiteDatabase db, Class>... daoClasses) {
        for(int i = 0; i < daoClasses.length; i++) {
            DaoConfig daoConfig = new DaoConfig(db, daoClasses[i]);

            String tableName = daoConfig.tablename;
            String tempTableName = daoConfig.tablename.concat("_TEMP");
            ArrayList properties = new ArrayList();

            for (int j = 0; j < daoConfig.properties.length; j++) {
                String columnName = daoConfig.properties[j].columnName;

                if(getColumns(db, tempTableName).contains(columnName)) {
                    properties.add(columnName);
                }
            }

            StringBuilder insertTableStringBuilder = new StringBuilder();

            insertTableStringBuilder.append("INSERT INTO ").append(tableName).append(" (");
            insertTableStringBuilder.append(TextUtils.join(",", properties));
            insertTableStringBuilder.append(") SELECT ");
            insertTableStringBuilder.append(TextUtils.join(",", properties));
            insertTableStringBuilder.append(" FROM ").append(tempTableName).append(";");

            StringBuilder dropTableStringBuilder = new StringBuilder();

            dropTableStringBuilder.append("DROP TABLE ").append(tempTableName);

            db.execSQL(insertTableStringBuilder.toString());
            db.execSQL(dropTableStringBuilder.toString());
        }
    }

    private String getTypeByClass(Class type) throws Exception {
        if(type.equals(String.class)) {
            return "TEXT";
        }
        if(type.equals(Long.class) || type.equals(Integer.class) || type.equals(long.class)) {
            return "INTEGER";
        }
        if(type.equals(Boolean.class)) {
            return "BOOLEAN";
        }

        Exception exception = new Exception(CONVERSION_CLASS_NOT_FOUND_EXCEPTION.concat(" - Class: ").concat(type.toString()));
        Crashlytics.logException(exception);
        throw exception;
    }

    private static List getColumns(SQLiteDatabase db, String tableName) {
        List columns = new ArrayList<>();
        Cursor cursor = null;
        try {
            cursor = db.rawQuery("SELECT * FROM " + tableName + " limit 1", null);
            if (cursor != null) {
                columns = new ArrayList<>(Arrays.asList(cursor.getColumnNames()));
            }
        } catch (Exception e) {
            Log.v(tableName, e.getMessage(), e);
            e.printStackTrace();
        } finally {
            if (cursor != null)
                cursor.close();
        }
        return columns;
    }
}

升級是，在update中添加語句：

 public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
        MyMigrationHelper.getInstance().migrate(db,StudentDao.class,SchoolDao.class);//只有已經存在的表才添加到裡邊，新增的表不用添加
        }