[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: tiantian.china.2@gmail.com
 * 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: tiantian.china.2@gmail.com
 * 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: tiantian.china.2@gmail.com
 * 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: tiantian.china.2@gmail.com
 * 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: tiantian.china.2@gmail.com
 * 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: tiantian.china.2@gmail.com
 * 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: tiantian.china.2@gmail.com
 * 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: tiantian.china.2@gmail.com
 * 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;
    }
}