OKHttp使用详解

最新推荐文章于 2025-02-27 16:21:47 发布

瞎胡扯

最新推荐文章于 2025-02-27 16:21:47 发布

阅读量6.5k

点赞数 4

分类专栏： HTTP 文章标签： java 缓存 http

本文链接：https://blog.csdn.net/small_love/article/details/122544111

版权

HTTP 专栏收录该内容

6 篇文章

订阅专栏

1、简介

OkHttp 是一个默认高效的 HTTP 客户端：

HTTP/2 支持允许对同一主机的所有请求共享一个套接字。
连接池减少了请求延迟（如果 HTTP/2 不可用）。
透明 GZIP 缩小了下载大小。
响应缓存完全避免了网络重复请求。

2、引入依赖

<dependency>
   <groupId>com.squareup.okhttp3</groupId>
   <artifactId>okhttp</artifactId>
    <version>4.9.0</version>
</dependency>

3、获取 OkHttpClient 对象

在使用 OkHttp 发送 HTTP 请求时，首先需要获取一个 OkHttpClient 对象，获取 OkHttpClient 对象的方式很简单，在 OkHttp 中大量使用了 Builder 模式。获取 OkHttpClient 对象的方法如下所示：

获取默认配置对象

// 获取默认配置 的OkHttpClient 对象
OkHttpClient httpClient = new OkHttpClient.Builder().build();

获取自定配置对象

在获取对象时可以指定，连接超时、读写超时、拦截器等配置，如下所示：

OkHttpClient httpClient = new OkHttpClient.Builder()
    // 设置连接超时时间
    .connectTimeout(Duration.ofSeconds(30))
    // 设置读超时时间
    .readTimeout(Duration.ofSeconds(60))
    // 设置写超时时间
    .writeTimeout(Duration.ofSeconds(60))
    // 设置完整请求超时时间
    .callTimeout(Duration.ofSeconds(120))
    // 添加一个拦截器
    .addInterceptor(chain -> {
        Request request = chain.request();
        return chain.proceed(request);
    })
    // 注册事件监听器
    .eventListener(new EventListener() {
        @Override
        public void callEnd(@NotNull Call call) {
            LOGGER.info("----------callEnd--------");
            super.callEnd(call);
        }
    })
    .build();

4、GET 请求

GET 请求的执行步骤如下：

构造 Request 对象

// 构造一个 Request 对象
Request request = new Request.Builder()
                // 标识为 GET 请求
                .get()
                // 设置请求路径
                .url("http://localhost:10010/user/map?name=zhangsan&a=a&age=20")
                // 添加头信息
                .addHeader("Content-Type", "text/plain")
                .build();

将 Request 封装为 Call

// 通过 HttpClient 把 Request 构造为 Call 对象
Call call = httpClient.newCall(request);

执行请求 (同步或异步)

同步请求

// 执行同步请求
Response response = call.execute();

异步请求

call.enqueue(new Callback() {
    @Override
    public void onFailure(@NotNull Call call, @NotNull IOException e) {
        LOGGER.error("请求 {} 出现异常 {}", call.request().url(), e.getMessage());
    }

    @Override
    public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException {
        String body = response.body().toString();
        LOGGER.info("请求 {} 的响应结果为 {}", call.request().url(), body);
    }
});

5、POST 请求

POST 请求的构建步骤与GET 相似，区别是，在构建 Request 对象时在post() 方法中，设置需要发送的数据，发送的数据可为目前流行的 JSON 格式数据，也可以模拟 Form表单提交的数据，操作如下所示：

构建Form表单数据

// 构造 Form 表单对象
FormBody formBody = new FormBody.Builder()
    .addEncoded("name", "张三")
    .add("age", "20")
    .add("a", "ag")
    .build();

构造 JSON 数据

// 创建 JSON 对象
JSONObject json = new JSONObject();
json.put("name", "张三");
json.put("age", 20);

// 构造 Content-Type 头
MediaType mediaType = MediaType.parse("application/json; charset=UTF-8");

// 构造请求数据
RequestBody requestBody = RequestBody.create(json.toJSONString(), mediaType);

构造Request对象

// 构建 Request 对象
Request request = new Request.Builder()
    // post 方法中传入 构造的对象
    .post(formBody)
    .url("http://localhost:10010/user/obj")
    .build();

构建完Request对象后的步骤，就与GET 请求相似，构建 Call 对象然后，在发送同步或异步请求

6、上传

在OkHttp中进行文件的上传，是相当简单的，在发送 POST 请求时，只需要构造一个MultipartBody 对象即可，MultipartBody 对象可以发送文件数据，也可以发送基本类型的数据。

 File file = new File("F:/20150703212056_Yxi4L.png");

// 使用 MultipartBody 构造 Request 对象
RequestBody multipartBody = new MultipartBody.Builder()
    //一定要设置这句
    .setType(MultipartBody.FORM)
    .addFormDataPart("name", "admin")//
    .addFormDataPart("password", "admin")//
    // 添加上传文件
    .addFormDataPart("file", "20150703212056_Yxi4L.png",
                     RequestBody.create( file, MediaType.parse("image/png")))
    .build();

// 构造 Request 对象
Request request = new Request.Builder()
    .post(multipartBody)
    .url("http://localhost:10010/user/upload")
    .build();

// 构造 Call 对象，并发送 同步请求
Call call = httpClient.newCall(request);
Response response = call.execute();