登录
当前位置： 首页 > 工具软件 > easy-okhttp > 使用案例 >

OKHttp3 快速开始

习旻
2023-12-01

一、什么是OKHttp3

官网地址：https://square.github.io/okhttp/
github地址：https://github.com/square/okhttp

OKHttp是一个当前主流的网络请求的开源框架
Square公司(该公司还贡献了Picasso)开发，用于替代HttpUrlConnection和Apache HttpClient
Android4.4开始，google已经开始将源码中的HttpURLConnection替换为OkHttp
Android6.0里已移除HttpClient。

OkHttp is an HTTP client that’s efficient by default:

  • HTTP/2 support allows all requests to the same host to share a socket.
  • Connection pooling reduces request latency (if HTTP/2 isn’t available).
  • Transparent GZIP shrinks download sizes.
  • Response caching avoids the network completely for repeat requests.

相对于其他网络框架，有如下优点：

支持 Spdy、 Http1.X、 Http2、 Quic以及 WebSocket
连接池复用底层 TCP(Socket)，减少请求延时
无缝的支持 GZIP减少数据流量
缓存响应数据减少重复的网络请求
请求失败自动重试主机的其他 ip，自动重定向

总结： OkHttp现在应该算是最火的Http第三方库。

二、基于springboot的RestTemplate、okhttp和HttpClient对比

参考URL: https://www.cnblogs.com/wzk-0000/p/10955406.html

  1. HttpClient：代码复杂，还得操心资源回收等。代码很复杂，冗余代码多，不建议直接使用。

  2. RestTemplate： 是 Spring 提供的用于访问Rest服务的客户端， RestTemplate 提供了多种便捷访问远程Http服务的方法,能够大大提高客户端的编写效率。

  3. okhttp：OkHttp是一个高效的HTTP客户端，允许所有同一个主机地址的请求共享同一个socket连接；连接池减少请求延时；透明的GZIP压缩减少响应数据的大小；缓存响应内容，避免一些完全重复的请求。

当网络出现问题的时候OkHttp依然坚守自己的职责，它会自动恢复一般的连接问题，如果你的服务有多个IP地址，当第一个IP请求失败时，OkHttp会交替尝试你配置的其他IP，OkHttp使用现代TLS技术(SNI, ALPN)初始化新的连接，当握手失败时会回退到TLS 1.0。

三、Okhttp的基本使用

基本使用——OkHttp3详细使用教程
参考URL: https://www.cnblogs.com/it-tsz/p/11748674.html

OkHttp的使用是非常简单的. 它的请求/响应 API 使用构造器模式builders来设计，它支持阻塞式的同步请求和带回调的异步请求。

1. maven引入

maven仓库查找并引入

<!-- https://mvnrepository.com/artifact/com.squareup.okhttp3/okhttp -->
<dependency>
    <groupId>com.squareup.okhttp3</groupId>
    <artifactId>okhttp</artifactId>
    <version>3.14.9</version>
</dependency>

2. 创建OkHttpClient实例

通过OkHttpClient可以发送一个Http请求，并读取该Http请求的响应，它是一个生产Call的工厂。
此外，受益于一个共享的响应缓存/线程池/复用的连接等因素，绝大多数应用使用一个OkHttpClient实例，便可以满足整个应用的Http请求。

三种创建实例的方法：

  • 创建一个默认配置OkHttpClient，可以使用默认的构造函数。
  • 通过new OkHttpClient.Builder()方法来一步一步配置一个OkHttpClient实例。
  • 如果要求使用现有的实例，可以通过newBuilder()方法来进行构造。
OkHttpClient client = new OkHttpClient();
OkHttpClient clientWith30sTimeout = client.Builder()
    .readTimeout(30, TimeUnit.SECONDS)
    .build();
OkHttpClient client  = client.newBuilder().build();
  1. GET请求
    demo:
OkHttpClient client = new OkHttpClient();

String run(String url) throws IOException {
  Request request = new Request.Builder()
      .url(url)
      .build();

  Response response = client.newCall(request).execute();
  return response.body().string();
}

Request
简单看一下Request类，可以发现它代表一个Http请求，需要注意的是Request一旦build()之后，便不可修改。

主要通过new Request.Builder()来一步一步构造的。
默认是Get方法，
Response
Response代表一个Http的响应，这个类的实例不可修改。

2） POST请求

public static final MediaType JSON
    = MediaType.parse("application/json; charset=utf-8");

OkHttpClient client = new OkHttpClient();

String post(String url, String json) throws IOException {
  RequestBody body = RequestBody.create(JSON, json);
  Request request = new Request.Builder()
      .url(url)
      .post(body)
      .build();
  Response response = client.newCall(request).execute();
  return response.body().string();
}

MediaType用于描述Http请求和响应体的内容类型，也就是Content-Type。
例如，MediaType.parse(“application/json; charset=utf-8”);这个就带表请求体的类型为JSON格式的。

定义好数据类型，还要将其变为请求体，最后通过post()方法，随请求一并发出。

2.1 HTTP头部的设置和读取

HTTP响应头和请求头信息对照表
http://tools.jb51.net/table/http_header

HTTP 头的数据结构是 Map<String, List>类型。也就是说，对于每个 HTTP 头，可能有多个值。但是大部分 HTTP 头都只有一个值，只有少部分 HTTP 头允许多个值。

OkHttp的处理方式是：

  • 使用header(name,value)来设置HTTP头的唯一值，如果请求中已经存在响应的信息那么直接替换掉。
  • 使用addHeader(name,value)来补充新值，如果请求头中已经存在name的name-value，那么还会继续添加，请求头中便会存在多个name相同而value不同的“键值对”。
  • 使用header(name)读取唯一值或多个值的最后一个值
  • 使用headers(name)获取所有值
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
        .url("https://github.com")
        .header("User-Agent", "My super agent")
        .addHeader("Accept", "text/html")
        .build();

Response response = client.newCall(request).execute();
if (!response.isSuccessful()) {
    throw new IOException("服务器端错误: " + response);
}

System.out.println(response.header("Server"));
System.out.println(response.headers("Set-Cookie"));

2.2 设置请求超时时间

OkHttp3超时设置和超时异常捕获
参考URL: https://blog.csdn.net/do168/article/details/51848895/

设置超时移到了OkHttpClient.Builder中，所以最新的设置超时的代码如下

        OkHttpClient client = new OkHttpClient.Builder()
                .connectTimeout(10, TimeUnit.SECONDS)
                .readTimeout(20, TimeUnit.SECONDS)
                .build();

3. RestTemplate + okhttp 实现远程调用

RestTemplate + okhttp 实现远程调用
参考URL: https://zhuanlan.zhihu.com/p/108765123

  1. 引入maven
<!-- https://mvnrepository.com/artifact/com.squareup.okhttp3/okhttp -->
<dependency>
    <groupId>com.squareup.okhttp3</groupId>
    <artifactId>okhttp</artifactId>
    <version>3.14.9</version>
</dependency>

2)声明 RestTemplate

@Component
public class OkHttpConfig {

    /**
     * 基于OkHttp3配置RestTemplate
     * @return
     */
    @Bean
    public RestTemplate restTemplate() {
        return new RestTemplate(new OkHttp3ClientHttpRequestFactory());
    }


}

3)测试验证


@RestController
public class TestController {

	@Autowired
	RestTemplate restTemplate;
	
	@Test
	public void testRestTemplate(){
		ResponseEntity<Map> forEntity = restTemplate.getForEntity("请求的url",Map.class);
		Map body = forEntity.getBody();
		System.out.println(body );
	}
}

4. Connection作为请求头： OkHttpClient单例和长连接Connection Keep-Alive

OkHttp使用踩坑记录总结(一)：OkHttpClient单例和长连接Connection Keep-Alive
参考URL: https://blog.csdn.net/sinat_36553913/article/details/104054028

HTTP的KeepAlive就是浏览器和服务端之间保持长连接，这个连接是可以复用的。当客户端发送一次请求，收到相应内容后，这个连接会保持一段时间，在该时间内的第二次就不需要再重新建立连接,就可以直接使用这次的连接来发送请求了，极大的提高了速度。

KeepAlive在增加访问效率的同时，也会增加服务器的压力。

  • http1.0中默认是关闭的，需要在http头加入”Connection: Keep-Alive”，才能启用Keep-Alive；
  • http 1.1中默认启用Keep-Alive，如果加入”Connection: close “才关闭。目前大部分浏览器都是用http1.1协议，也就是说默认都会发起Keep-Alive的连接请求了，所以是否能完成一个完整的Keep- Alive连接就看服务器设置情况。

OkHttp支持HTTP/1.1和HTTP/2协议。HTTP/1.1和HTTP/2的http请求都是建立在TCP连接基础之上的，所以他们的性能极大的依赖于TCP连接的配置。每个TCP连接都会进行三次握手，并且因为TCP的拥塞控制使用的滑动窗口和慢开始算法导致网络带宽利用率不高。所以，在HTTP/2不可用时，OkHttp使用了连接池，避免为每个请求都创建连接。

复用长连接，避免了创建TCP连接的三次握手，我们简单了解下HTTP请求头中Connection和Keep-Alive。

Connection作为请求头的通用参数，其控制了请求连接在当前事务完成后是否继续保持。如果其值被设置为keep-alive, 则表示该连接是长连接，允许之后的相同地址的请求复用。还可以设置为close，每次请求结束后关闭连接。但是该参数在HTTP/2中不再使用。

okhttp都是长连接是因为okhttp最低只支持到http /1.1版本，当http/2不可用时，会使用连接池来复用长连接。 请求时希望不使用长连接，可显式设置okhttp的请求头 Connection为close。

浏览器默认使用http1.1，而http1.1默认是connection：keepalive

OkHttp默认是使用长连接进行请求，那么如果要发送非长连接的请求如何实现？
我们可以在请求时设置请求头参数Connection参数为close。

.addHeader("Connection", "close")

该参数，亲测可用！

四、使用过程常见问题总结

1. 在项目中引入okhttp的4.4.0版后发现idea点run和debug没响应，重启也没反应

解决idea导入kotlin项目时，项目无法编译运行的问题
参考URL: https://blog.csdn.net/wangyuanjiet/article/details/81220987
OkHttp 4 正式版发布，从 Java 切换到 Kotlin
参考URL: https://www.oschina.net/news/107848/okhttp-4-0-0-released
idea2017等低版本引入okhttp4无法编译运行
参考URL: https://blog.csdn.net/aoeace/article/details/103157193

现象：
在项目中引入okhttp的4.4.0版后发现idea点run和debug没响应，重启也没反应，换成3.14.2就好了。

原因分析：
pom引入okhttp4.x以前的版本idea可以正常编译运行，升级到okhttp4.x后，无法编译运行

因为OkHttp 4.x将我们的实现语言从Java升级到Kotlin，并使其他所有内容保持不变。我们选择Kotlin是因为它在与Java紧密集成的同时为我们提供了强大的新功能。

解决方式：
方案一：
1、选中菜单的file,选择setting,kotlin update
2、选中菜单的file,选择project structure=>Modules=>选中项目=>点击加号，加上Kotlin

方案二：使用低版本，如 3.x版本的okhttp。 （本人暂时采用该方案）

<!-- https://mvnrepository.com/artifact/com.squareup.okhttp3/okhttp -->
<dependency>
    <groupId>com.squareup.okhttp3</groupId>
    <artifactId>okhttp</artifactId>
    <version>3.14.9</version>
</dependency>

2. OkHttp打印响应的body中json字符串

问题背景：
使用 把String json = response.body().toString(); 发现打印的不是

问题解决：

换成String json = response.body().string();就可以了

总结：OkHttp要的http响应的body体内容，是使用response.body().string()；

3. OkHttp忽略证书

Java通过OKHttp发送https请求（忽略认证）
https://www.cnblogs.com/areful/p/10381859.html

    private static TrustManager[] buildTrustManagers() {
        return new TrustManager[]{
                new X509TrustManager() {
                    @Override
                    public void checkClientTrusted(java.security.cert.X509Certificate[] chain, String authType) {
                    }

                    @Override
                    public void checkServerTrusted(java.security.cert.X509Certificate[] chain, String authType) {
                    }

                    @Override
                    public java.security.cert.X509Certificate[] getAcceptedIssuers() {
                        return new java.security.cert.X509Certificate[]{};
                    }
                }
        };
    }


        TrustManager[] trustAllCerts = buildTrustManagers();
        final SSLContext sslContext = SSLContext.getInstance("SSL");
        sslContext.init(null, trustAllCerts, new java.security.SecureRandom());

        final SSLSocketFactory sslSocketFactory = sslContext.getSocketFactory();

        OkHttpClient.Builder builder = new OkHttpClient.Builder();
        builder.sslSocketFactory(sslSocketFactory, (X509TrustManager) trustAllCerts[0]);
        builder.hostnameVerifier((hostname, session) -> true);


        OkHttpClient client = builder.connectTimeout(10, TimeUnit.SECONDS)
                .writeTimeout(10, TimeUnit.SECONDS)
                .readTimeout(30, TimeUnit.SECONDS)
                .build();
			...

亲测可用！

五、其他参考

你必须学会的OkHttp,带你快速上车
参考URL: https://blog.51cto.com/14541311/2438941
easy-okhttp是对OkHttp网络框架封装，提供文件上传和下载，表单(含文件)提交，链式调用，支持HTTPS和自定义签名证书等特性。
参考URL: https://gitee.com/yuanzizhenxin/easy-okhttp

 类似资料：

相关阅读

快速了解Python开发环境Spyder快速舍入快速双串Linux下快速搭建php开发环境如何在Centos 7快速开启端口

相关文章

JavaFX快速入门Django快速入门Eclipse 快速修复JavaScript快速排序【华为OD机试2023】快速开租建站Python

相关问答

AudioKit快速摇摄scheduleAtFixedRate执行速度快了解快速排序快速枚举继承快速键盘处理

相关文档

Sass 快速入门Python 快速教程Java 快速教程Consul 快速入门Linux 工具快速教程
快捷导航： 新手教程 算法原理 架构设计 Java进阶 数据库进阶 大厂专栏 面试经验 编程笔记 编程问答 所有专题 文档资料 工具软件 电子书籍 小牛导航
在线工具： 房贷计算器 个税计算器 Linux命令查询 Json格式化 正则表达式 颜色转换 AES加解密 SHA1加密 MD5加密 毒鸡汤 字数统计 随机密码生成 进制转换 Base64编解码 励志句子
Copyright © 2019-2024 小牛知识库@xnip.cn. All Rights Reserved.