OkHttpClient常见方法和使用

🌺个人主页：杨永杰825_Spring,Mysql,多线程-CSDN博客

?每日一句：成为架构师路途遥远

📢欢迎大家：关注🔍+点赞👍+评论📝+收藏??

目录

前言

功能

使用

拦截器

缓存

---

?

前言

• OkHttpClient是一个开源的HTTP客户端，用于发送和接收HTTP请求。它是Square公司开发的，用于Android和Java应用程序的网络库。
• OkHttpClient内置了很多功能，包括连接池、请求和响应拦截器、TLS握手、请求重试等。它易于使用，具有简洁的API，同时还提供了丰富的配置选项，以适应不同的网络需求。
• 使用OkHttpClient，开发人员可以轻松地创建和发送GET、POST、PUT、DELETE等类型的HTTP请求，并处理响应。还可以设置超时时间、添加请求头、上传文件、下载文件等。
• OkHttpClient还支持异步请求和同步请求，开发人员可以根据自己的需求选择合适的方式。
• 总之，OkHttpClient是一个功能强大、灵活性高的HTTP客户端，广泛应用于Android和Java开发中，是现代应用程序开发不可或缺的一部分。

功能

OkHttpClient?是一个流行的 Java 网络库，用于构建高效、可靠和灵活的 HTTP 客户端。它是 Square 公司开发的，并被广泛用于?Android?和其他 Java 应用程序中。

OkHttpClient?提供了以下主要功能：

1. 线程安全：OkHttpClient?是线程安全的，可以在多个线程中安全地使用。

2. 强大的配置：通过设置各种参数，你可以微调OkHttpClient的行为，如超时、缓存策略、代理等。

3. 拦截器：你可以使用拦截器来拦截和处理 HTTP 请求和响应，进行日志记录、请求头和响应头处理、缓存控制等。

4. 灵活的请求构建：OkHttpClient?提供了方便的方法来构建和发送 HTTP 请求，包括 GET、POST、PUT、DELETE 等常见方法。

5. 响应处理：你可以轻松地解析 HTTP 响应，获取响应状态码、响应头和响应体。

6. 缓存支持：OkHttpClient?内置了对 HTTP 缓存的支持，包括缓存控制头和缓存策略。

7. 证书管理：OkHttpClient?可以处理 SSL/TLS 证书，包括证书验证和信任链管理。

使用

要使用?OkHttpClient，你需要先导入相关的依赖。以下是一个基本的示例，展示如何创建和使用?OkHttpClient：

import okhttp3.OkHttpClient;

public class Main {
    public static void main(String[] args) {
        // 创建 OkHttpClient 对象
        OkHttpClient client = new OkHttpClient();

        // 执行 HTTP 请求
        String response = client.newCall(new Request.Builder()
                .url("https://www.example.com")
                .build())
                .execute()
                .body()
                .string();
    }
}

• ?在上面的示例中，首先创建了一个?OkHttpClient?对象。然后，使用?Request.Builder?来构建一个 HTTP 请求，并通过?client.newCall()?方法发送请求。最后，使用?response.body().string()?来获取响应体的字符串表示。
• OkHttpClient?提供了丰富的功能和灵活性，使你能够轻松处理 HTTP 通信。你可以根据自己的需求进行进一步的配置和扩展。

拦截器

在?OkHttpClient?中添加拦截器可以通过以下步骤完成：

1. 创建一个实现了?Interceptor?接口的类，用于定义拦截器的逻辑。

2. 在拦截器类中实现?intercept?方法，该方法接收?Chain?对象，并可以对请求和响应进行操作。

3. 将创建的拦截器实例添加到?OkHttpClient?的?interceptors?列表中。

以下是一个示例代码，展示如何创建一个简单的拦截器并将其添加到?OkHttpClient?中

import okhttp3.Interceptor;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;

public class CustomInterceptor implements Interceptor {

    @Override
    public Response intercept(Chain chain) throws IOException {
        // 在这里可以对请求和响应进行操作
        Request request = chain.request();
        Response response = chain.proceed(request);

        // 可以修改请求头或响应头
        request.header("Custom-Header", "Custom-Value");

        return response;
    }
}

public class Main {

    public static void main(String[] args) {
        // 创建 OkHttpClient 对象
        OkHttpClient client = new OkHttpClient.Builder()
                .addInterceptor(new CustomInterceptor())
                .build();

        // 执行 HTTP 请求
        String response = client.newCall(new Request.Builder()
                .url("https://www.example.com")
                .build())
                .execute()
                .body()
                .string();
    }
}

1. 在上面的示例中，创建了一个名为?CustomInterceptor?的拦截器类，并实现了?intercept?方法。在该方法中，可以对请求和响应进行操作，例如添加自定义的请求头或修改响应头。
2. 然后，在?Main?类中创建了一个?OkHttpClient?对象，并通过?addInterceptor?方法将自定义的拦截器添加到其中。
3. 最后，使用?OkHttpClient?执行了一个 HTTP 请求，并获取了响应结果。
4. 你可以根据自己的需求创建多个拦截器，并按照需要添加到?OkHttpClient?中，以实现对请求和响应的定制化处理。

缓存

要使用OkHttpClient的缓存功能，首先需要在OkHttpClient的构建器中设置缓存，然后在请求中指定缓存策略。OkHttpClient只会对get请求进行缓存，post请求不会进行缓存。以下是一个使用OkHttpClient缓存功能的简单示例：?

import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.CacheControl;
import okhttp3.Response;

public class Main {
    public static void main(String[] args) {
        // 创建 OkHttpClient 对象
        OkHttpClient client = new OkHttpClient();

        // 设置缓存目录和最大缓存大小
        String cacheDirectory = Environment.getExternalStorageDirectory() + "/okttpcaches";
        long cacheSize = 1024 * 1024 * 20;
        Cache cache = new Cache(new File(cacheDirectory), cacheSize);

        // 设置连接超时时间、写入超时时间和读取数据超时时间
        OkHttpClient.Builder builder = new OkHttpClient.Builder();
        builder.connectTimeout(8, TimeUnit.SECONDS);
        builder.writeTimeout(8, TimeUnit.SECONDS);
        builder.readTimeout(8, TimeUnit.SECONDS);
        builder.retryOnConnectionFailure(true);
        builder.cache(cache);

        // 构建并获取 OkHttpClient 对象
        client = builder.build();

        // 执行 GET 请求并使用缓存
        String url = "https://www.example.com";
        Call call = DoGetAndCache(url, 10, new NetWorkResponseListener());
        startRequest(call, null);
    }

    // GET 请求并使用缓存的方法
    public static Call DoGetAndCache(String url, int cache_maxAge_inSeconds, final NetWorkResponseListener responseListener) {
        Request request = new Request.Builder()
                .cacheControl(new CacheControl.Builder().maxAge(cache_maxAge_inSeconds, TimeUnit.SECONDS).build())
                .url(url).build();
        Call call = client.newCall(request);
        startRequest(call, responseListener);
        return call;
    }
}

在上述代码中，首先设置了缓存目录和最大缓存大小，然后在OkHttpClient的构建器中设置了缓存。接下来，通过执行DoGetAndCache方法来执行GET请求并使用缓存。在DoGetAndCache方法中，使用CacheControl.Builder来构建缓存控制策略，并将其添加到请求中。最后，通过client.newCall(request)方法发送请求，并使用startRequest方法启动请求并处理响应。