Retrofit源码赏析四 —— OkHttpCall

1,098 阅读2分钟

持续创作,加速成长!这是我参与「掘金日新计划 · 6 月更文挑战」的第24天,点击查看活动详情

通过前面分析,我们知道在HttpServiceMethod#invoke()方法中,会创建OkHttpCall对象。

final @Nullable ReturnT invoke(Object[] args) {
	Call<ResponseT> call = new OkHttpCall<>(requestFactory, args, callFactory, responseConverter);
	return adapt(call, args);
}

OkHttpCall是retrofit2.Call的实现类,retrofit2.Call定义了以下方法

public interface Call<T> extends Cloneable {
  Response<T> execute() throws IOException;
  void enqueue(Callback<T> callback);
  boolean isExecuted();
  void cancel();
  boolean isCanceled();
  Call<T> clone();
  Request request();
  Timeout timeout();
}

熟悉OkHttp的朋友应该知道retrofit2.Call与okhttp3.Call基本相似。

enqueue

OkHttpCall提供了同步和异步两种请求方式,之前简单分析过同步的方式,这里就以异步为例。

public void enqueue(final Callback<T> callback) {
	//1 创建okhttp3.Call
	okhttp3.Call call = rawCall = createRawCall();
	//2 执行请求
	call.enqueue(new okhttp3.Callback() {
		@Override
		public void onResponse(okhttp3.Call call, okhttp3.Response rawResponse) {
			//处理响应结果
			Response<T> response = parseResponse(rawResponse);
		}
    });
}

从这里可以看出真正的请求其实是由okhttp完成的,Retrofit只是对其进行了封装,简化了我们使用的流程。 enqueue()方法比较长,但是只是主要只是做了3件事。

  1. 创建okhttp3.Call对象
  2. 执行请求,获取结果
  3. 处理响应结果,回调给外部

创建okhttp3.Call

private okhttp3.Call createRawCall() throws IOException {
	okhttp3.Call call = callFactory.newCall(requestFactory.create(args));
	if (call == null) {
		throw new NullPointerException("Call.Factory returned null.");
	}
	return call;
}

okhttp3.Call对象是由callFactory创建的,callFactory是我们初始化Retrofit时传入的参数,一般情况下都是OkHttpClient对象。再单独使用OkHttp的时候,我们创建一个Call对象的方式是下面这样的

Request request = new Request.Builder().build();
client.newCall(request)

通过构造者模式创建Request对象,但是在Retrofit中,则是由requestFactory创建,简化了我们的使用方式。

执行请求

获取到okhttp3.Call对象之后就可以调用enqueue(callback)发起异步请求

call.enqueue(new okhttp3.Callback() {
    @Override
    public void onResponse(okhttp3.Call call, okhttp3.Response rawResponse) {
        Response<T> response;
        try {
            response = parseResponse(rawResponse);
        } catch (Throwable e) {
            throwIfFatal(e);
            callFailure(e);
            return;
        }
    }
    public void onFailure(okhttp3.Call call, IOException e) {
        callFailure(e);
    }
}

使用方式和OkHttp完全一致。

处理响应结果

通过上一步执行了请求之后,就能获取到结果了,如果失败回调onFailure()方法,如果成功则还需要对结果进行解析

Response<T> parseResponse(okhttp3.Response rawResponse) throws IOException {
    ResponseBody rawBody = rawResponse.body();
    rawResponse = rawResponse
            .newBuilder()
            .body(new NoContentResponseBody(rawBody.contentType(), rawBody.contentLength()))
            .build();
    int code = rawResponse.code();
    if (code < 200 || code >= 300) {
        try {
            ResponseBody bufferedBody = Utils.buffer(rawBody);
            return Response.error(bufferedBody, rawResponse);
        } finally {
            rawBody.close();
        }
    }
    if (code == 204 || code == 205) {
        rawBody.close();
        return Response.success(null, rawResponse);
    }
    ExceptionCatchingResponseBody catchingBody = new ExceptionCatchingResponseBody(rawBody);
    try {
        T body = responseConverter.convert(catchingBody);
        return Response.success(body, rawResponse);
    } catch (RuntimeException e) {
        catchingBody.throwIfCaught();
        throw e;
    }
}
  1. 首先复制一个Response,然后删除他的主体数据,以便后面使用无主体数据的Response传递响应结果。
  2. 然后判断Http响应码,我们知道2xx的响应码代表成功,但是204和205这两个比较特殊,他们的响应内容为空,所以只是返回了rawResponse,这意味着我们在业务层通过response.body()获取到的结果可能是null。
  3. 最后对响应体rawBody做个包装,包装成为ExceptionCatchingResponseBody对象,然后交给responseConverter转换为我们需要的实体类型

这里首先将Response的body移除是因为ResponseBody里面的source是具有状态的对象。