HttpUtils工具类（三）OKHttpClient使用详细教程

于 2024-09-05 15:52:51 发布
阅读量152 收藏 5
点赞数 6
分类专栏： HttpUtils 文章标签： 网络 java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_52767002/article/details/141810761
版权

OkHttpClient 是一个由 Square 公司开发的 HTTP 客户端库，用于在 Android 和 Java 应用中进行网络请求。它支持同步和异步请求、连接池、超时设置、拦截器等功能，适合用于高性能网络请求，特别是在需要处理复杂的网络操作时。

一、OKHttpClient介绍

主要特点

  1. 同步和异步请求：

    • 同步请求会在当前线程等待响应，适合不需要并发的简单请求。

    • 异步请求会将网络操作交由后台线程处理，不会阻塞主线程，适合需要并发处理或在 Android 等环境中使用。

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

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

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

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

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

二、在实际项目中的应用

（1）引入maven配置

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

（2）自定义HttpUtils工具类

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);
    }


    // GET-有参、有请求头
    public static String getWithHeades(String url, Map<String, Object> paramMap, Map<String, String> headers) 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, headers);
    }

    // GET-json
    public static String getJsonWithHeader(String url, Map<String, String> headerMap) throws IOException {
        Request.Builder request = new Request.Builder().url(url).get().header("Accept", MIME_JSON);
        if (headerMap != null) {
            headerMap.forEach(request::header);
        }
        try (Response response = httpClient.newCall(request.build()).execute()) {
            log.info("response_code:{}, response_body:{}", response.code(), response.body().string());
            return response.body().string();
        }
    }


    // POST-json传参
    public static String postJsonWithHeader(String url, Object reqBody, Map<String, String> headers) throws IOException {
        Request.Builder request = new Request.Builder()
                .url(url)
                .header("Accept", MIME_JSON)
                .post(FormBody.create(MediaType.parse(MIME_JSON), JSONObject.toJSONString(reqBody)));
        // 遍历并添加 header
        if (headers != null) {
            headers.forEach(request::header);
        }

        try (Response response = httpClient.newCall(request.build()).execute()) {
            log.info("response_code:{}, response_body:{}", response.code(), response.body().string());
            return response.body().string();
        }
    }

    // POST-param传参
    public static String postParamWithHeader(String url, Map<String, Object> paramMap, Map<String, String> headers) throws IOException {
        FormBody.Builder formBody = new FormBody.Builder();
        if (Objects.nonNull(paramMap)) {
            paramMap.forEach((k, v) -> formBody.add(k, (String) v));
        }

        Request.Builder request = new Request.Builder()
                .url(url)
                .header("Accept", MIME_JSON)
                .post(formBody.build());

        // 遍历并添加 header
        if (headers != null) {
            headers.forEach(request::header);
        }

        try (Response response = httpClient.newCall(request.build()).execute()) {
            log.info("response_code:{}, response_body:{}", response.code(), response.body().string());
            return response.body().string();
        }
    }

    public static final String octet_stream_str = "application/octet-stream";
    public static final MediaType octet_stream = MediaType.parse(octet_stream_str);

    public static void putStream(String url, InputStream inputStream, long contentLength) {
        Response response;
        try {
            RequestBody requestBody2 = new HttpRequestBody(inputStream, contentLength);

            Request request = new Request.Builder().url(url)
                    .addHeader("Content-Type", octet_stream_str)
                    .put(requestBody2)
                    .build();
            response = httpClient.newCall(request).execute();

            String result = response.body().string();
            if (response.code() != 200) {
                throw new Exception("Saturn SDK stream upload failed, url:" + url + "response.code():" + response.code() + ", msg:" + result);
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            closeQuietly(inputStream);
        }
    }


    public static String putFile(String url, File file) throws Exception {
        RequestBody requestBody = RequestBody.create(octet_stream, file);
        Request request = new Request.Builder().url(url)
                .addHeader("Content-Type", octet_stream_str)
                .put(requestBody).build();

        Response response = httpClient.newCall(request).execute();
        String result = response.body().string();
        int code = response.code();
        log.info("putFile end, url:{}, response.code:{}, result:{}", url, code, result);
        if (code != 200) {
            throw new Exception("putFile failed, response.code():" + code + ", result:" + result);
        }
        return result;
    }


    private static String basicGet(String url, Map<String, String> headers) throws IOException {
        Request.Builder builder = new Request.Builder()
                .url(url)
                .get();
        // 遍历并添加 header
        if (headers != null) {
            headers.forEach(builder::header);
        }

        try (Response response = httpClient.newCall(builder.build()).execute()) {
            return response.body().string();
        }
    }

    private static String basicDelete(String url, Headers headers) throws IOException {
        Request.Builder builder = new Request.Builder().url(url).delete();
        if (headers != null) {
            builder.headers(headers);
        }
        try (Response response = httpClient.newCall(builder.build()).execute()) {
            return response.body().string();
        }
    }

    public static void closeQuietly(Closeable is) {
        if (is != null) {
            try {
                is.close();
            } catch (Exception ex) {
                log.error("Resources encounter an exception when closing，ex：{}", ex.getMessage());
            }
        }
    }
}

这个 OkHttpUtils 类封装了 OkHttpClient 来进行 HTTP 请求，支持 GET、POST、PUT 等常见的 HTTP 方法，并提供了对参数、请求头、文件上传等功能的支持。以下是它的主要功能和使用方法的解释：

  1. OkHttpClient 实例

    • 使用 OkHttpClient.Builder() 创建，设置了超时时间（连接超时 3 秒，读写超时 5 秒），并添加了拦截器。

  2. 静态方法

    • getJson, get, getWithHeades, getJsonWithHeader：用于 GET 请求，支持无参、有参数和请求头的场景。

    • postJsonWithHeader, postParamWithHeader：用于 POST 请求，支持 JSON 数据或表单数据传递。

    • putStream, putFile：用于 PUT 请求，支持流和文件上传。

    • basicGet, basicDelete：内部通用方法，分别处理 GET 和 DELETE 请求。

三、拓展和使用建议

  • 增强错误处理：当前仅在拦截器中简单处理了异常，可以考虑在各个方法中增加详细的异常处理机制。
  • 连接池管理：默认情况下，OkHttp 使用连接池来提升性能，类内部也可以进一步定制连接池策略来优化并发性能。
  • 异步支持：所有请求均为同步请求，适合使用时可以考虑用 OkHttp 提供的 enqueue() 方法进行异步操作，防止阻塞主线程。

通过这些封装，OkHttpUtils 能够方便地发送 HTTP 请求并处理响应。在实际项目中，你可以根据需要调整超时设置、缓存机制等配置。

响叮当！
关注
  • 6
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Java封装OkHttp3工具类
m0_61467409的博客
11-09 295
准备工作 Maven项目在pom文件中引入jar包 <dependency> <groupId>com.squareup.okhttp3</groupId> <artifactId>okhttp</artifactId> <version>3.10.0</version> </dependency> <dependency> <groupId>com.
基于okhttp3封装的http请求工具类
m0_52027342的博客
01-13 222
package com.sx.common.utils.http; import com.alibaba.fastjson.JSON; import com.sx.common.utils.FileUtils; import okhttp3.*; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.util.StringUtils; import javax.net.ssl.SSLCont
OkHttpClient请求方式详解，及常用OkHttpUtils配置工具类
大数据开发、JAVA开发、人工智能AI
11-03 9313
OkHttpClient请求方式详解，及常用OkHttpUtils配置工具类
HttpUtils工具类 java程序 发起 网络请求
weixin_47369565的博客
04-02 433
HttpUtils工具类 用于java程序 发起 网络请求 @Slf4j public class OkHttpUtils { private static final String HTTP_JSON = "application/json; charset=utf-8"; private static final String HTTP_FORM = "application/x-www-form-urlencoded; charset=utf-8"; private sta
Java常用工具类之HttpUtils
weixin_42246822的博客
05-21 971
HttpClien请求涉及到两个类，一个是http的请求，另一个是对http连接池参数进行设置。 HttpUtil @Slf4j @Component public class HttpUtil { private static final MediaType JSON = MediaType.parse("application/json;charset=UTF-8"); private static final MediaType XML = MediaType.parse("appl
工具类 OkHttpClient解析
qq_43603372的博客
12-22 554
1.HttpUtils public class HttpUtils { public static String get(String urlString){ OkHttpClient okHttpClient = new OkHttpClient.Builder() .addInterceptor(new LoggingIntercep...
打造一个通用的网络请求引擎HttpUtils
05-30
通过以上步骤，我们可以构建出一个基础的HttpUtils工具类。然而，为了提升可维护性和复用性，还可以考虑引入依赖注入框架（如Dagger）、使用Retrofit等高级库进行接口封装，以及添加更完善的错误处理和网络状态检测...
OkHttp 应该怎么封装网络工具类
06-08
如果要封装一个网络工具类，可以考虑以下几个步骤： 1. 引入 OkHttp 库。可以通过在 build.gradle 文件中添加以下依赖来引入 OkHttp 库： ``` implementation 'com.squareup.okhttp3:okhttp:4.9.0' ``` 2. 创建一...
Android-通过制作HttpUtil工具类来便于进行Http通信
chitoseyono的博客
04-23 3404
个人是在看郭神的第一行代码时知道的可以自己做一个HttpUtil类来方便Http的通信，只需要直接用工具类里的方法进行获得Response即可了。 这里写出我自己在制作HttpUtil类时用到的不同的方法（布局的话都是一个EditText，一个按钮一个文本框，没什么特别的就不贴出来了），本文偏向于使用AsyncTask进行异步调用，先放一下效果吧。 这里也因为速度太快了ProgressBa...
网络压缩之网络剪枝（network pruning）
前行居士
08-31 873
网络剪枝（network pruning）就是要把网络里面的一些参数剪掉。剪枝就是修剪的意思，把网络里面的一些参数剪掉。为什么可以把网络里面的一些参数剪 掉呢？这么大的网络里面有很多很多的参数，每一个参数不一定都有在做事。参数这么多的 时候，也许很多参数只是在划水，什么事也没有做。这些没有做的参数放在那边，就只是占空 间而已，浪费计算资源而已。为何就把它们剪掉呢？所以网络剪枝就是把一个大的网络中没 有用的那些参数把它找出来，把它扔掉。人刚出生的时候，脑袋是空空的，神经元跟神经元间 没什么连接
RK3588开发板利用udp发送和接收数据
cumtchw
09-01 481
RK3588开发板利用udp发送和接收数据
基于 AT 固件测试 ESP32 设备作为 WiFi AP 模式创建 TCP Server 开启 UART-to-WiFi 透传模式的指令序列
weixin_42083266的博客
09-04 254
【代码】基于 AT 固件测试 ESP32 设备作为 WiFi AP 模式创建 TCP Server 开启 UART-to-WiFi 透传模式的指令序列。
Linux高性能服务器编程 总结索引 | 第2章：IP协议详解
AsherGu的博客
08-29 1244
IP服务的特点；IPv4头部结构；IP分片；IP路由：IP模块工作流程，路由机制，路由表更新；IP转发；重定向；IPv6头部结构：IPv6固定头部结构，IPv6扩展头部
观测云核心技术解密：eBPF Tracing 实现原理
观测云的博客
09-03 739
通过 eBPF，开发者可以在不修改内核源码的情况下，对内核功能进行扩展和监控。eBPF Tracing 利用这一技术，对系统调用、内核函数等进行跟踪，从而实现对应用行为的深入洞察。
计算机网络-VRRP工作原理
Linux基础知识、计算机网络基础学习分享。
09-03 458
初始化状态就是在设备上配置完成时的状态，Master状态为主设备的状态，Nackup状态为备份设备的状态，备份设备会监听主设备发送的Advertisement报文，当定时器超时都没有收到主设备的报文时则备份设备切换为Master状态。R1与R2交换VRRP报文，优先级一样，通过比较接口IP地址选举Master路由器，由于R2的接口IP地址大于R1的接口IP地址，因此R2被选举为Master路由器。进行比较，先比较优先级，优先级大的优先，优先级相等则比较接口IP地址，IP地址大的优先，
网络编程学习：TCP/IP协议
kkbbaaii的博客
09-01 1537
网络编程学习：TCP/IP协议
【亲测有效】nginx负载均衡指定ip端口转发，做自动切换
09-04 224
nginx负载均衡指定ip端口转发，做自动切换。nginx如何做到？监听两个目标公网ip，这两个目标ipA，ipB 是做了iptables的转发，按照端口转发的，例如我访问ipA的3333端口就转发某个squid代理x上，访问ipB的3333端口也转发到同一个squid代理x上。现在我访问nginx的3333端口，默认都走ipA转发，只有发现ipA不通或ipA转发不成功时ngnix自动切换到走ipB，我不用动任何代码。
【python】socket 入门以及多线程tcp链接
最新发布
weixin_57336987的博客
09-04 802
Socket是套接字的意思,是网络编程的核心对象,通信两端都独有自己的Socket对象, 数据在两个Socket之间通过 字节流(TCP协议) 或者 数据报包(UDP协议)的形式进行传输.
HttpUtils工具类和post请求List 数据
06-06
您好，关于您的问题，HttpUtils是一个HTTP请求工具类，可以用于发送HTTP请求，并获取响应结果。下面是一个使用HttpUtils进行POST请求发送List数据的示例代码： ```java public static void postListData(String url, List<String> dataList) { HttpUtils httpUtils = new HttpUtils(); RequestParams params = new RequestParams(); StringBuilder stringBuilder = new StringBuilder(); for (String data : dataList) { stringBuilder.append(data).append(","); } params.addBodyParameter("dataList", stringBuilder.toString()); httpUtils.send(HttpMethod.POST, url, params, new RequestCallBack<String>() { @Override public void onSuccess(ResponseInfo<String> responseInfo) { // 处理成功回调 } @Override public void onFailure(HttpException error, String msg) { // 处理失败回调 } }); } ``` 在上述代码中，我们使用了HttpUtils发送POST请求，并通过RequestParams添加了一个名为"dataList"的请求参数，并将List数据转换成了逗号分隔的字符串。 希望对您有所帮助。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值