okhttp 使用

OkHttp 是一个强大的开源 HTTP 客户端库，由 Square 公司开发，广泛用于 Android 和 Java 应用程序中。它提供了简洁的 API 和丰富的功能，使得开发者能够轻松地处理 HTTP 请求和响应。OkHttp 支持同步和异步请求，能够自动处理连接池、缓存、重试、GZIP 压缩等功能，同时还支持 WebSocket 和 HTTP/2 协议。本文将详细介绍 OkHttp 的使用方法、核心功能以及一些高级特性。

1. OkHttp 的基本使用

1.1 添加依赖

在使用 OkHttp 之前，首先需要在项目中添加 OkHttp 的依赖。如果你使用的是 Gradle 构建工具，可以在 build.gradle 文件中添加以下依赖：

dependencies {
    implementation 'com.squareup.okhttp3:okhttp:4.9.3'
}

1.2 创建 OkHttpClient 实例

OkHttp 的核心类是 OkHttpClient，它负责管理所有的 HTTP 请求。通常情况下，一个应用程序只需要一个 OkHttpClient 实例，因为它内部已经处理了连接池和线程池等资源。

OkHttpClient client = new OkHttpClient();

1.3 发送同步请求

要发送一个同步的 HTTP 请求，可以使用 OkHttpClient 的 newCall 方法，并通过 execute 方法执行请求。同步请求会阻塞当前线程，直到收到响应。

Request request = new Request.Builder()
    .url("https://www.example.com")
    .build();

try (Response response = client.newCall(request).execute()) {
    if (response.isSuccessful()) {
        String responseBody = response.body().string();
        System.out.println(responseBody);
    }
} catch (IOException e) {
    e.printStackTrace();
}

1.4 发送异步请求

异步请求不会阻塞当前线程，而是通过回调函数处理响应。可以使用 enqueue 方法来发送异步请求。

Request request = new Request.Builder()
    .url("https://www.example.com")
    .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()) {
            String responseBody = response.body().string();
            System.out.println(responseBody);
        }
    }
});

2. OkHttp 的核心功能

2.1 请求和响应

OkHttp 的 Request 类用于构建 HTTP 请求，可以设置 URL、请求方法（GET、POST 等）、请求头、请求体等。Response 类则用于表示 HTTP 响应，包含状态码、响应头、响应体等信息。

// 构建 POST 请求
RequestBody requestBody = new FormBody.Builder()
    .add("username", "admin")
    .add("password", "123456")
    .build();

Request request = new Request.Builder()
    .url("https://www.example.com/login")
    .post(requestBody)
    .build();

// 发送请求并处理响应
try (Response response = client.newCall(request).execute()) {
    if (response.isSuccessful()) {
        String responseBody = response.body().string();
        System.out.println(responseBody);
    }
} catch (IOException e) {
    e.printStackTrace();
}

2.2 连接池和连接复用

OkHttp 内部维护了一个连接池，能够复用已经建立的连接，从而减少建立新连接的开销。默认情况下，OkHttp 会复用最多 5 个空闲连接，每个连接最多保持 5 分钟的活跃时间。

2.3 缓存

OkHttp 支持 HTTP 缓存，可以通过配置 Cache 类来启用缓存功能。缓存可以显著提高应用程序的性能，尤其是在需要频繁请求相同资源的情况下。

int cacheSize = 10 * 1024 * 1024; // 10 MB
Cache cache = new Cache(new File("cacheDir"), cacheSize);

OkHttpClient client = new OkHttpClient.Builder()
    .cache(cache)
    .build();

2.4 拦截器

拦截器是 OkHttp 的一个强大功能，允许开发者在请求和响应的处理过程中插入自定义逻辑。常见的用途包括日志记录、请求重试、身份验证等。

OkHttpClient client = new OkHttpClient.Builder()
    .addInterceptor(new Interceptor() {
        @Override
        public Response intercept(Chain chain) throws IOException {
            Request request = chain.request();
            // 在请求前添加自定义逻辑
            System.out.println("Sending request to: " + request.url());

            Response response = chain.proceed(request);
            // 在响应后添加自定义逻辑
            System.out.println("Received response from: " + response.request().url());

            return response;
        }
    })
    .build();

3. OkHttp 的高级特性

3.1 WebSocket 支持

OkHttp 提供了对 WebSocket 协议的支持，允许客户端与服务器进行全双工通信。通过 WebSocket 接口，开发者可以轻松地处理 WebSocket 连接、发送和接收消息。

Request request = new Request.Builder()
    .url("wss://www.example.com/websocket")
    .build();

WebSocket webSocket = client.newWebSocket(request, new WebSocketListener() {
    @Override
    public void onOpen(WebSocket webSocket, Response response) {
        System.out.println("WebSocket connection opened");
        webSocket.send("Hello, Server!");
    }

    @Override
    public void onMessage(WebSocket webSocket, String text) {
        System.out.println("Received message: " + text);
    }

    @Override
    public void onClosed(WebSocket webSocket, int code, String reason) {
        System.out.println("WebSocket connection closed");
    }

    @Override
    public void onFailure(WebSocket webSocket, Throwable t, Response response) {
        t.printStackTrace();
    }
});

3.2 HTTP/2 支持

OkHttp 支持 HTTP/2 协议，能够通过单个连接并行处理多个请求，从而提高性能。HTTP/2 还支持服务器推送、头部压缩等特性。

3.3 自定义 DNS 解析

OkHttp 允许开发者自定义 DNS 解析逻辑，这在某些特殊场景下非常有用，例如在测试环境中模拟不同的 DNS 解析结果。

OkHttpClient client = new OkHttpClient.Builder()
    .dns(new Dns() {
        @Override
        public List<InetAddress> lookup(String hostname) throws UnknownHostException {
            if ("example.com".equals(hostname)) {
                return Arrays.asList(InetAddress.getByName("127.0.0.1"));
            }
            return Dns.SYSTEM.lookup(hostname);
        }
    })
    .build();

4. 总结

OkHttp 是一个功能强大且易于使用的 HTTP 客户端库，适用于各种 Java 和 Android 应用程序。它提供了丰富的功能，如连接池、缓存、拦截器、WebSocket 支持等，能够显著提高应用程序的性能和开发效率。无论是处理简单的 HTTP 请求，还是实现复杂的网络通信逻辑，OkHttp 都是一个值得信赖的选择。通过掌握 OkHttp 的基本使用和高级特性，开发者可以更加灵活地应对各种网络编程需求。