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

最新推荐文章于 2025-04-21 10:03:09 发布
最新推荐文章于 2025-04-21 10:03:09 发布
阅读量2k 收藏 11
点赞数 9
文章标签： 单元测试
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_42978535/article/details/144672737
版权

****

在本篇教程中，我们将介绍如何使用OKHttpClient，一个广泛使用的HTTP客户端库，来进行网络请求操作。OKHttp是一个高效的HTTP客户端库，支持HTTP/2、连接池、透明压缩和其他高级功能，使得它在Android开发以及Java后端开发中被广泛采用。

一、OKHttpClient概述

OKHttp是Square公司开发的一个开源项目，主要用于处理HTTP请求和响应。它与标准的Java HttpURLConnection相比，提供了更高效、简单、灵活的API，支持同步和异步请求。

OKHttp的特点：

  1. 支持HTTP/2。
  2. 内建连接池，减少TCP连接的开销。
  3. 支持透明的GZIP压缩和响应缓存。
  4. 支持同步和异步请求。
  5. 支持WebSocket和拦截器功能。

二、OKHttpClient的基本使用

1. 添加依赖

首先，你需要在项目中添加OKHttp的依赖。以下是Gradle配置：

dependencies {
    implementation("com.squareup.okhttp3:okhttp:4.9.0")
}

2. 创建OkHttpClient实例

OKHttpClient是执行请求的核心类。它是线程安全的，通常在整个应用中创建一个单例的OkHttpClient实例进行复用。

import okhttp3.OkHttpClient;

public class HttpClient {
    private static OkHttpClient client;

    public static OkHttpClient getClient() {
        if (client == null) {
            client = new OkHttpClient();
        }
        return client;
    }
}

3. 创建请求

Request对象表示一个HTTP请求，可以通过Request.Builder来构建请求。下面是一个简单的GET请求：

import okhttp3.Request;

public class HttpUtils {

    public static Request createGetRequest(String url) {
        return new Request.Builder()
                .url(url) // 设置请求url
                .build(); // 构建请求
    }
}

4. 执行请求

执行请求可以通过同步（execute）或异步（enqueue）的方式进行。

同步请求：

同步请求会阻塞当前线程直到收到响应。适用于不需要在UI线程中进行的任务（如后台任务）。

import okhttp3.Response;
import java.io.IOException;

public class HttpUtils {

    public static String executeRequest(Request request) throws IOException {
        OkHttpClient client = HttpClient.getClient(); // 获取OkHttpClient实例
        Response response = client.newCall(request).execute(); // 执行请求
        if (response.isSuccessful()) {
            return response.body().string(); // 返回响应体内容
        } else {
            return null; // 请求失败，返回null
        }
    }
}
异步请求：

异步请求不会阻塞线程，可以在请求完成后通过回调来处理响应。

import okhttp3.Callback;
import okhttp3.Response;
import java.io.IOException;

public class HttpUtils {

    public static void executeRequestAsync(Request request, Callback callback) {
        OkHttpClient client = HttpClient.getClient();
        client.newCall(request).enqueue(callback); // 异步执行请求
    }
}

5. 回调处理

当使用异步请求时，你需要实现Callback接口来处理响应。这里是一个异步请求的例子：

import okhttp3.Call;
import okhttp3.Callback;
import okhttp3.Response;
import java.io.IOException;

public class HttpUtils {

    public static void executeRequestAsync(Request request) {
        OkHttpClient client = HttpClient.getClient();
        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);
                }
            }
        });
    }
}

三、请求方法：GET、POST、PUT、DELETE

OKHttp支持多种HTTP请求方法，下面分别介绍如何发送GET、POST、PUT、DELETE请求。

1. GET 请求

GET请求用于从服务器获取资源。

import okhttp3.Request;

public class HttpUtils {

    public static void sendGetRequest(String url) throws IOException {
        Request request = new Request.Builder()
                .url(url)
                .build(); // 构建GET请求

        String response = executeRequest(request); // 执行请求
        System.out.println(response); // 输出响应结果
    }
}

2. POST 请求

POST请求用于向服务器发送数据。

import okhttp3.FormBody;
import okhttp3.Request;

public class HttpUtils {

    public static void sendPostRequest(String url, String param1, String param2) throws IOException {
        FormBody formBody = new FormBody.Builder()
                .add("param1", param1)
                .add("param2", param2)
                .build(); // 构建POST请求体

        Request request = new Request.Builder()
                .url(url)
                .post(formBody) // 设置POST请求方法
                .build();

        String response = executeRequest(request);
        System.out.println(response);
    }
}

3. PUT 请求

PUT请求用于更新资源。

import okhttp3.RequestBody;
import okhttp3.Request;

public class HttpUtils {

    public static void sendPutRequest(String url, String jsonBody) throws IOException {
        RequestBody body = RequestBody.create(jsonBody, MediaType.parse("application/json; charset=utf-8"));
        Request request = new Request.Builder()
                .url(url)
                .put(body) // 使用PUT方法
                .build();

        String response = executeRequest(request);
        System.out.println(response);
    }
}

4. DELETE 请求

DELETE请求用于删除服务器上的资源。

import okhttp3.Request;

public class HttpUtils {

    public static void sendDeleteRequest(String url) throws IOException {
        Request request = new Request.Builder()
                .url(url)
                .delete() // 设置DELETE请求方法
                .build();

        String response = executeRequest(request);
        System.out.println(response);
    }
}

四、添加请求头和处理响应

1. 添加请求头

你可以使用Request.Builder的addHeader方法向请求中添加自定义请求头。

import okhttp3.Request;

public class HttpUtils {

    public static void sendRequestWithHeaders(String url) throws IOException {
        Request request = new Request.Builder()
                .url(url)
                .addHeader("Authorization", "Bearer your-token") // 添加自定义header
                .build();

        String response = executeRequest(request);
        System.out.println(response);
    }
}

2. 处理响应

响应包含了状态码、响应体等信息。你可以通过Response对象获取这些数据。

import okhttp3.Response;
import java.io.IOException;

public class HttpUtils {

    public static String getResponseBody(Response response) throws IOException {
        if (response.isSuccessful()) {
            return response.body().string(); // 获取响应体
        } else {
            return "Request failed with status code: " + response.code();
        }
    }
}

五、总结

在本篇教程中，我们详细介绍了如何使用OKHttpClient进行HTTP请求。OKHttp提供了强大且易用的功能，可以帮助我们轻松处理HTTP请求和响应。我们学习了如何使用GET、POST、PUT、DELETE等方法，并介绍了如何添加请求头、处理响应以及如何发送同步和异步请求。

OKHttpClient的核心优势：

  1. 高效：支持连接池、HTTP/2等优化，提高网络请求的效率。
  2. 灵活：支持同步与异步请求，可以通过回调机制处理网络请求结果。
  3. 简单易用：提供简洁的API接口，易于集成与使用。

OKHttp是一个功能强大的HTTP客户端，适用于需要高效网络请求的Java和Android项目。如果你还没有使用过，推荐在项目中尝试一下。

OkHttp3Utils工具类
Dylan Lin的博客
05-12 1919
注意事项： 1、异常处理部分请大家根据项目结构自行调整 2、提供简单同步GET和POST方法 3、主要Maven依赖 <dependency> <groupId>com.squareup.okhttp3</groupId> <artifactId>okhttp</artifactId> <version>3.14.7</version> </dependency> import okhttp3.*; im
HttpUtils工具类（一）常见的HttpUtils工具类及如何自定义java的http连接池
m0_52767002的博客
08-15 2083
一、几种常见的Http调用方式一、几种常见的Http调用方式OKhttp是一个功能强大的 HTTP 客户端库，支持同步和异步请求。它适用于处理更加复杂的场景，如认证、连接池、多线程、上传文件等。
Java封装OkHttp3工具类
如漩涡的博客
12-04 4101
Java封装OkHttp3工具类，适用于Java后端开发者 说实在话，用过挺多网络请求工具，有过java原生的，HttpClient3和4，但是个人感觉用了OkHttp3之后，之前的那些完全不想再用了。怎么说呢，代码轻便，使用起来很很很灵活，响应快，比起HttpClient好用许多。当然，这些是我个人观点，不喜勿喷。 准备工作 Maven项目在pom文件中引入jar包 <...
OkHttp入门
最新发布
沉梦听雨的博客
04-21 467
OkHttp 是一个高效的 HTTP 客户端，用于 Android、Java 应用程序以及 Kotlin 应用程序。它支持同步阻塞调用和异步调用，同时提供了强大的拦截器和重定向处理功能。OkHttp 由 Square 公司开发，因其高性能和易用性而广受欢迎。
OkHttpClient请求方式详解，及常用OkHttpUtils配置工具类
大数据开发、JAVA开发、人工智能AI
11-03 1万+
OkHttpClient请求方式详解，及常用OkHttpUtils配置工具类
OkHttpClient 用法
qq_33240556的博客
08-23 1449
是一个非常高效的 HTTP 客户端库，由 Square 开发并维护。它被广泛用于 Android 开发，但也可以用于普通的 Java 应用程序。下面是如何使用 OkHttpClient 发送 HTTP 请求的一些基本示例。
OkhttpClient的使用详解
热门推荐
workingman_li的博客
06-12 8万+
** 概述及特性 ** HTTP是现代应用常用的一种交换数据和媒体的网络方式，高效地使用HTTP能让资源加载更快，节省带宽。OkHttpClient是一个高效的HTTP客户端，它有以下默认特性： 支持HTTP/2，允许所有同一个主机地址的请求共享同一个socket连接 连接池减少请求延时 透明的GZIP压缩减少响应数据的大小 缓存响应内容，避免一些完全重复的请求 当网络出现问题的时候OkHttp依...
OkHttpClient常见方法和使用
架构师之路。。
01-11 3976
OkHttpClient是一个开源的HTTP客户端，用于发送和接收HTTP请求。它是Square公司开发的，用于Android和Java应用程序的网络库。OkHttpClient内置了很多功能，包括连接池、请求和响应拦截器、TLS握手、请求重试等。它易于使用，具有简洁的API，同时还提供了丰富的配置选项，以适应不同的网络需求。使用OkHttpClient，开发人员可以轻松地创建和发送GET、POST、PUT、DELETE等类型的HTTP请求，并处理响应。
OkHttpClient使用教程详解
05-07 8817
点击上方“猿芯”，选择“设为星标”后台回复"1024"，有份惊喜送给面试的你原文https://www.cnblogs.com/ct2011/p/3997368.html同步get下载一个文件，打印他的响应头，以string形式打印响应体。响应体的string()方法对于小文档来说十分方便、高效。但是如果响应体太大（超过1MB），应避免适应string()方法 ，...
java的httputils工具类
03-08
### Java HttpUtils工具类概述 HttpUtils 是一种用于简化 HTTP 请求处理的工具类，在多个开源项目中有不同的实现版本。这类工具通常封装了常见的 HTTP 方法，如 `GET` 和 `POST`，并提供了便捷的方法来设置请求头、...
OkHttpClientUtil封装类
02-09
封装OkHttp的异步求在子线程发起网络请求post，get，https请求代码类
高效开发必备：通用HttpClient与OKHttp工具类
下面将详细介绍该工具类可能包含的知识点。 **HTTP客户端工具类** HTTP客户端工具类是一种抽象，用于处理HTTP请求和响应的库或工具。它们允许开发者更加容易地通过编程方式发送请求到服务器，并处理服务器返回的...
OkHttpClientUtil 工具类
weixin_40118044的博客
11-17 1210
public class OkHttpClientUtil { private static final int READ_TIMEOUT = 100; private static final int CONNECT_TIMEOUT = 60; private static final int WRITE_TIMEOUT = 60; private static final MediaType JSON = MediaType.parse("application/jso.
OkhttpClient工具类
U2133048的博客
11-08 1474
public class OkHttpUtils {     private String baseUrl = "https://monitor.api.qcloud.com/";     private static OkHttpClient mOkHttpClient;     private Request.Builder requestBuilder;     private String...
OkhttpClient的使用
booker009的博客
06-15 784
三个jar包，你可以在上述网址中下载到这三个jar包的最新版本。同时，OkHttp还支持通过Gradle或Maven等依赖管理工具进行引用。-通过Call#enqueue(Callback)方法来提交异步请求；需要注意的是，OkHttp 3.x版本需要引入。-通过前两步中的对象构建Call对象；-构造Request对象；
OkHttpClientUtil
qq_37641547的博客
07-21 1237
1_OKHttp简介 1.1_简介 OKHttp是一款高效的HTTP客户端，支持连接同一地址的链接共享同一个socket，通过连接池来减小响应延迟，还有透明的GZIP压缩，请求缓存等优势，其核心主要有路由、连接协议、拦截器、代理、安全性认证、连接池以及网络适配，拦截器主要是指添加，移除或者转换请求或者回应的头部信息 这个库也是square开源的一个网络请求库(okhttp内部依赖okio)。现在已被Google使用在Android源码上了，可见其强大。 关于网络请求库，现在应该还有很多人在使用android
OkHttpClient 常见用法
weixin_43875808的博客
04-11 375
注意HostnameVerifier和X509TrustManager都配置为信任所有内容，这会导致安全性降低，容易受到中间人攻击，请谨慎使用。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

一只蜗牛儿

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值