Android网络开源库-Retrofit(五)简易封装

   2016-10-04 0
核心提示:1.前言Rrtrofit的扩展性很强,如果对retrofit不熟悉的话,是很难应对各种各样的需求的。因此,在这里,做一下简单的封装。主要为了下面三点需求:使用简单加密处理错误处理2.怎样才能简单使用为了简单粗暴,我做了以下工作。使用单例Retrofit引入RxJava在这里

1.前言

Rrtrofit的扩展性很强,如果对retrofit不熟悉的话,是很难应对各种各样的需求的。因此,在这里,做一下简单的封装。主要为了下面三点需求:

  1. 使用简单
  2. 加密处理
  3. 错误处理

2.怎样才能简单使用

为了简单粗暴,我做了以下工作。

  • 使用单例Retrofit
  • 引入RxJava

在这里,如何Retrofit单例化,就不多说了,大致代码如下:

Retrofit.Builder builder = new Retrofit.Builder()                       .addCallAdapterFactory(RxJavaCallAdapterFactory.create())              .addConverterFactory(SecurityGsonConverterFactory.create())
.baseUrl("xxx");
client = new OkHttpClient().newBuilder()
        .addNetworkInterceptor(new HttpLoggingInterceptor()
        .setLevel(HttpLoggingInterceptor.Level.BODY))
        .addNetworkInterceptor(new StethoInterceptor())
        .addInterceptor(new SecurityInterceptor(context))
        .retryOnConnectionFailure(true)
        // TODO: 2016/8/24 缓存、cookie等
        .connectTimeout(5_000, TimeUnit.MILLISECONDS)
        .readTimeout(5_000, TimeUnit.MILLISECONDS)
        .build();
retrofit = builder.client(client).build();

其中的SecurityInterceptor和SecurityGsonConverterFactory,在稍后会说。

我们来看下引入RxJava之后代码如何编写。以一个获取用户信息为例。

Api

@FormUrlEncoded
    @POST("v1/api.user.profile.get")
    Observable<UserResponse> get(
            @Field("uid") String uid
    );

首先,我们需要ServiceApi对象,在这里进行一次简单封装,如下:

public static <T> T createApi(Class<T> clz) {
        return (T) retrofit.create(clz);
    }

在需要的地方,一般是model里,在构造函数中,我们初始化。

this.userApi = RetrofitClient.createApi(UserApi.class);

接下来就是->Observable

Observable<UserResponse> observable = userApi.get(params[0]);

接着便是,Subscriber,因为这里我对Subscriber也进行了封装,但是我们这里先暂时不管。先看下代码

NormalSubscriber<UserResponse> subscriber = new NormalSubscriber<UserResponse>(context) {
            @Override
            public void onNext(UserResponse userResponse) {

               response.onSuccess(userResponse, UserModel.class, ApiHelper.userApi.GET);
            }
        };

,需要额外说明的是,HttpResponse,是封装的一个接口。

public interface HttpResponse {
    <T>void onSuccess(T response, Class<?> clz,String methodName);
    void on
Error(Throwable t);
}

,最后,进行订阅操作

CoreUtil.subscribe(observable, subscriber);

这个对应的详细代码为:

public static <T> void subscribe(Observable<T> observable, Subscriber<T> subscriber) {
        observable
                .subscribeOn(Schedulers.io())
                .unsubscribeOn(Schedulers.io())
                .observeOn(AndroidSchedulers.mainThread())
                .subscribe(subscriber);
    }

这么依赖,过程就非常简单了。

  1. 首先在model的构造函数中create serviceApi,
  2. 进行网络请求

而网络请求的代码,经过稍微的封装就变为以下伪代码。

Observable<FriendApplyListResponse> observable = friendApi.applylist();
NormalSubscriber<FriendApplyListResponse> subscriber = new NormalSubscriber<FriendApplyListResponse>(context) {
            @Override
            public void onNext(FriendApplyListResponse friendListResponse) {
                response.onSuccess(friendListResponse,FriendModel.class,ApiHelper.friendApi.APPLYLIST);
            }
        };
        CoreUtil.subscribe(observable,subscriber);

因为,我这里还是传统mvc,因此,在onSuccess里,需要以下内容,Response,Model.class,接口名称。这样,在Activity里才好区分。

3.如何进行加密解密

说道这里,上面提到过的SecurityGsonConverterFactory,SecurityInterceptor就祈祷作用了。先说加密:

3.1 加密

在SecurityInterceptor的intercept方法当中,相关代码如下:

Request request = chain.request();
        RequestBody oldBody = request.body();
        Buffer buffer = new Buffer();
        oldBody.writeTo(buffer);
        StringBuffer stringBuffer = new StringBuffer();
        String s;
        while ((s = buffer.readUtf8Line()) != null) {
            stringBuffer.append(s);
        }
        StringBuilder newString = encrypt(stringBuffer.toString().trim());

上诉encrypt 方法就是进行参数加密的,各位可以根据自己公司的需求进行编写。

然后。进行重组即可

RequestBody body = RequestBody.create(mediaType, newString);
        request = request.newBuilder()
                .header("Content-Type", body.contentType().toString())
                .header("Content-Length", String.valueOf(body.contentLength()))
                .header("Authorization", SESSION.getInstance().getToken())
                .header("UserAgent", "Platform/Android, Device/" + model + ", Lang/" + UserAgent.getInstance().lang + ", ScreenWidth/" + UserAgent.getInstance().width + ", ScreenHeight/" + UserAgent.getInstance().height)
                .header("UDID", UserAgent.getInstance().UDID)
                .header("Ver", UserAgent.getInstance().ver)
                .header("Sign", signString)
                .method(request.method(), body)
                .build();
        Response response = chain.proceed(request);

大致过程就是这样,这样,我们就完成了参数加密的过程。

3.1 解密

这涉及到了SecurityGsonConverterFactory,这个和GsonConverterFactory的区别之处就在于SecurityGsonResponseBodyCoverter,在这个类的convert方法中,进行解密。

String encryptString = value.string();
        JSONObject jsonObject = null;
        try {
             jsonObject = new JSONObject(encryptString.trim());
            String decrypt_data = XXTEA.decryptBase64StringToString(jsonObject.optString("data"), UserAppConst.AppDataKey);

            jsonObject = new JSONObject(decrypt_data);
        } catch (JSONException e) {
            e.printStackTrace();
        }
        JsonReader jsonReader = gson.newJsonReader(new StringReader(jsonObject.toString()));
        try {
            return adapter.read(jsonReader);

        }finally {
            value.close();
        }

当然,上面对应的服务器返回数据应该是这样的:

//伪数据啊  json格式的
{
    success:xxx
    error_code:xxx
    data:{
        xxx
    }

}

在这里,我有一点建议。就是我们前面对应的UserResponse应该是data里的数据,当然,data里也可以放error数据,比如说什么Token失效了等等,但是,这个时候要求返回http code 400,为什么呢?这样方便我们做错误处理。

4.错误处理

我们这里的错误处理就在上面提到过得NormalSubscriber里。我们来看看。我们在on Error里做处理,需要说明的是,on Error里,有两种情况会调用on Error

  • 出现异常
  • 服务器不是200-299相应吗(ps:猜测,知道的朋友告诉下,因为业务小的关系,没遇到过)
public void on
Error(Throwable e) {
        // TODO: 2016/9/2 添加其他异常判断
        if (e instanceof ConnectException) {
            ToastUtil.toastShow(mContext, e.getLocalizedMessage());
            return;
        }
        //当然这里还有其他异常,比如说SocketTimeoutException,MalformedJsonException,IllegalStateException等等。这些异常是代码引起的异常,我们需要了解另一种异常。HttpException,这个异常很重要,这是我们错误处理的关键,比如说我们token过期了,在服务器返回的数据里面,data里应该是tiken无效,并且 http code应该是400,bad request。
                       String errorJson = ((HttpException) e).response().errorBody().string();
                JSONObject jsonObject = new JSONObject(errorJson);
                String errorMessage = jsonObject.optString("data");
//这里的errorMessage应该就是错误原因了。我们可以根据这个或者,error_code进行对应的处理
}

5.总结

上面的这种方法,解决了我们公司 目前项目的绝大部分问题。相信对你们应该也是有用的,了解一下吧。

 
标签: Retrofit 开源
反对 0举报 0 评论 0
 

免责声明:本文仅代表作者个人观点,与乐学笔记(本网)无关。其原创性以及文中陈述文字和内容未经本站证实,对本文以及其中全部或者部分内容、文字的真实性、完整性、及时性本站不作任何保证或承诺,请读者仅作参考,并请自行核实相关内容。
    本网站有部分内容均转载自其它媒体,转载目的在于传递更多信息,并不代表本网赞同其观点和对其真实性负责,若因作品内容、知识产权、版权和其他问题,请及时提供相关证明等材料并与我们留言联系,本网站将在规定时间内给予删除等相关处理.

  • [Java] Retrofit2.0 如何进行GBK编码
    对Retrofit + OkHttp还不熟悉的人可以点传送门,先看下这两个东西的使用。Retrofit:https://github.com/square/retrofitOkHttp:https://github.com/square/okhttp分析接口文档要求Post请求,字段使用GBK编码我们先按照Retrofit的规范和接口文档来写接口: @PO
    12-23 RetrofitJava
  • Android常用的开源项目及其比较系列-Retrofit进
    上一篇我们谈了谈Androiod开源项目的网络框架, 比较了它们之间的优缺点,原文在这里。今天我们着重谈谈Retrofit框架如何更友好的使用,本着提出问题解决问题的原则,也为大家以后解决问题提供基本思路。目前都有哪些问题?根据官方Demo, 简单使用是这么样的
  • Android MVP架构实践
    Android MVP架构实践
    首先声明一下,没有完美的架构,只要适合自己的项目,那就是最好的架构。本例子是MVP + Retrofit + RxJava结合的例子,但本文的重点在于讲解MVP架构,所以涉及Retrofit和RxJava的部分将直接略过,默认读者已了解这两部分内容,如有需要,请自行查阅相关资料,
  • 从 Retrofit 源码学习 Java 的动态代理的使用
    Retrofit 是当前 Android 最流行的 HTTP 网络库之一了,其使用方式比较特殊,是通过定义一个接口类,通过给接口中方法和方法参数添加注解的方式来定义网络请求接口。这种风格下定义一个网络接口变得很简单。不过 Retrofit 是如何使用一个接口的 Class 创建出
    11-13 RetrofitJava
  • 打造企业级网络请求框架集合 retrofit+gson+mvp
    打造企业级网络请求框架集合 retrofit+gson+m
    本文是企业级网络框架第二篇主要讲MVP模式和Gson在Retrofit网络请求框架下的使用方式。(已更新为一篇) 对MVP不了解的请看梦之鬼索MVP模式在Android中的设计和实现 http://blog.csdn.net/androidmsky/article/details/52248797 对Retrofit还不了解的情看 打
    10-31 RetrofitGson
  • Retrofit分析之框架设计艺术
    Retrofit分析之框架设计艺术
    Retrofit使用者会觉得接口+注解方式去写网络请求很吊。但当你真正的去看它的源码,会被它独特,漂亮的解耦方式所吸引,整个结构运用了动态代理,策略模式,Builder模式,工厂等设计模式。Retrofit v2.1基于Okhttp3,可以说是对okhttp进行二次封装。先感受一下
    10-07 Retrofit
  • Android Retrofit框架解析
    随着Google对HttpClient的摒弃,和Volley的逐渐没落,OkHttp开始异军突起,而Retrofit则对okHttp进行了强制依赖。Retrofit也是Square公司开发的一款针对Android网络请求的框架,其实质就是对okHttp的封装,使用面向接口的方式进行网络请求,利用动态生成的代理类
    10-04 Retrofit
  • Android网络开源库-Retrofit(四)文件相关
    以前写过一些retrofit的相关文章,当时只是自己学习研究的,最近项目,加入了retrofit,因此遇到了一些问题,需要记录一下。1.前言在以前,写过retrofit上传文件相关,但是,需求总是变化的。前面的,介绍了上传进度的监听,但是,那时候是监听单文件进度。虽
  • 急速开发系列——Retrofit 响应数据及异常处理
    今天我们来谈谈客户端对通讯协议的处理,主要分为三部分:约定响应数据格式,响应数据的自动映射以及错误处理三部分。由于数据协议采用json的居多,因此我们在此基础上进行说明。约定响应数据格式协议格式通常来说,你拿到的设计文档中会存在通信协议的说明,
    09-29 RetrofitGson
  • 使用Android API最佳实践
    使用Android API最佳实践
    写在前面 现在,Android应用程序中集成第三方API已十分流行。应用程序都有自己的网络操作和缓存处理机制,但是大部分比较脆弱,没有针对网络糟糕情况进行优化。感谢 Square lnc这家有创新精神的公司,将信用卡商业交易带到手机上。现在有了一系列高质量开源库
    09-20 APIRetrofit
点击排行