OkHttpClient使用详细教程

OkHttpClient 是一个由 Square 公司开发的 HTTP 客户端库，用于在 Android 和 Java 应用中进行网络请求，它支持同步和异步请求、连接池、超时设置、拦截器等功能，适合用于高性能网络请求，特别是在需要处理复杂的网络操作时，本文将详细介绍OkHttpClient的主要特点、使用方法以及在实际项目中的应用。

OKHttpClient介绍

主要特点

同步和异步请求：同步请求会在当前线程等待响应，适合不需要并发的简单请求，异步请求会将网络操作交由后台线程处理，不会阻塞主线程，适合需要并发处理或在Android等环境中使用。

连接池：OkHttp默认会使用连接池来复用HTTP连接，从而提高性能，减少连接的建立和关闭的开销。

拦截器 (Interceptor)：拦截器允许在请求和响应时进行操作，例如可以在请求发送前添加认证信息，或在响应到达后进行日志记录。

自动处理HTTP/2 和 SPDY：OkHttp默认支持HTTP/2协议，可以提升多路复用性能，使多个请求共享一个TCP连接。

缓存机制：OkHttp提供了默认的缓存机制，可以根据HTTP响应头自动缓存请求结果，减少重复网络请求。

超时控制：可以对连接、读取和写入操作分别设置超时，避免长时间无响应的请求卡住应用。

在实际项目中的应用

引入maven配置

<!-- ok的Http连接池 -->
<dependency>
    <groupId>com.squareup.okhttp3</groupId>
    <artifactId>okhttp</artifactId>
    <version>4.9.3</version>
</dependency>

自定义HttpUtils工具类

下面是一个简单的OkHttpUtils工具类示例，包括基本的GET和POST请求方法：

import com.alibaba.fastjson.JSONObject;
import com.yan.project.httpUtils.okHttp2.HttpRequestBody;
import lombok.extern.slf4j.Slf4j;
import okhttp3.*;
import java.io.Closeable;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.concurrent.TimeUnit;
@Slf4j
public class OkHttpUtils {
    private OkHttpUtils() {
        throw new IllegalArgumentException("Utility class");
    }
    private static final String MIME_JSON = "application/json; charset=utf-8";
    private static OkHttpClient httpClient = new OkHttpClient.Builder()
            .connectTimeout(3, TimeUnit.SECONDS)
            .writeTimeout(5, TimeUnit.SECONDS)
            .readTimeout(5, TimeUnit.SECONDS)
            .addInterceptor((Interceptor.Chain chain) -> {
                Request req = chain.request();
                try {
                    Response res = chain.proceed(req);
                    return res;
                } catch (Exception ex) {
                    throw ex;
                }
            })
            .build();
    // GET-无参
    public static String getJson(String url) throws IOException {
        return basicGet(url, null);
    }
    // GET-有参
    public static String get(String url, Map<String, Object> paramMap) throws Exception {
        StringBuilder sb = new StringBuilder(url);
        if (paramMap != null && !paramMap.isEmpty()) {
            Set<String> keySet = paramMap.keySet();
            for (String key : keySet) {
                sb.append(sb.toString().contains("?") ? "&" : "?");
                sb.append(key).append("=").append(paramMap.get(key));
            }
            url = sb.toString();
        }
        return basicGet(url, null);
    }
    // ...其他方法和实现...
}

相关FAQs

1、问：如何设置OkHttpClient的超时时间？

答：可以通过OkHttpClient.Builder类的connectTimeout、readTimeout和writeTimeout方法分别设置连接超时、读取超时和写入超时。.connectTimeout(3, TimeUnit.SECONDS)表示连接超时时间为3秒。

2、问：如何在OkHttpClient中使用拦截器？

答：可以通过OkHttpClient.Builder类的addInterceptor方法添加拦截器，拦截器可以在请求发送前和响应接收后执行一些操作，例如添加认证信息或进行日志记录。.addInterceptor((Interceptor.Chain chain) -> {...})表示添加一个拦截器。