OkHttp 是一个开源项目。它由 Square 开发并维护，是一个现代化、功能强大的网络请求库，主要用于与 RESTful API 交互或执行网络通信操作。它是 Android 和 Java 开发中非常流行的 HTTP 客户端，具有高效、可靠、可扩展的特点。
核心特点
- 高效的连接复用： OkHttp 支持 HTTP/2，能够通过一个单独的连接发送所有的并发请求，从而减少延迟。
- 自动处理 GZIP： OkHttp 会自动压缩和解压缩请求和响应的内容，减少带宽使用。
- 缓存机制： 内置响应缓存支持，可根据 HTTP 协议头决定是否可以缓存和复用响应。
- 支持拦截器： 开发者可以通过拦截器自定义请求和响应，便于统一处理日志、重试等逻辑。
- 超时设置： 提供连接、读取、写入的超时设置，防止长时间阻塞。
- 异步与同步调用： OkHttp 提供同步和异步两种请求模式，满足不同的场景需求。
OkHttp 的基本架构
- OkHttpClient： OkHttp 的核心类，用于配置和发送网络请求。
- Request： 表示一个 HTTP 请求，包含 URL、请求头、请求方法和请求体等。
- Response： 表示一个 HTTP 响应，包含状态码、响应头和响应体等。
- 拦截器（Interceptor）： 提供对请求和响应的拦截功能，可在链式调用中进行修改或记录。
- 连接池： 管理网络连接的复用，减少连接建立的开销。
基本使用示例
1. 同步 GET 请求
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://jsonplaceholder.typicode.com/posts/1")
.build();
try (Response response = client.newCall(request).execute()) {
if (response.isSuccessful()) {
System.out.println(response.body().string());
} else {
System.out.println("Request failed: " + response.code());
}
} catch (IOException e) {
e.printStackTrace();
}
2. 异步 GET 请求
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://jsonplaceholder.typicode.com/posts/1")
.build();
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 {
if (response.isSuccessful()) {
System.out.println(response.body().string());
} else {
System.out.println("Request failed: " + response.code());
}
}
});
3. POST 请求
OkHttpClient client = new OkHttpClient();
MediaType JSON = MediaType.get("application/json; charset=utf-8");
RequestBody body = RequestBody.create("{\"title\": \"foo\", \"body\": \"bar\", \"userId\": 1}", JSON);
Request request = new Request.Builder()
.url("https://jsonplaceholder.typicode.com/posts")
.post(body)
.build();
try (Response response = client.newCall(request).execute()) {
if (response.isSuccessful()) {
System.out.println(response.body().string());
} else {
System.out.println("Request failed: " + response.code());
}
} catch (IOException e) {
e.printStackTrace();
}
高级功能
1. 添加拦截器
OkHttpClient client = new OkHttpClient.Builder()
.addInterceptor(chain -> {
Request request = chain.request();
long t1 = System.nanoTime();
System.out.println(String.format("Sending request %s", request.url()));
Response response = chain.proceed(request);
long t2 = System.nanoTime();
System.out.println(String.format("Received response for %s in %.1fms",
response.request().url(), (t2 - t1) / 1e6d));
return response;
})
.build();
2. 配置超时
OkHttpClient client = new OkHttpClient.Builder()
.connectTimeout(10, TimeUnit.SECONDS)
.readTimeout(20, TimeUnit.SECONDS)
.writeTimeout(15, TimeUnit.SECONDS)
.build();
3. 缓存支持
int cacheSize = 10 * 1024 * 1024; // 10 MB
Cache cache = new Cache(new File("cacheDirectory"), cacheSize);
OkHttpClient client = new OkHttpClient.Builder()
.cache(cache)
.build();
常见问题
- 内存泄漏问题： OkHttpClient 是线程安全的，可以全局复用。如果频繁创建 OkHttpClient 实例可能会导致资源浪费或内存泄漏。
- 网络请求失败： 确保网络权限已在 AndroidManifest 文件中声明：
<uses-permission android:name="android.permission.INTERNET" />
总结
OkHttp 是 Android 网络通信的核心工具之一，功能全面且高效。通过学习和掌握其基本用法及高级特性，可以大大提升网络请求开发的效率和稳定性。
