本文已授权微信公众号:鸿洋(hongyangAndroid)在微信公众号平台原创首发。
###绪论
前面我们讨论了使用Retrofit时怎样去设置OKHttp,包括持久化管理Cookie、设置网络超时、设置打印拦截器、设置缓存、Header等等,详细可查看
Retrofit–使用Retrofit时怎样去设置OKHttp
Retrofit+OKHttp 教你怎么持久化管理Cookie
今天我们讨论的主题是怎么封装回调才能完美的适应自己的需求。我们都知道代码风格是每个人都有自己的风格,不可能完全一样,那么我们写出来的代码怎样能够尽可能的去满足需求呢?换句话说怎样才能设计出高可用、高解耦、高可维护的代码架构呢?其实本人也是渣渣一个,看了一些别人的代码再加上自己的理解,今天把自己在用Retrofit时的一些想法分享给大家。
###封装背景:
在开始用Retrofit的时候在网上一搜,搜出来好多教程,而且口碑很好,所以我打算新的项目由原来的Xutils框架转战Retrofit。
Retrofit和Java领域的ORM概念类似, ORM把结构化数据转换为Java对象,而Retrofit 把REST API返回的数据转化为Java对象方便操作。同时还封装了网络代码的调用。
看了一些资料后大致了解到,Retrofit 2.0利用注解的形式将我们访问服务器的URL以及参数封装成了java对象,而OKHttp依旧去执行网络请求。现在网上的教程一般都告诉我们了怎样去使用Retrofit(随意找了一个教程):
1.首先定义一个接口:
1 | public interface APIService { |
2.接着通过Retrofit.Builder()去创建这个url以及参数
1 | Retrofit retrofit = new Retrofit.Builder() |
3.最后通过定义Call
1 | Call<User> call = apiService.getUser(username); |
然后我们就能在网络请求成功失败的回调出去更新UI了。
###自定义响应体CallModel
很简单的实现了一个网络请求,当然我在刚开始的时候一直也都是这么使用的,因为Retrofit自己封装了JSON解析的过程,我们只需在建造Retrofit的时候加入addConverterFactory(GsonConverterFactory.create())
就可以了,但是得保证我们定义的API接口的时候Call
我们都知道服务器返回的结果一般都是下面这种格式的:
一定是有code状态码和返回信息的,我之前的用法和教程一样,说将服务器返回的结果复制下来直接在AS上面利用GsonFormat转化就OK了,确实很方便,但是这样下来每个bean里面都会有重复的erroe_code和message或者服务器返回其他,所以我是这样做的:
1 | public class BaseCallModel<T> { |
定义一个BaseCallModel,利用泛型去适合服务器返回的所有的bean,而你在定义一个API接口的时候就可以这样定义:
1 | @GET("user/login") |
###自定义CallBack
自定义完响应体之后,那么问题又来了,error_code会有不同的值,而不同的值需要我们所做的操作不同,举个例子,我们的需求是
- 0-请求成功
- 1-请求失败,登录过期
- 2-请求失败,无权限
- 3-请求失败-余额不足
- ….
假如登录过期需要我们重新登录,跳转到登录界面的话,我们不可能在每个网络请求的回调里面都去判断error_code吧?那样岂不是很….,所以就有了它:
1 |
|
我自定义了一个抽象类实现了Retrofit的CallBack<>,OnResponse()方法里面去判断网络请求正常的各种情况,onFailure()方法里面则是网络有问题会走该回调。而OnResponse()回调中也有可能网络请求失败,根据response.raw().code()去判断;然后你也可以根据异常出现的状况去执行不同的UI,例如:
1 | if(t instanceof SocketTimeoutException){ |
好了这样用起来就很爽了,如果有不合适不妥当的地方,还希望大家多多指教,共同进步。
最后分享几个不错的Retrofit博客吧:
你真的会用Retrofit2吗?Retrofit2完全教程
深入浅出 Retrofit,这么牛逼的框架你们还不来看看?
Android Retrofit 2.0 使用-补充篇