草庐IT

我们一起聊聊日常开发必备神器 OkHttp3

了不起 2023-03-28 原文

​一、摘要

现在开源的市场上,能网络请求的工具非常的多,比如 HttpURLConnection 、Apache HttpClient、okHttp、Retrofit 等等。

虽然可选择的工具很多,但是作为一名开发者,我们希望在写代码的时候,能够轻松地调试我们应用程序的网络通信,选择适合的工具至关重要!

就目前我们所熟悉的,其中 Apache HttpClient 因其高效的性能、丰富的 api,在开源项目中使用非常广泛,Android 系统最早默认的网络请求工具也是使用 Apache HttpClient,但因为兼容性问题,Android 后期的版本中谷歌不愿意维护相关包,改而使用 okHttp。

现在 Android 系统中的网络请求框架,基本都是 okhttp 和 Retrofit 一统天下,两者其实都是 square 公司出品的,不同的地方在于 Retrofit 是基于 OkHttp 封装的一套 RESTful 网络请求框架,使用方面更加灵活,属于后起之秀!

既然大家都觉得 OkHttp 好用,今天我们就一起来认识一下它!

来着网上对于 OkHttp 相关的介绍如下!

OkHttp 是 Square 公司基于 Java 和 Android 程序,封装的一个高性能 http 网络请求客户端,并且对外开源,它的设计初衷是为了更快地加载资源并节省带宽。

以下是使用 OkHttp 的主要优势:

  • 支持HTTP/2(有效使用套接字)
  • 连接池(在没有HTTP/2的情况下减少请求延迟)
  • GZIP压缩(缩小下载大小)
  • 响应缓存(避免了重新获取相同的数据)
  • 从常见的连接问题中无声恢复
  • 替代 IP 地址检测(在 IPv4 和 IPv6 环境下)
  • 支持现代TLS功能(TLS 1.3,ALPN,证书钉子)
  • 支持同步和异步调用
目前 OkHttp 在开源项目中被广泛使用,同时也是 Retrofit、Picasso 等库的核心库。

既然这么厉害,在网络通信中我们如何使用呢,我们一起来学习一下!

二、案例实践

2.1、添加依赖包

在使用之前,我们需要先导入okhttp​依赖包,不同的版本号,相关 api 稍有区别,本次介绍的 api 操作基于3.14.9版本号。

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

2.2、get 同步请求

okhttp​发起get同步请求非常的简单,只需要几行代码就可以搞定。

案例如下!

String url = "https://www.baidu.com/";

OkHttpClient client = new OkHttpClient();
// 配置GET请求
Request request = new Request.Builder()
.url(url)
.get()
.build();

// 发起同步请求
try (Response response = client.newCall(request).execute()){
// 打印返回结果
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}

2.3、post 表单同步请求

okhttp​发起post表单格式的数据提交,同步请求编程也非常的简单,只需要几行代码就可以搞定。

案例如下!

String url = "https://www.baidu.com/";

OkHttpClient client = new OkHttpClient();
// 配置 POST + FORM 格式数据请求
RequestBody body = new FormBody.Builder()
.add("userName", "zhangsan")
.add("userPwd", "123456")
.build();
Request request = new Request.Builder()
.url(url)
.post(body)
.build();

// 发起同步请求
try (Response response = client.newCall(request).execute()){
// 打印返回结果
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}

2.4、post 表单 + 文件上传,同步请求

如果在发起表单请求的时候,还需要上传文件,该如何实现呢?

案例如下!

String url = "https://www.baidu.com/";

OkHttpClient client = new OkHttpClient();

// 要上传的文件
File file = new File("/doc/Downloads/429545913565844e9b26f97dbb57a1c3.jpeg");
RequestBody fileBody = RequestBody.create(MediaType.parse("image/jpg"), file);

// 表单 + 文件数据提交
RequestBody multipartBody = new MultipartBody.Builder()
.setType(MultipartBody.FORM)
.addFormDataPart("userName", "zhangsan")
.addFormDataPart("userPwd", "123456")
.addFormDataPart("userFile", "00.png", fileBody)
.build();
Request request = new Request.Builder()
.url(url)
.post(multipartBody)
.build();

// 发起同步请求
try (Response response = client.newCall(request).execute()){
// 打印返回结果
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}

2.5、post + json 数据,同步请求

okhttp​发起post​ + json格式的数据提交,同步请求编程也很简单。

案例如下!

MediaType contentType = MediaType.get("application/json; charset=utf-8");
String url = "https://www.baidu.com/";
String json = "{}";

OkHttpClient client = new OkHttpClient();
// 配置 POST + JSON 请求
RequestBody body = RequestBody.create(contentType, json);
Request request = new Request.Builder()
.url(url)
.post(body)
.build();

// 发起同步请求
try (Response response = client.newCall(request).execute()){
// 打印返回结果
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}

2.5、文件下载,同步请求

文件下载,通常是get方式请求,只需要在响应端使用字节流接受数据即可!

案例如下!

public static void main(String[] args) {
//目标存储文件
String targetFile = "/doc/Downloads/1.png";
//需要下载的原始文件
String url = "https://www.baidu.com/img/PCtm_d9c8750bed0b3c7d089fa7d55720d6cf.png";

OkHttpClient client = new OkHttpClient();
// 配置GET请求
Request request = new Request.Builder()
.url(url)
.build();

// 发起同步请求
try (Response response = client.newCall(request).execute()){
// 获取文件字节流
byte[] stream = response.body().bytes();
// 写入目标文件
writeFile(targetFile, stream);
} catch (Exception e) {
e.printStackTrace();
}
}


/**
* 写入目标文件
* @param targetFile
* @param stream
* @throws IOException
*/
private static void writeFile(String targetFile, byte[] stream) throws IOException {
String filePath = StringUtils.substringBeforeLast(targetFile, "/");
Path folderPath = Paths.get(filePath);
if(!Files.exists(folderPath)){
Files.createDirectories(folderPath);
}
Path targetFilePath = Paths.get(targetFile);
if(!Files.exists(targetFilePath)){
Files.write(targetFilePath, stream, StandardOpenOption.CREATE);
}
}

2.6、其他方式的同步请求

在实际的项目开发中,有的接口需要使用put​或者delete方式请求,应该如何处理呢?

put方式请求,案例如下!

// 只需要在 Request 配置类中,换成 put 方式即可
Request request = new Request.Builder()
.url(url)
.put(body)
.build();
同样的,delete方式请求也类似,案例如下!

// 只需要在 Request 配置中,换成 delete 方式即可
Request request = new Request.Builder()
.url(url)
.delete(body)
.build();

2.7、自定义添加请求头部

大部分的时候,基于安全的考虑,很多时候我们需要把相关的鉴权参数放在请求头部,应该如何处理呢?

以post​ + json格式请求为例,添加头部请求参数,案例如下!

MediaType contentType = MediaType.get("application/json; charset=utf-8");
String url = "https://www.baidu.com/";
String json = "{}";

OkHttpClient client = new OkHttpClient();

// 配置 header 头部请求参数
Headers headers = new Headers.Builder()
.add("token", "11111-22222-333")
.build();

// 配置 POST + JSON 请求
RequestBody body = RequestBody.create(contentType, json);
Request request = new Request.Builder()
.url(url)
.headers(headers)
.post(body)
.build();

// 发起同步请求
try (Response response = client.newCall(request).execute()){
// 打印返回结果
System.out.println(response.body().string());
} catch (Exception e) {
e.printStackTrace();
}

2.8、发起异步请求

在上文中我们介绍的都是同步请求,在最开始我们也说到 OkHttp 不仅支持同步调用,也异步调用,那么如何进行异步请求编程呢?

其实操作很简单,案例如下!

String url = "https://www.baidu.com/";
OkHttpClient client = new OkHttpClient().newBuilder().build();
Request request = new Request.Builder()
.url(url)
.get()
.build();

// 发起异步请求
client.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
System.out.println("请求异常 + " + e.getMessage());
}

@Override
public void onResponse(Call call, Response response) throws IOException {
System.out.println("请求完成,返回结果:" + response.body().string());
}
});

三、小结

以上就是小编针对 OkHttp 在使用上,做了一次简单的内容总结,整体下来,从使用上来讲,api 的操作确实比 Apache HttpClient 要简单很多。

关于 OkHttp 的内容其实还有很多,比如请求参数的全局配置、全局拦截器、websocket 等功能。

有关我们一起聊聊日常开发必备神器 OkHttp3的更多相关文章

  1. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗?当我运行compasswatch时,它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行?文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们?我自己编译的.sass文件编译成compiled/t

  2. ruby - 使用 C 扩展开发 ruby​​gem 时,如何使用 Rspec 在本地进行测试? - 2

    我正在编写一个包含C扩展的gem。通常当我写一个gem时,我会遵循TDD的过程,我会写一个失败的规范,然后处理代码直到它通过,等等......在“ext/mygem/mygem.c”中我的C扩展和在gemspec的“扩展”中配置的有效extconf.rb,如何运行我的规范并仍然加载我的C扩展?当我更改C代码时,我需要采取哪些步骤来重新编译代码?这可能是个愚蠢的问题,但是从我的gem的开发源代码树中输入“bundleinstall”不会构建任何native扩展。当我手动运行rubyext/mygem/extconf.rb时,我确实得到了一个Makefile(在整个项目的根目录中),然后当

  3. Ruby Sinatra 配置用于生产和开发 - 2

    我已经在Sinatra上创建了应用程序,它代表了一个简单的API。我想在生产和开发上进行部署。我想在部署时选择,是开发还是生产,一些方法的逻辑应该改变,这取决于部署类型。是否有任何想法,如何完成以及解决此问题的一些示例。例子:我有代码get'/api/test'doreturn"Itisdev"end但是在部署到生产环境之后我想在运行/api/test之后看到ItisPROD如何实现? 最佳答案 根据SinatraDocumentation:EnvironmentscanbesetthroughtheRACK_ENVenvironm

  4. ruby - 是否可以覆盖 gemfile 进行本地开发? - 2

    我们的git存储库中目前有一个Gemfile。但是,有一个gem我只在我的环境中本地使用(我的团队不使用它)。为了使用它,我必须将它添加到我们的Gemfile中,但每次我checkout到我们的master/dev主分支时,由于与跟踪的gemfile冲突,我必须删除它。我想要的是类似Gemfile.local的东西,它将继承从Gemfile导入的gems,但也允许在那里导入新的gems以供使用只有我的机器。此文件将在.gitignore中被忽略。这可能吗? 最佳答案 设置BUNDLE_GEMFILE环境变量:BUNDLE_GEMFI

  5. ruby-on-rails - 如果我将 ruby​​ 版本 2.5.1 与 rails 版本 2.3.18 一起使用会怎样? - 2

    如果我使用ruby​​版本2.5.1和Rails版本2.3.18会怎样?我有基于rails2.3.18和ruby​​1.9.2p320构建的rails应用程序,我只想升级ruby的版本,而不是rails,这可能吗?我必须面对哪些挑战? 最佳答案 GitHub维护apublicfork它有针对旧Rails版本的分支,有各种变化,它们一直在运行。有一段时间,他们在较新的Ruby版本上运行较旧的Rails版本,而不是最初支持的版本,因此您可能会发现一些关于需要向后移植的有用提示。不过,他们现在已经有几年没有使用2.3了,所以充其量只能让更

  6. ruby - 在 Windows 机器上使用 Ruby 进行开发是否会适得其反? - 2

    这似乎非常适得其反,因为太多的gem会在window上破裂。我一直在处理很多mysql和ruby​​-mysqlgem问题(gem本身发生段错误,一个名为UnixSocket的类显然在Windows机器上不能正常工作,等等)。我只是在浪费时间吗?我应该转向不同的脚本语言吗? 最佳答案 我在Windows上使用Ruby的经验很少,但是当我开始使用Ruby时,我是在Windows上,我的总体印象是它不是Windows原生系统。因此,在主要使用Windows多年之后,开始使用Ruby促使我切换回原来的系统Unix,这次是Linux。Rub

  7. ruby-on-rails - 在 Rails 开发环境中为 .ogv 文件设置 Mime 类型 - 2

    我正在玩HTML5视频并且在ERB中有以下片段:mp4视频从在我的开发环境中运行的服务器很好地流式传输到chrome。然而firefox显示带有海报图像的视频播放器,但带有一个大X。问题似乎是mongrel不确定ogv扩展的mime类型,并且只返回text/plain,如curl所示:$curl-Ihttp://0.0.0.0:3000/pr6.ogvHTTP/1.1200OKConnection:closeDate:Mon,19Apr201012:33:50GMTLast-Modified:Sun,18Apr201012:46:07GMTContent-Type:text/plain

  8. 世界前沿3D开发引擎HOOPS全面讲解——集3D数据读取、3D图形渲染、3D数据发布于一体的全新3D应用开发工具 - 2

    无论您是想搭建桌面端、WEB端或者移动端APP应用,HOOPSPlatform组件都可以为您提供弹性的3D集成架构,同时,由工业领域3D技术专家组成的HOOPS技术团队也能为您提供技术支持服务。如果您的客户期望有一种在多个平台(桌面/WEB/APP,而且某些客户端是“瘦”客户端)快速、方便地将数据接入到3D应用系统的解决方案,并且当访问数据时,在各个平台上的性能和用户体验保持一致,HOOPSPlatform将帮助您完成。利用HOOPSPlatform,您可以开发在任何环境下的3D基础应用架构。HOOPSPlatform可以帮您打造3D创新型产品,HOOPSSDK包含的技术有:快速且准确的CAD

  9. 【鸿蒙应用开发系列】- 获取系统设备信息以及版本API兼容调用方式 - 2

    在应用开发中,有时候我们需要获取系统的设备信息,用于数据上报和行为分析。那在鸿蒙系统中,我们应该怎么去获取设备的系统信息呢,比如说获取手机的系统版本号、手机的制造商、手机型号等数据。1、获取方式这里分为两种情况,一种是设备信息的获取,一种是系统信息的获取。1.1、获取设备信息获取设备信息,鸿蒙的SDK包为我们提供了DeviceInfo类,通过该类的一些静态方法,可以获取设备信息,DeviceInfo类的包路径为:ohos.system.DeviceInfo.具体的方法如下:ModifierandTypeMethodDescriptionstatic StringgetAbiList​()Obt

  10. 微信小程序开发入门与实战(Behaviors使用) - 2

    @作者:SYFStrive @博客首页:HomePage📜:微信小程序📌:个人社区(欢迎大佬们加入)👉:社区链接🔗📌:觉得文章不错可以点点关注👉:专栏连接🔗💃:感谢支持,学累了可以先看小段由小胖给大家带来的街舞👉微信小程序(🔥)目录自定义组件-behaviors    1、什么是behaviors    2、behaviors的工作方式    3、创建behavior    4、导入并使用behavior    5、behavior中所有可用的节点    6、同名字段的覆盖和组合规则总结最后自定义组件-behaviors    1、什么是behaviorsbehaviors是小程序中,用于实现

随机推荐