Okhttp 使用总结

3,925 阅读2分钟

在项目中用的是Okhttp 3.4.2,替换原有的网络框架,okhttp使用很方便,封装性很好,在此纪录一下使用过程中遇到的问题。

1.返回数据乱码的问题

由于服务器返回的数据本身就是Gzip格式,原有的网络框架也是请求服务端返回Gzip格式,替换为okhttp后,照常添加addHeader("Accept-Encoding", "gzip, deflate"),结果服务器返回乱码,无论怎么处理,试过转换成字节,编码格式替换为gb2312,转换成流处理,都没有用,客户端得到的异常如下:

com.google.gson.JsonSyntaxException: java.lang.IllegalStateException: Expected
BEGIN_OBJECT but was STRING at line 1 column 1
com.google.gson.JsonSyntaxException: java.lang.IllegalStateException: 
Expected BEGIN_OBJECT but was STRING at line 1 column 1

第二天早上坐车去公司的路上,查了一下google,无意中想到会不会是Gzip没有解压导致的,但是Okhttp又是对Gzip自动支持并且自动解压的,最后查了源码,才算明白是怎么回事。

// If we add an "Accept-Encoding: gzip" header field we're responsible for also decompressing
// the transfer stream.
boolean transparentGzip = false;
if (userRequest.header("Accept-Encoding") == null)
{
  transparentGzip = true;
  requestBuilder.header("Accept-Encoding", "gzip");
}

if (transparentGzip &&
 "gzip".equalsIgnoreCase(networkResponse.header("Content-Encoding"))
    && HttpHeaders.hasBody(networkResponse))
{
  GzipSource responseBody = new GzipSource(networkResponse.body().source());
  Headers strippedHeaders = networkResponse.headers().newBuilder()
      .removeAll("Content-Encoding")
      .removeAll("Content-Length")
      .build();
  responseBuilder.headers(strippedHeaders);
  responseBuilder.body(new RealResponseBody(strippedHeaders, Okio.buffer(responseBody)));
}

上段代码摘自BridgeInterceptor类中,现在明白为什么了吗?如果Request的header中用户加了header("Accept-Encoding")的话,那么Okhttp不会帮你处理Gzip的解压,需要你自己去处理。那么问题就好办了,把Request的header中去掉header("Accept-Encoding")就行了,调试不再出现乱码,完美。

2.怎么取消一次Request请求

原有的网络请求库中,部分Api做了cancel的操作,那替换成了okhttp之后,怎么把这部分做一个处理呢?
还好okhttp可以通过Request.Builder.tag("url")来打tag,然后通过下述代码即可做到cancel某一个Request的功能,你需要做的只是返回url就行了。

public static void cancelCallWithTag(String tag) {
    for (Call call : RequestApi2.getInstance().getOkHttpClient().dispatcher().queuedCalls()) {
        if (call.request().tag().equals(tag))
            call.cancel();
    }
    for (Call call : RequestApi2.getInstance().getOkHttpClient().dispatcher().runningCalls()) {
        if (call.request().tag().equals(tag))
            call.cancel();
    }
}

3.顺便纪录一下Post中生成RequestBody的两种方式

FormBody.Builder formBuilder = new FormBody.Builder();
RequestBody requestBody = formBuilder.build();
//对于Json的字符串,可以用这种方式
final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
RequestBody.create(JSON, data)