本文首发于 vivo互联网技术 微信公众号 
链接： https://mp.weixin.qq.com/s/CL4MsQEsrWS8n7lhXCOQ_g
作者：Li Bingyan

本文主要讲述原生SQLite数据库的一次ORM封装实践，给使用原生数据库操作的业务场景（如：本身是一个SDK）带来一些启示和参考意义，以及跟随框架的实现思路对数据库操作、APT、泛型等概念更深一层的理解。

实现思路：通过动态代理获取请求接口参数进行SQL拼凑，并以接口返回值（泛型）类型的RawType和ActualType来适配调用方式和执行结果，以此将实际SQL操作封装在其内部来简化数据库操作的目的。

一、背景 

毫无疑问，关于Android数据库现在已经有很多流行好用的ORM框架了，比如：Room、GreenDao、DBFlow等都提供了简洁、易用的API，尤其是谷歌开源的Room是目前最主流的框架。

既然已经有了这么多数据库框架了，为什么还要动手封装所谓自己的数据库框架呢？对于普通 APP 的开发确实完全不需要，这些框架中总有一款可以完全满足你日常需求；但如果你是一个SDK开发者，而且业务是一个比较依赖数据库操作的场景，如果限制不能依赖第三方SDK（主要考量维护性、问题排查、稳定性、体积大小），那就不得不自己去写原生SQLite操作了，这将是一个既繁琐又容易出错的过程（数据库升级/降级/打开/关闭、多线程情况、拼凑SQL语句、ContentValues插数据、游标遍历/关闭、Entity转换等）。

为了在SDK的开发场景中避免上述繁琐且容易出错的问题，于是就有了接下来的一系列思考和改造。

二、预期目的

1. 能简化原生的增删改查冗长操作，不要再去写容易出错的中间逻辑步骤
2. 自动生成数据库的建表、升级/降级逻辑
3. 易用的调用接口（支持同步/异步、线程切换）
4. 稳定可靠，无性能问题

三、方案调研

观察我们日常业务代码可以发现：一次数据库查询与一次网络请求在流程上是极为相似的，都是经过构造请求、发起请求、中间步骤、获取结果、处理结果等几个步骤。因此感觉可以将数据库操作以网络请求的方式进行抽象和封装，其详细对比如下表所示：

通过上述相似性的对比并综合现有ORM框架来考虑切入口，首先想到的是使用注解：

主流Room使用的是编译时注解（更有利于性能），但在具体编码实现Processor过程中发现增删改查操作的出参和入参处理有点过于繁琐（参考Room实现），不太适用于本身就是一个SDK的场景，最终pass掉了。

运行时注解处理相对更简单一些（接口和参数较容易适配、处理流程也可以直接写我们熟悉的安卓原生代码），而且前面已经有了大名鼎鼎的网络请求库Retrofit使用运行时注解实现网络请求的典型范例，因此可以依葫芦画瓢尝试实现一下数据库增删改查操作，也是本次改造最终的实现方案。

相信大部分安卓客户端开发同学都用过Retrofit（网络请求常用库），其大概原理是：使用动态代理获取接口对应的Method对象为入口，并通过该Method对象的各种参数（注解修饰）构造出Request对象抛给okhttp做实际请求，返回值则通过Conveter和Adapter适配请求结果（bean对象）和调用方式，如：Call>、Observable>等。

它以这种方式将网络请求的内部细节封装起来，极大简化了网络请求过程。根据其相似性，数据库操作（增删改查）也可以使用这个机制来进一步封装。

对于数据库的建表、升级、降级等这些容易出错的步骤，最好是不要让使用者自己去手动写这部分逻辑，方案使用编译时注解来实现（Entitiy类和字段属性、版本号通过注解对应起来），在编译期间自动生成SQLiteOpenHelper的实现类。

综合以上两部分基本实现了所有痛点操作不再需要调用者去关注（只需关注传参和返回结果），于是将其独立成一个数据库模块，取名Sponsor( [ˈspɑːnsər] )，寓意一种分发器或调度器方案，目前已在团队内部使用。

四、Sponsor调用示例

1、Entity定义：

//Queryable:表示一个可查询的对象，有方法bool convert(Cursor cursor)，将cursor转换为Entitiy
//Insertable:表示一个可插入的对象，有方法ContentValues convert()，将Entitiy转换为ContentValues
public class FooEntity implements Queryable, Insertable {
    
    private int id;

    
    private String fooId;

    
    private String data;
  
    //其他属性
  
   //getter()/setter()
}

2、接口定义，声明增删改查接口：

@Insert(tableName = FooEntity.TABLE)
Call insertEntities(List entities);


@Query("SELECT * FROM " + FooEntity.TABLE + " WHERE " + FooEntity.CREATE_TIME + " > "
        + Parameter1.NAME + " AND " + FooEntity.CREATE_TIME + " < " + Parameter2.NAME
        + " ORDER BY " + FooEntity.CREATE_TIME + " ASC LIMIT " + Parameter3.NAME)
Call> queryEntitiesByRange(@Parameter1 long start, @Parameter2 long end, @Parameter3 int limit);



@Delete(tableName = FooEntity.TABLE, whereClause = FooEntity.ID + " >= "
        + Parameter1.NAME + " AND " + FooEntity.ID + " <= " + Parameter2.NAME)
Call deleteByIdRange(@Parameter1 int startId, @Parameter2 int endId);

3、创建FooService实例：

Sponsor sponsor = new Sponsor.Builder(this)
        .allowMainThreadQueries() //是否运行在主线程操作，默认不允许
        //.addCallAdapterFactory(RxJava2CallAdapterFactory.create()) //rxjava
        //.addCallAdapterFactory(Java8CallAdapterFactory.create()) //java8
        //.addCallAdapterFactory(LiveDataCallAdapterFactory.create()) //livedata
        .logger(new SponsorLogger()) //日志输出
        .build();

//调用create()方法创建FooService实例，实际上是返回了FooService的动态代理对象
FooService mFooService = sponsor.create(FooService.class);

4、插入Entitiy数据：

//构造Entity列表
List entities = new ArrayList<>();
//add entities

//同步方式
//rowId为最终的自增id（同原生insert操作返回值）
//final int rowId = mFooService.insertEntities(entities).execute();

//异步方式
mFooService.insertEntities(entities).enqueue(new Callback() {
    @Override
    public void onResponse(Call call, Integer rowId) {
        //success
    }

    @Override
    public void onFailure(Call call, Throwable t) {
        //failed
    }
});

5、查询参数指定数据库记录，并转换为Entitiy对象列表：

List entities;

//entities为查询结果集合
entities = mFooService.queryEntitiesByRange(1, 200, 100).execute();

6、删除参数指定数据库记录，返回总共删除的记录条数：

//cout为删除的条数
int count = mFooService.deleteByIdRange(0, 100).execute();

注：

1. 以上所有操作都支持根据具体的场景进行同步/异步调用。
2. 增、删、改操作的Call返回值参数（泛型参数）还可以直接指定为Throwable，如果内部异常可以通过它返回，成功则为空

五、核心实现点

基本原理仍是借鉴了Retrofit框架的实现，通过动态代理拿到Method对象的各种参数进行SQL拼凑，并通过Converter和Adapter适配执行结果，整体框架有如下几module构成：

• sponsor:主体实现
• sponsor_annotaiton:注解定义，包括运行时注解和编译时注解
• sponsor_compiler:数据库建表、升级/降级等逻辑的Processor实现
• sponsor_java8、sponsor_livedata、sponsor_rxjava2：适配几种主流的调用方式

1、动态代理入口

public  T create(final Class daoClass, final Class helperClass) {
    final Object obj = Proxy.newProxyInstance(daoClass.getClassLoader(), new Class[]{daoClass},
            new InvocationHandler() {
        @Override
        public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
            if (method.getDeclaringClass() == Object.class) {
                return method.invoke(this, args);
            }
            DaoMethod daoMethod =
                    (DaoMethod) loadDaoMethod(method);

            final DatabaseHelper helper = loadDatabaseHelper(daoClass, helperClass);
            Call