[Android]Android端ORM框架——RapidORM(v1.0)

以下內容為原創，歡迎轉載，轉載請注明

來自天天博客：http://www.cnblogs.com/tiantianbyconan/p/4748077.html 

 

Android上主流的ORM框架有很多，常用的有ORMLite、GreenDao等。

ORMLite：

－優點：API很友好，使用比較方便簡單穩定，相關功能比較完整。

－缺點：內部使用反射實現，性能並不是很好。

GreenDao：

－優點：性能很不錯，

－缺點：API卻不太友好，而且不支持復合主鍵，主鍵必須要有並且必須是long或者Long。持久類可以用它提供的模版生成，但是一旦使用了它的模版，持久類、DAO就不能隨意去修改，擴展性不是很好。如果不使用它的模版，代碼寫起來就很繁瑣。

 

所以結合了兩者重新寫了一個ORM：RapidORM（https://github.com/wangjiegulu/RapidORM）

特點：

1. 支持使用反射和非反射（模版生成）兩種方式實現執行SQL。

2. 支持復合主鍵

3. 支持任何主鍵類型

4. 兼容android原生的 android.database.sqlite.SQLiteDatabase 和SqlCipher的 net.sqlcipher.database.SQLiteDatabase。

缺點：

1. 不支持鏈表查詢。

 

快速指南：

一、新建持久類Person：

/**
 * Author: wangjie
 * Email: [e-mail]
 * Date: 6/25/15.
 */
@Table(propertyClazz = PersonProperty.class)
public class Person implements Serializable{

    @Column(primaryKey = true)
    private Integer id;

    @Column(primaryKey = true)
    private Integer typeId;

    @Column
    private String name;

    @Column
    private Integer age;

    @Column
    private String address;

    @Column
    private Long birth;

    @Column
    private Boolean student;

    // getter/setter...

}

 

1. Table注解用於標記這個類需要映射到數據表，RapidORM會創建這個表。

－name屬性：表示對應表的名稱，默認為類的simpleName。

－propertyClazz屬性：表示如果不使用反射執行sql時，需要的ModelProperty類的Class，RapidORM會自動在這個ModelProperty中去綁定需要執行SQL的數據。不填寫則表示使用默認的反射的方式執行SQL。具體后面會講到。

2. Column注解用語標記這個字段映射到的數據表的列（如果）。

－name屬性：表示對應列的名稱。默認為字段的名稱。

－primaryKey屬性：表示改列是否是主鍵，默認是false。（可以在多個字段都適用這個屬性，表示為復合主鍵）。

－autoincrement屬性：表示主鍵是否是自增長，只有該字段是主鍵並且只有一個主鍵並且是Integer或int類型才會生效。

－defaultValue屬性：表示該列默認值。

－notNull屬性：表示該列不能為空。

－unique屬性：表示該列唯一約束。

－uniqueCombo屬性：暫未實現。

－index屬性：暫未實現。

 

二、注冊持久類，並指定SQLiteOpenHelper：

新建類DatabaseFactory，繼承RapidORMConnection：

/**
 * Author: wangjie
 * Email: [e-mail]
 * Date: 6/25/15.
 */
public class DatabaseFactory extends RapidORMConnection<RapidORMDefaultSQLiteOpenHelperDelegate> {
    private static final int VERSION = 1;

    private static DatabaseFactory instance;

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

    private DatabaseFactory() {
        super();
    }

    @Override
    protected RapidORMDefaultSQLiteOpenHelperDelegate getRapidORMDatabaseOpenHelper(@NonNull String databaseName) {
        return new RapidORMDefaultSQLiteOpenHelperDelegate(new MyDatabaseOpenHelper(MyApplication.getInstance(), databaseName, VERSION));
    }

    @Override
    protected List<Class<?>> registerAllTableClass() {
        List<Class<?>> allTableClass = new ArrayList<>();
        allTableClass.add(Person.class);
        // all table class
        return allTableClass;
    }
}

DatabaseFactory推薦使用單例，實現RapidORMConnection的getRapidORMDatabaseOpenHelper()方法，該方法需要返回一個RapidORMDatabaseOpenHelperDelegate或者它的子類對象，RapidORMDatabaseOpenHelperDelegate是SQLiteOpenHelper的委托，因為需要兼容android原生的 android.database.sqlite.SQLiteDatabase 和SqlCipher的 net.sqlcipher.database.SQLiteDatabase 兩種方式。

如果使用 android.database.sqlite.SQLiteDatabase ，則可以使用RapidORMDefaultSQLiteOpenHelperDelegate，然后構造方法中傳入真正的android.database.sqlite.SQLiteDatabase （也就是這里的MyDatabaseOpenHelper）即可，使用SqlCipher的方式后面再講。

還需要實現registerAllTableClass()方法，這里返回一個所有需要映射表的持久類Class集合。

 

三、在需要的地方進行初始化RapidORM（比如在登錄完成之后）：

DatabaseFactory.getInstance().resetDatabase("hello_rapid_orm.db");

如上，調用resetDatabase()方法即可初始化數據庫。

 

四、編寫Dao：

新建PersonDaoImpl繼承BaseDaoImpl<Person>（這里簡略了PersonDao接口）：

/**
 * Author: wangjie
 * Email: [e-mail]
 * Date: 6/26/15.
 */
public class PersonDaoImpl extends BaseDaoImpl<Person> {
    public PersonDaoImpl() {
        super(Person.class);
    }

}

BaseDaoImpl中默認實現了下面的基本方法（T為范型，指具體的持久類）：

－void insert(T model) throws Exception;　　// 插入一條數據。

－void update(T model) throws Exception;　　// 更新一條數據。

－void delete(T model) throws Exception;　　// 刪除一條數據。

－void deleteAll() throws Exception;　　　　　　// 刪除表中所有的數據

－void insertOrReplace(T model) throws Exception;　　　　// 刪除或者替換（暫不支持）

－List<T> queryAll() throws Exception;　　　　　　// 查詢表中所有數據

－List<T> rawQuery(String sql, String[] selectionArgs) throws Exception;　　　　　　// 使用原生sql查詢表中所有的數據

－void rawExecute(String sql, Object[] bindArgs) throws Exception;　　　　　　　　// 使用原生sql執行一條sql語句

－void insertInTx(T... models) throws Exception;　　　　　　　　　　// 插入多條數據（在一個事務中）

－void insertInTx(Iterable<T> models) throws Exception;　　　　　　// 同上

－void updateInTx(T... models) throws Exception;　　　　　　　　　　// 更新多條數據（在一個事務中）

－void updateInTx(Iterable<T> models) throws Exception;　　　　　　// 同上

－void deleteInTx(T... models) throws Exception;　　　　　　　　　　　　// 刪除多條數據（在一個事務中）

－void deleteInTx(Iterable<T> models) throws Exception;　　　　　　　　// 同上

－void executeInTx(RapidORMSQLiteDatabaseDelegate db, RapidOrmFunc1 func1) throws Exception; // 執行一個方法（可多個sql），在一個事務中

－void executeInTx(RapidOrmFunc1 func1) throws Exception;　　　　// 同上

 

面向對象的方式使用Where和Builder來構建sql語句：

1. Where：

Where表示一系列的條件語句，含義與SQL中的where關鍵字一致。

支持的where操作：

－eq(String column, Object value)　　　　// 相等條件判斷

－ne(String column, Object value)　　　　// 不相等條件判斷

－gt(String column, Object value)　　　　 // 大於條件判斷

－lt(String column, Object value)　　　　　// 小於條件判斷

－ge(String column, Object value)　　　　 // 大於等於條件

－le(String column, Object value)　　　　　// 小於等於條件

－in(String column, Object... values)　　　 // 包含條件

－ni(String column, Object... values)　　　 // 不包含條件

－isNull(String column)　　　　　　　　　　// null條件判斷

－notNull(String column)　　　　　　　　　// 不為null條件判斷

－between(String column, Object value1, Object value2)　　// BETWEEN ... AND ..." condition

－like(String column, Object value)　　　　　　// 模糊匹配條件

－Where raw(String rawWhere, Object... values)　　// 原生sql條件

－and(Where... wheres)　　　　　　　　　　// 多個Where與

－or(Where... wheres)　　　　　　　　　　// 多個Where或

 

Where舉例：

    Where.and(
                Where.like(PersonProperty.name.column, "%wangjie%"),
                Where.lt(PersonProperty.id.column, 200),
                Where.or(
                        Where.between(PersonProperty.age.column, 19, 39),
                        Where.isNull(PersonProperty.address.column)
                ),
                Where.eq(PersonProperty.typeId.column, 1)
        )

如上，

Line2條件：name模糊匹配wangjie

Line3條件：id小於200

Line5條件：age在19到39之間

Line6條件：address不是null

Line8條件：typeId等於1

Line4條件：Line5條件和Line6條件是or關系；

Line1條件：Line2、Line3、Line4、Line8條件是and關系。

 

2. QueryBuilder：

QueryBuilder用於構建查詢語句。

－setWhere(Where where)　　　　// 設置Where條件；

－setLimit(Integer limit)　　　　　　// 設置limit

－addSelectColumn(String... selectColumn)　　　　// 設置查詢的數據列名（可以調用多遍來設置多個，默認是查詢所有數據）

－addOrder(String column, boolean isAsc)　　　　　// 設置查詢結果的排序（可以調用多遍來設置多個）

 

QueryBuilder舉例：

    public List<Person> findPersonsByWhere() throws Exception {
        return queryBuilder()
                .addSelectColumn(PersonProperty.id.column, PersonProperty.typeId.column, PersonProperty.name.column,
                        PersonProperty.age.column, PersonProperty.birth.column, PersonProperty.address.column)
                .setWhere(Where.and(
                        Where.like(PersonProperty.name.column, "%wangjie%"),
                        Where.lt(PersonProperty.id.column, 200),
                        Where.or(
                                Where.between(PersonProperty.age.column, 19, 39),
                                Where.isNull(PersonProperty.address.column)
                        ),
                        Where.eq(PersonProperty.typeId.column, 1)
                ))
                .addOrder(PersonProperty.id.column, false)
                .addOrder(PersonProperty.name.column, true)
                .setLimit(10)
                .query(this);
    }

如上，通過queryBuilder()方法構建一個QueryBuilder，並設置查詢的列名、Where、排序、limit等參數，最后調用query()執行查詢。

 

3. UpdateBuilder：

UpdateBuilder用於構建更新語句。

－setWhere(Where where)　　　　// 設置Where條件；

－addUpdateColumn(String column, Object value)　　　　// 添加需要更新的字段；

 

UpdateBuilder舉例：

    public void updatePerson() throws Exception {
        long now = System.currentTimeMillis();
        updateBuilder()
                .setWhere(Where.and(
                        Where.like(PersonProperty.name.column, "%wangjie%"),
                        Where.lt(PersonProperty.id.column, 200),
                        Where.or(
                                Where.between(PersonProperty.age.column, 19, 39),
                                Where.isNull(PersonProperty.address.column)
                        ),
                        Where.eq(PersonProperty.typeId.column, 1)
                ))
                .addUpdateColumn(PersonProperty.birth.column, now)
                .addUpdateColumn(PersonProperty.address.column, "address_" + now).update(this);
    }

如上，通過updateBuilder()方法構建一個UpdateBuilder，並設置要更新的字段，最后調用update()執行查詢。

 

4. DeleteBuilder： 

DeleteBuilder用於構建刪除語句。

－setWhere(Where where)　　　　// 設置Where條件；

 

DeleteBuilder舉例：

    public void deletePerson() throws Exception {
        deleteBuilder()
                .setWhere(Where.and(
                        Where.like(PersonProperty.name.column, "%wangjie%"),
                        Where.lt(PersonProperty.id.column, 200),
                        Where.or(
                                Where.between(PersonProperty.age.column, 19, 39),
                                Where.isNull(PersonProperty.address.column)
                        ),
                        Where.eq(PersonProperty.typeId.column, 1)
                ))
                .delete(this);
    }

如上，通過deleteBuilder()方法構建一個DeleteBuilder，並設置Where條件，最后調用delete()執行查詢。

 

使用模版生成ModelProperty：

如果你打算使用非反射的方式執行sql，則可以使用ModelPropertyGenerator模版來生成

1. 新建一個類，在main方法中執行：

/**
 * Author: wangjie
 * Email: [e-mail]
 * Date: 7/2/15.
 */
public class MyGenerator {
    public static void main(String[] args) throws Exception {

        Class tableClazz = Person.class;
        new ModelPropertyGenerator().generate(tableClazz,
                "example/src/main/java",
                tableClazz.getPackage().getName() + ".config");

    }

}

如上，generate()方法參數如下：

generate(Class tableClazz, String outerDir, String packageName)

參數一：要生成的Property持久類的Class

參數二：生成的ModelProperty類文件存放目錄

參數三：生成的ModelProperty類文件的包名

執行完畢后，就會在com.wangjie.rapidorm.example.database.model.config包下生成如下的ModelProperty：

// THIS CODE IS GENERATED BY RapidORM, DO NOT EDIT.
/**
* Property of Person
*/
public class PersonProperty implements IModelProperty<Person> {

    public static final ModelFieldMapper id = new ModelFieldMapper(0, "id", "id");
    public static final ModelFieldMapper typeId = new ModelFieldMapper(1, "typeId", "typeId");
    public static final ModelFieldMapper name = new ModelFieldMapper(2, "name", "name");
    public static final ModelFieldMapper age = new ModelFieldMapper(3, "age", "age");
    public static final ModelFieldMapper address = new ModelFieldMapper(4, "address", "address");
    public static final ModelFieldMapper birth = new ModelFieldMapper(5, "birth", "birth");
    public static final ModelFieldMapper student = new ModelFieldMapper(6, "student", "student");

    public PersonProperty() {
    }


    @Override
    public void bindInsertArgs(Person model, List<Object> insertArgs) {
        Integer id = model.getId();
        insertArgs.add(null == id ? null : id);

        Integer typeId = model.getTypeId();
        insertArgs.add(null == typeId ? null : typeId);

        String name = model.getName();
        insertArgs.add(null == name ? null : name);

        Integer age = model.getAge();
        insertArgs.add(null == age ? null : age);

        String address = model.getAddress();
        insertArgs.add(null == address ? null : address);

        Long birth = model.getBirth();
        insertArgs.add(null == birth ? null : birth);

        Boolean student = model.isStudent();
        insertArgs.add(null == student ? null : student ? 1 : 0);

    }

    @Override
    public void bindUpdateArgs(Person model, List<Object> updateArgs) {
        String name = model.getName();
        updateArgs.add(null == name ? null : name);

        Integer age = model.getAge();
        updateArgs.add(null == age ? null : age);

        String address = model.getAddress();
        updateArgs.add(null == address ? null : address);

        Long birth = model.getBirth();
        updateArgs.add(null == birth ? null : birth);

        Boolean student = model.isStudent();
        updateArgs.add(null == student ? null : student ? 1 : 0);

    }

    @Override
    public void bindPkArgs(Person model, List<Object> pkArgs) {
        Integer id = model.getId();
        pkArgs.add(null == id ? null : id);

        Integer typeId = model.getTypeId();
        pkArgs.add(null == typeId ? null : typeId);

    }

    @Override
    public Person parseFromCursor(Cursor cursor) {
        Person model = new Person();
        int index;
        index = cursor.getColumnIndex("id");
        if(-1 != index){
            model.setId(cursor.isNull(index) ? null : (cursor.getInt(index)));
        }

        index = cursor.getColumnIndex("typeId");
        if(-1 != index){
            model.setTypeId(cursor.isNull(index) ? null : (cursor.getInt(index)));
        }

        index = cursor.getColumnIndex("name");
        if(-1 != index){
            model.setName(cursor.isNull(index) ? null : (cursor.getString(index)));
        }

        index = cursor.getColumnIndex("age");
        if(-1 != index){
            model.setAge(cursor.isNull(index) ? null : (cursor.getInt(index)));
        }

        index = cursor.getColumnIndex("address");
        if(-1 != index){
            model.setAddress(cursor.isNull(index) ? null : (cursor.getString(index)));
        }

        index = cursor.getColumnIndex("birth");
        if(-1 != index){
            model.setBirth(cursor.isNull(index) ? null : (cursor.getLong(index)));
        }

        index = cursor.getColumnIndex("student");
        if(-1 != index){
            model.setStudent(cursor.isNull(index) ? null : (cursor.getInt(index) == 1));
        }

        return model;
    }

}

注意：此Property類一旦生成，則不能修改；如果該持久類相關的注解屬性改變，則需要重新生成這個Property類。

2. 在相應的持久類的@Table注解中設置propertyClazz：

@Table(propertyClazz = PersonProperty.class)
public class Person implements Serializable{

 

如何兼容SqlCipher

1. 新建MySQLCipherOpenHelper，繼承net.sqlcipher.database.SQLiteOpenHelper：

import android.content.Context;
import com.wangjie.rapidorm.core.dao.DatabaseProcessor;
import com.wangjie.rapidorm.core.delegate.database.RapidORMSQLiteDatabaseDelegate;
import net.sqlcipher.database.SQLiteDatabase;
import net.sqlcipher.database.SQLiteDatabaseHook;
import net.sqlcipher.database.SQLiteOpenHelper;

/**
 * Author: wangjie
 * Email: [e-mail]
 * Date: 8/17/15.
 */
public class MySQLCipherOpenHelper extends SQLiteOpenHelper {

    private RapidORMSQLiteDatabaseDelegate rapidORMSQLiteDatabaseDelegate;

    public MySQLCipherOpenHelper(Context context, String name, int version) {
        super(context, name, null, version);
    }

    public MySQLCipherOpenHelper(Context context, String name, SQLiteDatabase.CursorFactory factory, int version) {
        super(context, name, factory, version);
    }

    public MySQLCipherOpenHelper(Context context, String name, SQLiteDatabase.CursorFactory factory, int version, SQLiteDatabaseHook hook) {
        super(context, name, factory, version, hook);
    }

    @Override
    public void onCreate(SQLiteDatabase db) {
//        super.onCreate(db);
        rapidORMSQLiteDatabaseDelegate = new MySQLCipherDatabaseDelegate(db);
        DatabaseProcessor databaseProcessor = DatabaseProcessor.getInstance();
        for (Class<?> tableClazz : databaseProcessor.getAllTableClass()) {
            databaseProcessor.createTable(rapidORMSQLiteDatabaseDelegate, tableClazz, true);
        }
    }

    @Override
    public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
//        super.onUpgrade(db, oldVersion, newVersion);
        rapidORMSQLiteDatabaseDelegate = new MySQLCipherDatabaseDelegate(db);
        DatabaseProcessor databaseProcessor = DatabaseProcessor.getInstance();
        // todo: dev only!!!!!
        databaseProcessor.dropAllTable(rapidORMSQLiteDatabaseDelegate);

    }
}

 

2. 新建MySQLCipherDatabaseDelegate繼承RapidORMSQLiteDatabaseDelegate，並實現以下的方法：

import android.database.Cursor;
import android.database.SQLException;
import com.wangjie.rapidorm.core.delegate.database.RapidORMSQLiteDatabaseDelegate;
import net.sqlcipher.database.SQLiteDatabase;

/**
 * Author: wangjie
 * Email: [e-mail]
 * Date: 8/17/15.
 */
public class MySQLCipherDatabaseDelegate extends RapidORMSQLiteDatabaseDelegate<SQLiteDatabase> {
    public MySQLCipherDatabaseDelegate(SQLiteDatabase db) {
        super(db);
    }

    @Override
    public void execSQL(String sql) throws SQLException {
        db.execSQL(sql);
    }

    @Override
    public boolean isDbLockedByCurrentThread() {
        return db.isDbLockedByCurrentThread();
    }

    @Override
    public void execSQL(String sql, Object[] bindArgs) throws Exception {
        db.execSQL(sql, bindArgs);
    }

    @Override
    public Cursor rawQuery(String sql, String[] selectionArgs) {
        return db.rawQuery(sql, selectionArgs);
    }

    @Override
    public void beginTransaction() {
        db.beginTransaction();
    }

    @Override
    public void setTransactionSuccessful() {
        db.setTransactionSuccessful();
    }

    @Override
    public void endTransaction() {
        db.endTransaction();
    }

    @Override
    public void close() {
        db.close();
    }
}

注意這里的import，這里的SQLiteDatabase需要導入 net.sqlcipher.database.SQLiteDatabase 。

 

3. 新建MySQLCipherOpenHelperDelegate繼承RapidORMDatabaseOpenHelperDelegate，實現如下方法：

import com.wangjie.rapidorm.core.delegate.openhelper.RapidORMDatabaseOpenHelperDelegate;
 3 
/**
 * Author: wangjie
 * Email: [e-mail]
 * Date: 6/18/15.
 */
public class MySQLCipherOpenHelperDelegate extends RapidORMDatabaseOpenHelperDelegate<MySQLCipherOpenHelper, MySQLCipherOpenHelperDelegate> {
    public MySQLCipherOpenHelperDelegate(MySQLCipherOpenHelper sqLiteOpenHelper) {
        super(sqLiteOpenHelper);
    }

    public static final String SECRET_KEY = "1234567890abcdef";

    @Override
    public MySQLCipherOpenHelperDelegate getReadableDatabase() {
        return new MySQLCipherDatabaseDelegate(openHelper.getReadableDatabase(SECRET_KEY));
    }

    @Override
    public MySQLCipherOpenHelperDelegate getWritableDatabase() {
        return new MySQLCipherDatabaseDelegate(openHelper.getWritableDatabase(SECRET_KEY));
    }

}

 

4. 在DatabaseFactory中使用SqlCipher版本：

/**
 * Author: wangjie
 * Email: [e-mail]
 * Date: 6/25/15.
 */
public class DatabaseFactory extends RapidORMConnection<MySQLCipherOpenHelperDelegate> {
    private static final int VERSION = 1;

    private static DatabaseFactory instance;

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

    private DatabaseFactory() {
        super();
    }

    @Override
    protected MySQLCipherOpenHelperDelegate getRapidORMDatabaseOpenHelper(@NonNull String databaseName) {
        return new MySQLCipherOpenHelperDelegate(new MySQLCipherOpenHelper(applicationContext, databaseName, VERSION));
    }

    @Override
    protected List<Class<?>> registerAllTableClass() {
        List<Class<?>> allTableClass = new ArrayList<>();
        allTableClass.add(Person.class);
        // register all table class here...
        return allTableClass;
    }
}