Retrofit 巧妙的回调封装

发表于 | 分类于

Retrofit 回调封装的意义

在 Android 的世界里，可以说 Retrofit 已经一统网络请求的江湖，Retrofit 和 Spring Cloud 中的 Feign 一样都是声明式 REST 请求客户端，都提供了大量注解和完善的 json 对象转换机制，同时不失灵活性。

通常服务端返回都是这种统一格式的对象：

1
2
3
4
5
6
7
public class BaseModel<T> {

    public int code;
    public String message;
    public T data;

}

Android 端拿到这个对象通常要判断 code，然后做对象剥离、token 有效性判断、网络故障处理等，这些如果封装起来统一处理，可以极大简化网络调用。

这里根据实际开发经验，对使用了 Rxjava 的回调和普通回调分别作了封装，实现以上功能。

使用 Rxjava 的回调封装

Retrofit 通过 RxJava2CallAdapter 可以直接将返回结果转换为可观察的对象，拿到 Observable 进行一系列链式处理就方便多了。
比如声明一个 API 调用方法：

1
2
@GET("/userinfo")
Observable<BaseModel<User>> getRxUser();

我们通过一个实现 Observer 接口的抽象类对返回结果进行处理，实现对象剥离、token 有效性判断、网络故障的统一处理。

完整封装代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
public abstract class RxSubscribe<T> implements Observer<BaseModel<T>> {

    public RxSubscribe() {
    }

    protected abstract void onSuccess(T t);

    protected void onFailed(int code, String msg) {
    }

    @Override
    public void onSubscribe(@NonNull Disposable d) {
    }

    @Override
    public void onComplete() {
    }

    @Override
    public void onNext(BaseModel<T> baseModel) {
        if (baseModel.code == 0) {
            onSuccess(baseModel.data);
        } else if (baseModel.code == 3) {
            //比如 做token无效统一处理
            onFailed(baseModel.code, baseModel.message);
        } else {
            onFailed(baseModel.code, baseModel.message);
        }
    }

    @Override
    public void onError(Throwable t) {
        if (t instanceof HttpException) {
            HttpException ex = (HttpException) t;
            onFailed(ex.code(), ex.message());
        } else {
            onFailed(-1, t.getMessage());
        }
    }
}

注意这里使用的是 RxJava2，为使代码更简洁，不强制复写 onSubscribe、onFailed 等方法。

请求回调部分，复写 onSuccess 抽象方法就可以直接拿到剥离后目标对象：

1
2
3
4
5
6
7
8
9
Rest.getRestApi().getRxUser()
    .subscribeOn(Schedulers.io())
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe(new RxSubscribe<User>() {
          @Override
          protected void onSuccess(User user) {
  
          }
    });

还可以复写 onSubscribe 和 onComplete 等方法控制加载中对话框的显示与隐藏。

普通回调的封装

对于普通回调，返回的是 Call 类型，声明一个 API 调用方法：

1
2
@GET("/userinfo")
Call<BaseModel<User>> getUser();

回调封装部分与上面类似，直接上代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
public abstract class BaseBack<T> implements Callback<BaseModel<T>> {

    public BaseBack() {
    }

    protected abstract void onSuccess(T t);

    protected void onFailed(int code, String msg) {
    }

    @Override
    public void onResponse(Call<BaseModel<T>> call, Response<BaseModel<T>> response) {
        BaseModel<T> baseModel = response.body();
        if (response.isSuccessful() && baseModel != null) {
            if (baseModel.code == 0) {
                onSuccess(baseModel.data);
            } else if (baseModel.code == 3) {
                //比如 做token无效统一处理
                onFailed(baseModel.code, baseModel.message);
            } else {
                onFailed(baseModel.code, baseModel.message);
            }
        } else {
            onFailed(response.code(), response.message());
        }
    }

    @Override
    public void onFailure(Call<BaseModel<T>> call, Throwable t) {
        if (t instanceof HttpException) {
            HttpException ex = (HttpException) t;
            onFailed(ex.code(), ex.message());
        } else {
            onFailed(-1, t.getMessage());
        }
    }
}

同样是复写 onSuccess 方法直接拿到剥离后的目标对象:

1
2
3
4
5
6
7
Rest.getRestApi().getUser()
    .enqueue(new BaseBack<User>() {
         @Override
         protected void onSuccess(User user) {
          
         }
});

项目源码

https://github.com/yunTerry/Retrofit-CallBack