一、引言
在如今的移动应用开发领域,网络交互已经成为了绝大多数 Android 应用不可或缺的一部分。无论是获取最新的资讯内容、同步用户数据,还是与后端服务器进行实时通信,高效且稳定的网络请求都是保障应用良好用户体验的基石。而 OkHttp 框架,正是在这样的背景下崭露头角,成为了 Android 开发者手中极为得力的工具。
OkHttp 以其卓越的性能表现脱颖而出。它采用了先进的连接池技术,能够高效地复用网络连接,极大地减少了建立新连接所带来的开销。在网络请求频繁的应用场景中,这一特性可以显著降低网络延迟,提升数据加载速度,让用户感受到流畅的交互体验。
同时,OkHttp 对 HTTP/2 协议的良好支持,充分利用了该协议在多路复用、头部压缩等方面的优势,进一步提升了数据传输的效率,即使在网络状况不佳的情况下,也能尽可能地保障应用的正常运行。
此外,OkHttp 的简洁性和易用性也为开发者们所青睐。它提供了清晰明了的 API 接口,使得开发者能够轻松地构建各种类型的网络请求,无论是简单的 GET、POST 请求,还是复杂的带有自定义请求头、请求体的请求,都能通过简洁的代码实现。
这种高效与简洁的完美结合,使得 OkHttp 在众多 Android 网络框架中脱颖而出,成为了主流选择,对提升应用整体性能起着至关重要的作用。
二、OkHttp 基础使用
(一)引入依赖
在使用 OkHttp 框架之前,首先需要在项目中引入其依赖。在 Android 项目的build.gradle文件中,添加如下依赖代码:
implementation 'com.squareup.okhttp3:okhttp:4.9.3'
这里使用的是 OkHttp 4.9.3 版本,不同的版本号在功能和稳定性上可能会存在一些差异。在实际项目中,你可以根据项目的具体需求和兼容性要求,选择合适的版本。例如,如果项目需要与旧版本的 Android 系统兼容,可能需要选择相对稳定且兼容性好的版本;而如果项目追求最新的功能特性和性能优化,可以尝试使用最新发布的版本。
在引入依赖的过程中,可能会遇到一些问题。比如,由于网络原因导致依赖下载失败,此时可以检查网络连接是否正常,或者尝试更换 Gradle 的镜像源。另外,如果项目中同时存在多个版本的 OkHttp 依赖,可能会引发冲突,导致编译错误。这种情况下,需要仔细检查项目的依赖树,统一 OkHttp 的版本。
(二)简单 GET 请求
创建 OkHttpClient 实例
OkHttpClient 是 OkHttp 框架的核心类之一,它负责管理请求的执行和配置。通过 Builder 模式创建 OkHttpClient 实例,可以方便地设置各种参数。以下是创建一个默认配置的 OkHttpClient 实例的代码:
OkHttpClient client = new OkHttpClient.Builder()
.build();
在实际应用中,我们可以根据需求对 OkHttpClient 进行更多的配置。例如,设置连接超时时间、读取超时时间和写入超时时间,以控制请求的时间限制:
OkHttpClient client = new OkHttpClient.Builder()
.connectTimeout(10, TimeUnit.SECONDS)
.readTimeout(15, TimeUnit.SECONDS)
.writeTimeout(15, TimeUnit.SECONDS)
.build();
这里设置了连接超时时间为 10 秒,即如果在 10 秒内未能建立与服务器的连接,请求将失败;读取超时时间为 15 秒,意味着在 15 秒内如果未能从服务器读取到数据,请求也会失败;写入超时时间同样为 15 秒,用于控制向服务器写入数据的时间限制。合理设置这些超时时间,可以有效地避免请求长时间等待,提升应用的响应速度。
构建 Request 对象
Request 对象用于封装请求的所有信息,包括请求的 URL、请求方法、请求头等。以下是构建一个简单 GET 请求的 Request 对象的代码:
Request request = new Request.Builder()
.url("https://api.example.com/data")
.build();
在这个例子中,我们只设置了请求的 URL,这是 GET 请求最基本的信息。如果需要设置请求头,可以使用addHeader方法。例如,添加一个Authorization头,用于进行身份验证:
Request request = new Request.Builder()
.url("https://api.example.com/data")
.addHeader("Authorization", "Bearer token")
.build();
执行请求并处理响应
OkHttp 支持同步和异步两种请求方式,开发者可以根据具体的应用场景选择合适的方式。
同步请求:
try (Response response = client.newCall(request).execute()) {
if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);
String responseData = response.body().string();
Log.d("OkHttp", responseData);
} catch (IOException e) {
e.printStackTrace();
}
在同步请求中,execute方法会阻塞当前线程,直到请求完成并返回响应。这种方式适用于一些对响应及时性要求较高,且当前线程不是主线程(避免阻塞主线程导致界面卡顿)的场景。在处理响应时,首先通过response.isSuccessful()方法检查响应状态码是否表示成功(通常状态码为 200 - 299 表示成功),如果不成功则抛出异常。然后通过response.body().string()方法获取响应体的内容,并进行相应的处理。
异步请求:
client.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
e.printStackTrace();
}
@Override
public void onResponse(Call call, Response response) throws IOException {
try (ResponseBody responseBody = response.body()) {
if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);
String responseData = responseBody.string();
Log.d("OkHttp", responseData);
}
}
});
异步请求通过enqueue方法实现,该方法会将请求放入请求队列中,立即返回,不会阻塞当前线程。当请求完成后,会回调Callback接口中的onFailure或onResponse方法,分别用于处理请求失败和成功的情况。在onResponse方法中,同样需要检查响应状态码并获取响应体内容。异步请求适用于大多数 Android 应用场景,尤其是在主线程中发起网络请求时,能够避免阻塞主线程,保证界面的流畅性。
(三)POST 请求
构建 RequestBody
POST 请求通常需要携带请求体数据,RequestBody 用于构建和传输这些数据。OkHttp 支持多种类型的 RequestBody,常见的有 JSON 格式和表单格式。
JSON 格式 RequestBody:
MediaType JSON = MediaType.parse("application/json; charset=utf-8");
String json = "{\"key\":\"value\"}";
RequestBody body = RequestBody.create(JSON, json);
这里首先通过MediaType.parse方法创建了一个表示 JSON 类型的 MediaType 对象,指定了字符编码为 UTF - 8。然后创建一个 JSON 格式的字符串json,并使用RequestBody.create方法将其转换为 RequestBody 对象。
表单格式 RequestBody:
RequestBody body = new FormBody.Builder()
.add("param1", "value1")
.add("param2", "value2")
.build();
通过FormBody.Builder可以方便地构建表单格式的请求体,使用add方法添加键值对参数。
创建 Request 对象并设置请求方法为 POST 及 RequestBody
Request request = new Request.Builder()
.url("https://api.example.com/data")
.post(body)
.build();
在构建 Request 对象时,使用post方法将请求方法设置为 POST,并传入之前构建好的 RequestBody 对象。
执行请求并处理响应
POST 请求的执行和响应处理方式与 GET 请求类似,同样可以使用同步或异步方式。以异步请求为例:
client.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
e.printStackTrace();
}
@Override
public void onResponse(Call call, Response response) throws IOException {
try (ResponseBody responseBody = response.body()) {
if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);
String responseData = responseBody.string();
Log.d("OkHttp", responseData);
}
}
});
(四)其他请求方法
除了 GET 和 POST 请求,OkHttp 还支持 PUT、DELETE 等其他常见的 HTTP 请求方法。
PUT 请求:PUT 请求用于更新服务器上的资源。构建 PUT 请求的方式与 POST 请求类似,只需将请求方法设置为 PUT 即可。
RequestBody body = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), "{\"key\":\"newValue\"}");
Request request = new Request.Builder()
.url("https://api.example.com/data/1")
.put(body)
.build();
在这个例子中,我们构建了一个 JSON 格式的 RequestBody,并使用 PUT 方法向指定的 URL 发送请求,以更新服务器上 ID 为 1 的数据。
DELETE 请求:DELETE 请求用于删除服务器上的资源。通常 DELETE 请求不需要请求体,只需要指定请求的 URL 即可。
Request request = new Request.Builder()
.url("https://api.example.com/data/1")
.delete()
.build();
这里通过delete方法将请求方法设置为 DELETE,发送请求后服务器将删除指定 URL 对应的资源。
这些不同的请求方法在实际应用中根据业务需求进行选择,例如在更新用户信息时可能使用 PUT 请求,而删除用户收藏的数据时则使用 DELETE 请求。
(五)请求头和请求参数设置
请求头设置
在 Request.Builder 中可以方便地设置请求头。请求头用于传递一些额外的信息,如身份验证信息、内容类型、缓存控制等。以下是一些常见的请求头设置示例:
添加身份验证头:
Request request = new Request.Builder()
.url("https://api.example.com/data")
.addHeader("Authorization", "Bearer token")
.build();
这里的Authorization头用于传递身份验证令牌,服务器可以根据这个令牌验证请求的合法性。
设置内容类型头:
Request request = new Request.Builder()
.url("https://api.example.com/data")
.addHeader("Content-Type", "application/json")
.build();
Content-Type头用于指定请求体的内容类型,在发送 JSON 格式的请求体时,需要设置为application/json。
设置缓存控制头:
Request request = new Request.Builder()
.url("https://api.example.com/data")
.addHeader("Cache-Control", "no-cache")
.build();
Cache-Control头用于控制缓存行为,no-cache表示不使用缓存,每次都从服务器获取最新数据。
请求参数设置
请求参数的设置方式因请求方法而异。
GET 请求参数设置:在 GET 请求中,请求参数通常附加在 URL 后面。可以使用HttpUrl.Builder来构建包含参数的 URL。
HttpUrl url = new HttpUrl.Builder()
.scheme("https")
.host("api.example.com")
.addPathSegment("data")
.addQueryParameter("param1", "value1")
.addQueryParameter("param2", "value2")
.build();
Request request = new Request.Builder()
.url(url)
.build();
这里通过addQueryParameter方法添加了两个请求参数param1和param2及其对应的值。
POST 请求参数设置:对于 POST 请求,如果是表单格式的数据,可以通过FormBody.Builder来设置参数,如前面 POST 请求部分所述。如果是 JSON 格式的数据,则将参数包含在 JSON 字符串中构建 RequestBody。
MediaType JSON = MediaType.parse("application/json; charset=utf-8");
String json = "{\"param1\":\"value1\",\"param2\":\"value2\"}";
RequestBody body = RequestBody.create(JSON, json);
Request request = new Request.Builder()
.url("https://api.example.com/data")
.post(body)
.build();
正确设置请求头和请求参数对于确保请求能够被服务器正确理解和处理至关重要,开发者需要根据具体的业务需求和服务器接口规范进行合理设置。
三、OkHttp 核心组件
(一)OkHttpClient
核心地位与作用
OkHttpClient 在整个 OkHttp 框架中占据着核心地位,它就像是一个指挥官,负责管理请求的执行流程和配置各种参数。所有的网络请求都需要通过 OkHttpClient 实例来发起,它协调着各个组件之间的工作,确保请求能够高效、准确地执行。
可配置参数详解
连接池(Connection Pool):连接池用于管理和复用网络连接。通过newBuilder().connectionPool(ConnectionPool)方法可以设置连接池。连接池的存在大大减少了建立新连接的开销,提高了请求的效率。
例如,在一个频繁进行网络请求的应用中,如果每次请求都建立新的连接,不仅会消耗大量的时间,还会占用更多的系统资源。而连接池可以将使用过的连接进行缓存,当下一次有相同目标服务器的请求时,直接复用连接池中的连接,从而显著提升性能。
超时时间(Timeout):包括连接超时时间(connectTimeout)、读取超时时间(readTimeout)和写入超时时间(writeTimeout)。如前面在创建 OkHttpClient 实例时的示例:
OkHttpClient client = new OkHttpClient.Builder()
.connectTimeout(10, TimeUnit.SECONDS)
.readTimeout(15, TimeUnit.SECONDS)
.writeTimeout(15, TimeUnit.SECONDS)
.build();
合理设置超时时间可以避免请求长时间等待,提高应用的响应速度。连接超时时间决定了在建立与服务器的连接时等待的最长时间,如果超过这个时间仍未建立连接,请求将失败。读取超时时间用于控制从服务器读取数据的最长时间,若在规定时间内未能读取到足够的数据,请求也会失败。写入超时时间则是在向服务器写入请求数据时的时间限制。
拦截器(Interceptor):拦截器是 OkHttp 框架中非常强大的一个功能。通过newBuilder().addInterceptor(Interceptor)方法可以添加拦截器。拦截器可以在请求发送前和响应接收后对请求和响应进行处理,例如添加自定义的请求头、记录请求日志、对响应数据进行解密等。拦截器分为应用拦截器(addInterceptor)和网络拦截器(addNetworkInterceptor),它们的执行顺序和作用范围有所不同。应用拦截器会在请求进入网络栈之前执行,并且只会执行一次,即使请求被重试。而网络拦截器会在请求进入网络栈之后执行,并且在请求重试时也会再次执行。拦截器的使用使得开发者可以方便地对请求和响应进行定制化处理,极大地增强了框架的灵活性。
(二)Request 和 RequestBody
Request 对象
Request 对象封装了请求的所有信息,包括请求的 URL、请求方法(GET、POST、PUT、DELETE 等)、请求头以及请求体(如果有)。它的构建过程使用了 Builder 模式,使得代码更加简洁易读。例如:
Request request = new Request.Builder()
.url("https://api.example.com/data")
.addHeader("Authorization", "Bearer token")
.post(RequestBody.create(MediaType.parse("application/json; charset=utf-8"), "{\"key\":\"value\"}"))
.build();
在这个例子中,我们通过Request.Builder依次设置了请求的 URL、添加了Authorization请求头,并设置了请求方法为 POST 以及对应的 RequestBody。Request 对象的各个属性在请求执行过程中起着关键作用,服务器根据这些信息来正确处理请求。
RequestBody 对象
RequestBody 负责请求体数据的构建和传输。它是一个抽象类,具体的实现类根据不同的数据类型和格式来构建请求体。如前面提到的 JSON 格式的 RequestBody 实现:
MediaType JSON = MediaType.parse("application/json; charset=utf-8");
String json = "{\"key\":\"value\"}";
RequestBody body = RequestBody.create(JSON, json);
这里通过RequestBody.create方法创建了一个 JSON 格式的 RequestBody,它将 JSON 字符串按照指定的 MediaType 进行封装,以便在请求时正确传输给服务器。
对于表单格式的数据,FormBody是常用的 RequestBody实现类,通过FormBody.Builder可以方便地添加键值对参数构建请求体。
不同类型的 RequestBody 为开发者提供了灵活多样的数据传输方式,以满足各种业务场景的需求。
(三)Response 和 ResponseBody
Response 对象
Response 对象包含了服务器响应的所有信息,它是请求执行完成后返回给开发者的数据载体。其关键属性和方法对于正确处理响应至关重要。
响应状态码(Code):通过response.code()方法可以获取服务器返回的状态码。常见的状态码如 200 表示请求成功,400 表示客户端请求错误,401 表示未授权,500 表示服务器内部错误等。开发者可以根据状态码来判断请求的执行结果,并采取相应的处理措施。例如,当状态码为 401 时,可以提示用户重新登录以获取授权。
响应头(Headers):response.headers()方法返回一个包含所有响应头的集合。响应头中包含了许多有用的信息,如Content-Type指示响应体的内容类型,Content-Length表示响应体的长度,Cache-Control用于控制缓存行为等。通过解析响应头,开发者可以更好地理解响应数据的特性,并进行相应的处理。比如,根据Content-Type判断响应体是 JSON 格式、XML 格式还是其他格式,从而选择合适的解析方式。
响应体(Body):response.body()方法返回一个 ResponseBody 对象,用于读取响应体的内容。需要注意的是,ResponseBody 对象只能被读取一次,读取完成后流会关闭,如果再次尝试读取会抛出异常。
ResponseBody 对象
ResponseBody 用于读取响应体数据,它同样是一个抽象类,具体的实现类根据响应数据的类型和格式来提供不同的读取方式。在处理响应体数据时,通常需要根据响应的Content-Type来选择合适的读取方法。
字符串读取:如果响应体是文本类型,如 JSON、XML 或普通文本,可以使用responseBody.string()方法将响应体内容读取为字符串。例如:
try (ResponseBody responseBody = response.body()) {
if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);
String responseData = responseBody.string();
Log.d("OkHttp", responseData);
} catch (IOException e) {
e.printStackTrace();
}
这里将响应体内容读取为字符串,并通过日志输出。在使用string()方法时,OkHttp 会将整个响应体内容读入内存,因此对于较大的响应体可能会导致内存占用过高的问题。
字节流读取:对于二进制数据,如图片、文件等,更适合使用responseBody.byteStream()方法获取字节流进行读取。这样可以避免一次性将大量数据读入内存,提高处理效率。例如,下载图片时可以使用以下方式:
try (ResponseBody responseBody = response.body()) {
if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);
InputStream inputStream = responseBody.byteStream();
// 将字节流写入文件
FileOutputStream fos = new FileOutputStream(new File("image.jpg"));
byte[] buffer = new byte[1024];
int len;
while ((len = inputStream.read(buffer)) != -1) {
fos.write(buffer, 0, len);
}
fos.close();
inputStream.close();
} catch (IOException e) {
e.printStackTrace();
}
在这个例子中,通过字节流将响应体中的图片数据写入文件,实现了图片的下载功能。正确处理 ResponseBody 对于获取和利用服务器返回的数据至关重要,开发者需要根据实际情况选择合适的读取方式。
(四)Call
Call 的生命周期与状态管理
Call 代表一个可执行的请求,它具有明确的生命周期和状态管理机制。当通过client.newCall(request)方法创建一个 Call 对象时,请求处于准备状态。此时,可以对 Call 对象进行一些操作,如设置回调函数(在异步请求中)、取消请求等。
当调用execute()或enqueue()方法时,请求进入执行状态。如果请求成功完成,Call 对象的状态变为已完成;如果请求过程中出现错误,状态则变为失败。
请求取消操作及原理
Call 对象提供了cancel()方法用于取消请求。在实际应用中,当用户进行了一些操作导致请求不再需要时,例如在页面跳转时取消正在进行的网络请求,可以调用cancel()方法。其原理是在请求执行过程中,OkHttp 会不断检查请求的取消状态。当调用cancel()方法后,会设置请求的取消标志,在请求执行的各个阶段,如连接建立、数据读取等过程中,一旦检测到取消标志,就会停止当前操作,并抛出IOException(具体为IOException的子类InterruptedIOException)来通知上层调用者请求已被取消。例如:
Call call = client.newCall(request);
call.cancel();
在这个例子中,创建了一个 Call 对象后立即调用cancel()方法取消了请求。通过合理使用cancel()方法,可以避免在不必要的情况下继续执行网络请求,节省系统资源,提升应用性能。同时,在处理请求取消时,需要在catch块中对InterruptedIOException进行适当的处理,例如提示用户请求已被取消,或者进行一些清理操作。
四、OkHttp 源码解析
(一)初始化过程
OkHttpClient.Builder 构建流程
OkHttpClient 采用 Builder 模式进行构建,这种模式使得参数配置更加灵活和可读。在OkHttpClient.Builder的构造函数中,会初始化一系列的默认参数。例如,默认的连接池ConnectionPool会被创建,其默认的最大空闲连接数为 5 个,并且空闲连接的存活时间为 5 分钟。代码如下:
public Builder() {
dispatcher = new Dispatcher();
protocols = DEFAULT_PROTOCOLS;
connectionSpecs = DEFAULT_CONNECTION_SPECS;
eventListenerFactory = EventListener.factory(EventListener.NONE);
proxySelector = ProxySelector.getDefault();
cookieJar = CookieJar.NO_COOKIES;
socketFactory = SocketFactory.getDefault();
hostnameVerifier = OkHostnameVerifier.INSTANCE;
certificatePinner = CertificatePinner.DEFAULT;
proxyAuthenticator = Authenticator.NONE;
authenticator = Authenticator.NONE;
connectionPool = new ConnectionPool();
dns = Dns.SYSTEM;
followSslRedirects = true;
followRedirects = true;
retryOnConnectionFailure = true;
connectTimeout = 10_000;
readTimeout = 10_000;
writeTimeout = 10_000;
pingInterval = 0;
}
开发者可以通过链式调用的方式修改这些默认参数。比如,设置连接超时时间为 15 秒,代码如下:
OkHttpClient client = new OkHttpClient.Builder()
.connectTimeout(15, TimeUnit.SECONDS)
.build();
链式调用的原理是 Builder 类的每个设置方法(如connectTimeout)都会返回this,即当前的 Builder 实例,从而允许继续调用其他设置方法,最终通过build()方法构建出OkHttpClient实例。
OkHttpClient 实例化时的组件初始化
当调用build()方法时,会对各种组件进行最后的组装和初始化。例如,会创建一个RealCall.Factory实例,用于创建实际执行请求的RealCall对象。同时,会将配置好的参数传递给各个组件,如将设置的连接池ConnectionPool传递给负责连接管理的组件。代码如下:
public OkHttpClient build() {
return new OkHttpClient(this);
}
OkHttpClient(Builder builder) {
this.dispatcher = builder.dispatcher;
this.protocols = builder.protocols;
this.connectionSpecs = builder.connectionSpecs;
this.eventListenerFactory = builder.eventListenerFactory;
this.proxySelector = builder.proxySelector;
this.cookieJar = builder.cookieJar;
this.socketFactory = builder.socketFactory;
this.sslSocketFactory = builder.sslSocketFactory;
this.certificateChainCleaner = builder.certificateChainCleaner;
this.hostnameVerifier = builder.hostnameVerifier;
this.certificatePinner = builder.certificatePinner;
this.proxyAuthenticator = builder.proxyAuthenticator;
this.authenticator = builder.authenticator;
this.connectionPool = builder.connectionPool;
this.dns = builder.dns;
this.followSslRedirects = builder.followSslRedirects;
this.followRedirects = builder.followRedirects;
this.retryOnConnectionFailure = builder.retryOnConnectionFailure;
this.connectTimeout = builder.connectTimeout;
this.readTimeout = builder.readTimeout;
this.writeTimeout = builder.writeTimeout;
this.pingInterval = builder.pingInterval;
}
这样,在OkHttpClient实例化完成后,所有的组件都已经按照开发者的配置进行了初始化,为后续的请求执行做好了准备。
(二)请求执行流程
请求创建与调度过程
当调用client.newCall(request)时,实际上是调用了OkHttpClient的newCall方法,该方法会创建一个RealCall对象。RealCall是Call接口的实际实现类,负责具体的请求执行。代码如下:
@Override
public Call newCall(Request request) {
return RealCall.newRealCall(this, request, false /* for web socket */);
}
static RealCall newRealCall(OkHttpClient client, Request originalRequest, boolean forWebSocket) {
// Safely publish the Call instance to the EventListener.
RealCall call = new RealCall(client, originalRequest, forWebSocket);
call.eventListener = client.eventListenerFactory.create(call);
return call;
}
此时,RealCall对象被创建,但请求尚未开始执行。接着,会将RealCall对象返回给调用者,调用者可以选择调用execute()方法进行同步请求,或者enqueue()方法进行异步请求。
RealCall 的 execute () 和 enqueue () 方法解析
同步请求(execute ()):execute()方法是一个阻塞方法,它会在当前线程中执行请求。首先,它会检查请求是否已经被执行过,如果已经执行则抛出异常。然后,会创建一个Response对象用于存储响应结果。接着,通过调用getResponseWithInterceptorChain()方法来执行请求的拦截器链,获取服务器的响应。代码如下:
@Override
public Response execute() throws IOException {
synchronized (this) {
if (executed) throw new IllegalStateException("Already Executed");
executed = true;
}
captureCallStackTrace();
eventListener.callStart(this);
try {
client.dispatcher().executed(this);
Response result = getResponseWithInterceptorChain();
if (result == null) throw new IOException("Canceled");
return result;
} catch (IOException e) {
e.printStackTrace();
eventListener.callFailed(this, e);
throw e;
} finally {
client.dispatcher().finished(this);
}
}
在getResponseWithInterceptorChain()方法中,会构建一个拦截器链,依次执行应用拦截器、网络拦截器等,最终通过网络获取服务器的响应。关于拦截器链的详细执行过程,会在后续的拦截器机制部分深入分析。
异步请求(enqueue ()):enqueue()方法用于异步执行请求,不会阻塞当前线程。它同样会检查请求是否已经被执行过,然后将RealCall对象添加到Dispatcher的请求队列中。Dispatcher会在合适的时机从请求队列中取出请求并执行。代码如下:
@Override
public void enqueue(Callback responseCallback) {
synchronized (this) {
if (executed) throw new IllegalStateException("Already Executed");
executed = true;
}
captureCallStackTrace();
eventListener.callStart(this);
client.dispatcher().enqueue(new AsyncCall(responseCallback));
}
AsyncCall是RealCall的内部类,实现了Runnable接口。当Dispatcher从请求队列中取出AsyncCall并执行其run()方法时,会调用getResponseWithInterceptorChain()方法获取响应,并通过回调Callback接口的onFailure或onResponse方法通知调用者请求的结果。
Dispatcher 在请求调度中的作用
Dispatcher是 OkHttp 中负责请求调度的核心组件。它维护了两个请求队列:正在执行的请求队列(runningSyncCalls和runningAsyncCalls)和等待执行的请求队列(readyAsyncCalls)。
对于同步请求,Dispatcher会将RealCall对象添加到runningSyncCalls队列中,并立即执行。对于异步请求,Dispatcher会将AsyncCall对象添加到readyAsyncCalls队列中。
Dispatcher内部有一个线程池ExecutorService,用于执行异步请求。默认情况下,线程池的最大线程数为 64 个。当Dispatcher从readyAsyncCalls队列中取出AsyncCall时,会将其提交到线程池中执行。
同时,Dispatcher会根据正在执行的异步请求数量和线程池的状态来控制请求的执行节奏,以避免过多的请求同时执行导致系统资源耗尽。
例如,如果正在执行的异步请求数量超过了 64 个,Dispatcher会暂停从readyAsyncCalls队列中取出新的请求,直到有正在执行的请求完成,腾出资源。代码如下:
public synchronized void enqueue(AsyncCall call) {
if (runningAsyncCalls.size() < maxRequests && runningCallsForHost(call) < maxRequestsPerHost) {
runningAsyncCalls.add(call);
executorService().execute(call);
} else {
readyAsyncCalls.add(call);
}
}
当请求完成(无论是成功还是失败),Dispatcher会将请求从正在执行的队列中移除,并根据情况从等待队列中取出新的请求执行。例如,在finished()方法中,会将请求从runningSyncCalls或runningAsyncCalls队列中移除,并检查readyAsyncCalls队列中是否有等待的请求,如果有则取出并执行。代码如下:
public synchronized void finished(Call call) {
if (call.isCanceled()) {
// Do nothing
} else if (call instanceof AsyncCall) {
runningAsyncCalls.remove(call);
} else if (call instanceof RealCall) {
runningSyncCalls.remove(call);
} else {
throw new AssertionError("Call wasn't a RealCall?");
}
promoteCalls();
}
private void promoteCalls() {
if (runningAsyncCalls.size() >= maxRequests) return; // Already running max capacity.
if (readyAsyncCalls.isEmpty()) return; // No ready calls to promote.
for (Iterator<AsyncCall> i = readyAsyncCalls.iterator(); i.hasNext(); ) {
AsyncCall call = i.next();
if (runningCallsForHost(call) < maxRequestsPerHost) {
i.remove();
runningAsyncCalls.add(call);
executorService().execute(call);
}
if (runningAsyncCalls.size() >= maxRequests) return; // Reached max capacity.
}
}
(三)拦截器机制
拦截器的概念与作用
拦截器是 OkHttp 框架中非常强大和灵活的一个功能。它可以在请求发送前和响应接收后对请求和响应进行拦截和处理。拦截器分为应用拦截器和网络拦截器,它们各自有不同的作用和执行顺序。
应用拦截器:通过OkHttpClient.Builder.addInterceptor()方法添加。应用拦截器会在请求进入网络栈之前执行,并且只会执行一次,即使请求被重试。它主要用于添加一些与应用逻辑相关的处理,如添加自定义的请求头、记录请求日志等。例如,以下是一个简单的应用拦截器,用于记录请求的 URL 和响应的时间:
class LoggingInterceptor implements Interceptor {
@Override
public Response intercept(Chain chain) throws IOException {
Request request = chain.request();
Log.d("OkHttp", "Sending request: " + request.url());
long t1 = System.nanoTime();
Response response = chain.proceed(request);
long t2 = System.nanoTime();
Log.d("OkHttp", "Received response in " + (t2 - t1) / 1e6 + "ms");
return response;
}
}
网络拦截器:通过OkHttpClient.Builder.addNetworkInterceptor()方法添加。网络拦截器会在请求进入网络栈之后执行,并且在请求重试时也会再次执行。它主要用于处理与网络相关的操作,如对响应数据进行 Gzip 解压缩、修改网络请求的代理等。例如,以下是一个网络拦截器,用于对响应数据进行 Gzip 解压缩:
class GzipInterceptor implements Interceptor {
@Override
public Response intercept(Chain chain) throws IOException {
Request request = chain.request();
Response originalResponse = chain.proceed(request);
if ("gzip".equals(originalResponse.header("Content - Encoding"))) {
ResponseBody responseBody = originalResponse.body();
if (responseBody != null) {
GZIPInputStream gzipInputStream = new GZIPInputStream(responseBody.byteStream());
ResponseBody newResponseBody = ResponseBody.create(originalResponse.body().contentType(), -1, Okio.source(gzipInputStream));
return originalResponse.newBuilder()
.body(newResponseBody)
.removeHeader("Content - Encoding")
.build();
}
}
return originalResponse;
}
}
拦截器链的构建与执行过程
拦截器链的构建是在RealCall.getResponseWithInterceptorChain()方法中完成的。首先,会创建一个包含所有拦截器的列表,包括应用拦截器、网络拦截器以及一些内部的核心拦截器(如重试和重定向拦截器、桥接拦截器、缓存拦截器等)。代码如下:
Response getResponseWithInterceptorChain() throws IOException {
// Build a full stack of interceptors.
List<Interceptor> interceptors = new ArrayList<>();
interceptors.addAll(client.interceptors());
interceptors.add(new RetryAndFollowUpInterceptor(client));
interceptors.add(new BridgeInterceptor(client.cookieJar()));
interceptors.add(new CacheInterceptor(client.internalCache()));
interceptors.add(new ConnectInterceptor(client));
if (!forWebSocket) {
interceptors.addAll(client.networkInterceptors());
}
interceptors.add(new CallServerInterceptor(forWebSocket));
Interceptor.Chain chain = new RealInterceptorChain(
interceptors, null, null, null, 0,
originalRequest, this, eventListener, client.connectTimeoutMillis(),
client.readTimeoutMillis(), client.writeTimeoutMillis());
return chain.proceed(originalRequest);
}
然后,通过RealInterceptorChain类来构建拦截器链。RealInterceptorChain实现了Interceptor.Chain接口,它维护了一个拦截器列表和当前执行到的拦截器索引。
在proceed()方法中,会依次调用每个拦截器的intercept()方法。当一个拦截器的intercept()方法被调用时,它可以对请求进行处理,然后通过调用chain.proceed(request)将请求传递给下一个拦截器。当下一个拦截器处理完响应后,会将响应返回给当前拦截器,当前拦截器可以再次对响应进行处理后返回。
例如,在LoggingInterceptor中,先记录请求信息,然后调用chain.proceed(request)将请求传递给下一个拦截器,在接收到响应后,记录响应时间并返回响应。通过这种方式,拦截器链实现了功能的层层叠加,使得开发者可以方便地对请求和响应进行定制化处理。
(四)连接管理
连接池的实现原理
连接池(ConnectionPool)是 OkHttp 实现连接复用的关键组件。它内部维护了一个连接队列connections,用于存储已经建立的连接。当有新的请求需要建立连接时,首先会在连接池中查找是否有可用的空闲连接。如果找到,则直接复用该连接,而不需要重新建立连接,从而减少了连接建立的开销。
连接池采用了一种空闲连接回收机制。每个连接都有一个空闲时间戳,当连接被使用后,会更新其空闲时间戳。连接池会定期检查连接队列中的连接,对于空闲时间超过一定阈值(默认 5 分钟)的连接,会将其从连接池中移除并关闭。代码如下:
public void evictAll() {
List<RealConnection> connections;
synchronized (this) {
connections = new ArrayList<>(connections);
connections.addAll(idleConnections);
idleConnections.clear();
this.connections.clear();
}
for (RealConnection connection : connections) {
connection.noNewStreams();
connection.cancelAll();
}
}
同时,连接池还会限制最大连接数。默认情况下,连接池的最大空闲连接数为 5 个。当连接池中的连接数达到最大空闲连接数时,如果再有新的请求需要建立连接且没有可用的空闲连接,则会根据策略决定是否创建新的连接或者等待已有连接释放。
连接池性能优化配置
开发者可以通过OkHttpClient.Builder对连接池进行配置,以优化性能。例如,可以调整连接池的最大空闲连接数和空闲连接的存活时间。如果应用中网络请求频繁且连接复用率较高,可以适当增加最大空闲连接数,以提高连接复用的机会。代码如下:
ConnectionPool connectionPool = new ConnectionPool(10, 10, TimeUnit.MINUTES);
OkHttpClient client = new OkHttpClient.Builder()
.connectionPool(connectionPool)
.build();
这里将连接池的最大空闲连接数设置为 10 个,空闲连接的存活时间设置为 10 分钟。通过合理配置这些参数,可以根据应用的实际业务场景和网络请求特点,优化连接池的性能,提高网络请求的效率。
五、OkHttp 原理深入探讨
(一)HTTP 协议支持
HTTP/1.1 和 HTTP/2 的支持
OkHttp 对 HTTP/1.1 和 HTTP/2 协议均提供了良好的支持。在 HTTP/1.1 协议中,它遵循标准的请求 - 响应模型。每个请求都需要建立一个新的 TCP 连接(在非持久连接情况下),或者复用已有的连接(持久连接)。
OkHttp 通过连接池机制来优化 HTTP/1.1 的连接复用,减少了连接建立的开销。例如,在一个频繁请求同一服务器的应用中,连接池可以避免每次请求都重新建立 TCP 连接,从而提高了请求效率。
对于 HTTP/2 协议,OkHttp 充分利用了其新特性。HTTP/2 采用了多路复用技术,允许在一个 TCP 连接上同时发送多个请求和响应,避免了队头阻塞问题。OkHttp 通过内部的协议处理逻辑,能够高效地在 HTTP/2 连接上进行数据的传输和交互。
例如,在加载一个包含多个资源(如图像、脚本、样式表等)的网页时,HTTP/2 的多路复用特性使得这些资源可以同时在一个连接上进行请求和下载,大大缩短了页面的加载时间。
此外,HTTP/2 还支持头部压缩,通过 HPACK 算法对请求和响应的头部进行压缩,减少了头部传输的开销。OkHttp 在处理 HTTP/2 请求时,会自动应用头部压缩功能,进一步提升了数据传输的效率。
协议特性优化
根据不同的协议特性,OkHttp 进行了针对性的优化。在 HTTP/1.1 中,为了提高连接复用率,OkHttp 会根据请求的目标服务器地址、端口等信息,在连接池中查找可复用的连接。如果找到匹配的空闲连接,则直接复用;否则,根据连接池的策略决定是否创建新连接。同时,对于持久连接,OkHttp 会在请求完成后,将连接保留在连接池中,以便后续请求复用。
在 HTTP/2 中,除了利用多路复用和头部压缩特性外,OkHttp 还对流量控制进行了优化。HTTP/2 的流量控制机制允许接收方控制发送方的数据发送速率,以避免接收方缓冲区溢出。
OkHttp 通过内部的流量控制算法,根据网络状况和接收方的处理能力,动态调整数据的发送速率,确保数据传输的稳定性和高效性。例如,当网络带宽较低或者接收方处理能力有限时,OkHttp 会适当降低数据发送速率,防止数据丢失和网络拥塞。
(二)网络请求优化策略
连接复用
连接复用是 OkHttp 最核心的优化策略之一。如前所述,通过连接池机制,OkHttp 能够复用已有的网络连接,减少连接建立和断开的开销。连接池会对连接进行管理,当一个连接被使用后,会将其标记为繁忙状态,在请求完成后,将其放回连接池并标记为空闲状态。当下一个请求到来时,优先从连接池中查找可用的空闲连接。这种机制在网络请求频繁的应用中效果显著,大大降低了网络延迟,提高了应用的响应速度。例如,在一个电商应用中,用户浏览商品详情、添加商品到购物车等操作都需要频繁地与服务器进行交互,连接复用可以使得这些操作更加流畅,减少等待时间。
缓存机制
OkHttp 提供了灵活的缓存机制。它可以根据服务器返回的响应头信息,如Cache - Control和Expires,来决定是否缓存响应数据以及缓存的有效期。
当一个请求被发起时,OkHttp 首先会检查缓存中是否有对应的有效缓存数据。如果有,则直接从缓存中读取数据并返回给应用,而不需要再次向服务器发送请求。这在数据更新频率不高的场景下,可以显著减少网络流量和请求时间。
例如,对于一些新闻资讯类应用,文章内容在一段时间内不会频繁更新,OkHttp 可以利用缓存机制,在用户再次访问相同页面时,快速从缓存中获取数据,提升用户体验。
缓存机制的实现涉及到多个拦截器的协同工作。CacheInterceptor在拦截器链中负责处理缓存相关的逻辑。它会在请求发送前检查缓存中是否有可用的响应,如果有且未过期,则直接返回缓存的响应;在响应接收后,根据响应头信息决定是否将响应数据缓存到本地。
同时,OkHttp 还支持自定义缓存策略,开发者可以通过实现Cache接口来定制自己的缓存逻辑,满足不同应用场景的需求。
Gzip 压缩
Gzip 压缩是 OkHttp 提高数据传输效率的另一个重要策略。当服务器支持 Gzip 压缩时,OkHttp 会在请求头中添加Accept - Encoding: gzip字段,告知服务器客户端支持 Gzip 压缩。服务器在响应时会对数据进行 Gzip 压缩,OkHttp 接收到压缩后的数据后,会在网络拦截器中对数据进行解压缩。
例如,在GzipInterceptor中,会检查响应头中的Content - Encoding字段,如果为gzip,则对响应体进行解压缩操作。
通过 Gzip 压缩,数据在网络传输过程中的大小可以大幅减小,从而减少了传输时间,提高了应用的性能。尤其在网络带宽有限的情况下,Gzip 压缩能够有效地提升数据传输的速度,改善用户体验。
(三)异常处理机制
异常类型及处理方式
在 OkHttp 的请求过程中,可能会出现多种类型的异常。常见的异常包括IOException及其子类,如SocketTimeoutException(连接超时或读取超时)、ConnectException(连接失败)、UnknownHostException(无法解析主机名)等。
当发生异常时,OkHttp 会根据异常类型进行不同的处理。对于SocketTimeoutException,通常是由于网络连接不稳定或者服务器响应缓慢导致。OkHttp 在默认情况下,会根据设置的超时时间(如连接超时时间、读取超时时间)来判断是否超时。
如果超时,会抛出SocketTimeoutException,开发者可以在捕获该异常后,提示用户网络连接超时,建议用户检查网络设置或者稍后重试。
对于ConnectException,可能是由于网络不可达、服务器地址错误或者服务器拒绝连接等原因导致。OkHttp 在尝试建立连接失败时会抛出该异常,开发者可以通过异常信息进行排查,例如检查服务器地址是否正确,网络是否正常连接等。
UnknownHostException通常是由于无法解析主机名,可能是 DNS 解析失败或者主机名拼写错误。OkHttp 在进行 DNS 解析时如果遇到问题,会抛出该异常,开发者可以检查网络配置中的 DNS 设置,或者确认主机名是否正确。
自定义异常处理机制
为了提升应用的健壮性,开发者可以自定义异常处理机制。通过在拦截器中捕获异常,并进行统一的处理和封装,可以将复杂的异常信息转化为更友好、易于理解的错误提示。
例如,可以创建一个自定义的异常类NetworkException,在拦截器中捕获各种 OkHttp 异常,并根据异常类型创建NetworkException实例,同时添加详细的错误描述信息。
class CustomExceptionInterceptor implements Interceptor {
@Override
public Response intercept(Chain chain) throws IOException {
try {
return chain.proceed(chain.request());
} catch (IOException e) {
throw new NetworkException("Network error occurred: " + e.getMessage(), e);
}
}
}
然后在应用的全局异常处理机制中,统一捕获NetworkException,并根据错误描述信息向用户展示相应的错误提示,如 “网络连接失败,请检查网络设置” 等。
这样可以使应用在面对各种网络异常时,能够以更友好、统一的方式向用户反馈问题,提升用户体验。同时,通过自定义异常处理机制,还可以方便地记录异常日志,便于开发者在后续进行问题排查和优化。
六、总结
(一)文章回顾
在本文中,我们全面且深入地探索了 Android OkHttp 框架。从基础使用出发,详细阐述了引入依赖的方法,以及如何进行简单的 GET、POST 请求,同时涵盖了 PUT、DELETE 等其他请求方法的运用。在请求构建过程中,对请求头和请求参数的设置进行了细致讲解,让开发者能够根据不同的业务需求灵活定制请求。
深入到 OkHttp 的核心组件,我们剖析了 OkHttpClient 在管理请求执行和配置参数方面的关键作用,了解了 Request 和 RequestBody 如何封装请求信息与数据,明白了 Response 和 ResponseBody 怎样承载并处理服务器响应,也掌握了 Call 在请求生命周期管理和取消操作中的原理。
通过对 OkHttp 源码的解析,我们梳理了其初始化过程中组件的构建与配置,深入追踪了请求执行流程,包括请求的创建、调度以及同步和异步执行的具体实现细节。同时,着重研究了拦截器机制,理解了应用拦截器和网络拦截器的功能与执行顺序,以及它们如何通过拦截器链实现强大的请求和响应处理功能。此外,对连接管理的连接池实现原理和性能优化配置也有了清晰的认识。
在原理深入探讨部分,明确了 OkHttp 对 HTTP/1.1 和 HTTP/2 协议的支持方式及特性优化,详细介绍了网络请求优化策略中的连接复用、缓存机制和 Gzip 压缩等重要手段,以及异常处理机制中各类异常的类型、处理方式和自定义异常处理的实现方法。
(二)实践建议
在实际项目中应用 OkHttp 时,开发者可以遵循以下最佳实践建议。首先,要合理配置 OkHttpClient 的参数。根据应用的网络请求特点,设置合适的连接超时时间、读取超时时间和写入超时时间,避免因超时设置不合理导致请求失败或等待时间过长。同时,根据网络请求的频繁程度和连接复用需求,优化连接池的配置,如调整最大空闲连接数和空闲连接存活时间,以提高连接复用率,降低连接建立的开销。
要注重网络请求的优化。充分利用 OkHttp 的缓存机制,根据数据的更新频率和重要性,合理设置缓存策略。对于一些静态数据或更新不频繁的数据,启用缓存可以显著减少网络请求次数,提高应用的响应速度。同时,在数据传输过程中,合理使用 Gzip 压缩,减小数据传输量,尤其是在网络带宽有限的情况下,这一优化策略能有效提升应用性能。
建议开发者积极利用 OkHttp 的拦截器机制进行自定义扩展。通过自定义拦截器,可以方便地实现一些通用的功能,如日志记录、请求重试、请求头和响应头的统一处理等。这样不仅可以提高代码的复用性,还能使代码结构更加清晰,便于维护和管理。同时,在自定义异常处理机制方面,要确保异常信息的准确性和友好性,为用户提供清晰的错误提示,提升应用的用户体验。
通过深入理解 OkHttp 框架的使用方法、原理以及未来发展趋势,并遵循实践建议进行合理应用和优化,开发者能够充分发挥 OkHttp 的优势,打造出高性能、稳定且用户体验良好的 Android 应用。