HTTP客户端工具该选哪个?

huiyugan
发布于 2022-11-10 11:02
浏览
0收藏

前言

HTTP(超文本传输协议)是一种应用层协议,用于客户端和服务端进行通信,按照标准格式如JSON、XML等进行网络数据的传输,通常也作为应用程序之间以RESTAPI形式进行通信的常用协议。


在Java应用中需要调用其他应用提供的HTTP服务API时,通常需要使用一些HTTP客户端组件。


而可选择的HTTP客户端有很多,本期内容主要介绍在Java应用程序中可以使用的HTTP客户端工具。

概述

本文主要介绍的HTTP客户端包括:


  • Java 11+版本中提供的HttpClient
  • Apache HttpComponents项目中的HttpClient
  • OkHttpClient
  • Spring Boot中的WebClient


为了更好的进行对比,我们在示例中将分别使用不同的客户端完成异步GET请求和同步POST请求。


GET请求


对于Get请求,我们通过请求以下接口查询北京未来3天的天气预报。


请求地址为​​http://api.weatherdt.com/common/?area=101010100&type=forecast&key=645cc4f76d011bbd8717b1607d6cb9d7​​。


POST请求


对于POST请求,我们通过访问​​https://getman.cn/echo​​API测试接口,该接口接收一个JSON参数。


对于所有的HTTP客户端工具,发送一个请求的过程基本一致,包含如下步骤:


  • 创建一个HTTP Client实例
  • 创建用于发送请求的Request对象
  • 设置使用同步或异步方式并调用
  • 处理HTTP响应数据


接下来使用不同的HTTP客户端来完成功能。

JDK原生HttpClient

原生​​HttpClient​​​是在Java 9中作为孵化模块引入的,然后在Java11中作为JEP 321的一部分正式可用,​​HTTPClient​​​取代了JDK更早期的​​HttpUrlConnection​​类。


​HttpClient​​支持以下功能:


  • 支持HTTP1.1、HTTP2.0协议
  • 支持同步和异步编程模型
  • 支持请求和响应的流式处理
  • 支持Cookie

异步GET请求

使用​​HttpClient​​进行异步GET请求的代码如下所示:

HTTP客户端工具该选哪个?-鸿蒙开发者社区

在上面代码中使用构建器模式创建了​​HttpClient​​​和​​HttpRequest​​的实例,然后对REST API进行异步调用。


在创建请求时,我们通过调用​​get()​​​方法将HTTP方法设置为​​GET​​,并在设置10秒的超时时间。

同步POST请求

对于POST请求,可以在构建器上调用​​POST(BodyPublisher Body)​​​方法,可以使用​​HttpRequest.BodyPublishers.ofString(String requestBody)​​​将JSON字符串转换为​​BodyPublisher​​作为需要发送的数据参数。

HTTP客户端工具该选哪个?-鸿蒙开发者社区

在以上代码中,通过​​prepareRequest()​​​方法模拟出作为请求数据的JSON字符串,同样使用构建器模式,通过​​POST()​​​将请求方式设置为POST,对于返回结果,可以通过​​HttpResponse.BodyHandlers.ofString()​​转换为字符串。


如果你的项目中使用的JDK版本11+,则原生的HTTP Client可以作为首选。

Apache HttpComponents

​HttpComponents​​是Apache软件基金会的一个开源项目,该项目中包含了可用于HTTP协议的Java工具集。


该项目下的组件分为以下两部分:


​HttpCore​​:一组低级HTTP传输组件,可用于构建自定义客户端和服务器端HTTP服务;


​HttpClient​​:基于HttpCore的符合HTTP协议的HTTP代理实现。


同时,它还为提供了客户端身份验证、HTTP状态管理和HTTP连接管理等组件。


首先,使用该组件需要添加Maven依赖:

<dependency>
    <groupId>org.apache.httpcomponents.client5</groupId>
    <artifactId>httpclient5</artifactId>
    <version>5.1.1</version>
</dependency>

异步GET请求

使用​​Apache HttpClient​​进行异步REST API调用的常见方法如下所示:

HTTP客户端工具该选哪个?-鸿蒙开发者社区

主要步骤如下:


  • 首先创建​​CloseableHttpAsyncClient​​作为HTTP客户端;
  • 然后调用​​start()​​方法启动客户端;
  • 使用​​SimpleHttpRequest​​创建请求;
  • 并通过调用​​Execute()​​​方法发送请求,并设置​​FutureCallback​​对象来异步处理不同响应结果。

同步POST请求

使用​​Apache HttpClient​​发送同步POST请求代码如下:

HTTP客户端工具该选哪个?-鸿蒙开发者社区


发送同步POST请求的步骤如下:


  • 首先通过​​prepareRequest()​​方法创建出一个JSON字符串,作为请求数据;
  • 创建​​HttpPost​​​对象作为POST请求实例,并将请求数据和请求头数据设置到​​HttpPost​​对象中;
  • 通过​​HttpClients.createDefault()​​创建HTTP客户端实例;
  • 调用​​execute()​​方法发送请求;
  • 从返回值​​CloseableHttpResponse​​中获得响应数据。


当使用的JDK版本为11以下的版本,或者需要将功能作为插件提供给别的系统使用时,​​Apache HttpClient​​是一个比较好的选择。

OkHttpClient

​OkHttpClient​​也是一个开源库,由美国的Square公司提供。


同样需要添加对应的Maven依赖:

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

异步GET请求

使用​​OkHttpClient​​发送异步GET请求的代码如下:

HTTP客户端工具该选哪个?-鸿蒙开发者社区


使用​​OKHttpClient​​创建GET请求步骤如下:


  • 通过构建器模式设置读写超时时间,创建出HTTP客户端实例;
  • 使用​​Request.Builder()​​创建请求实例;
  • 使用​​OkHttpClient.newCall()​​方法发送异步get请求;
  • 通过​​enqueue()​​方法设置对异步请求响应的处理。

同步POST请求

​OKHttpClient​​发送同步POST请求代码如下所示:

HTTP客户端工具该选哪个?-鸿蒙开发者社区


通过​​OKHttpClient​​创建POST请求步骤如下:


  • 调用​​prepaareRequest()​​方法生成请求JSON数据;
  • 通过构建器模式创建出​​OkHttpClient​​客户端实例;
  • 调用​​RequestBody.create()​​创建出请求数据体;
  • 调用​​Request.Builder()​​构建出POST请求示例;
  • 调用​​execute()​​​发送请求,并同步得到返回结果​​Response​​。


​OKHttpClient​​​的客户端和请求示例都不需要手动关闭,我们创建单个​​OkHttpClient​​实例可以将进行重复使用,并且OkHttp的性能最佳

Spring WebClient

​Spring WebClient​​​是在Spring 5中引入的异步、反应式HTTP客户端,用于取代较旧的​​RestTemplate​​​,以便在使用​​Spring Boot​​框架构建的应用程序中进行REST API调用,它支持同步、异步和流式处理。


同样使用​​Spring WebClient​​需要添加Maven依赖:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-webflux</artifactId>
    <version>2.3.5.RELEASE</version>
</dependency>

​Spring WebClient​​​在​​Spring-boot-starter-webFlux​​包中,Spring WebFlux是Spring5的一部分,用于为Web应用程序中的反应式编程提供支持。

异步GET请求

使用​​Spring WebClient​​发送异步GET请求代码示例如下:

HTTP客户端工具该选哪个?-鸿蒙开发者社区

  • 在此代码片段中,我们首先使用默认设置创建客户端;
  • 接下来,调用client的​​get()​​​方法,并调用​​uri()​​方法设置请求API地址;
  • 调用链中的​​retrieve()​​方法用于进行API调用,也就是发送请求;
  • 然后并通过​​bodyToMono()​​​方法获取响应体,该响应体通过​​bodyToMono()​​​方法转换为​​Mono​​对象;
  • 最后,使用​​subscribe()​​​方法以非阻塞方式订阅​​bodyToMono()​​​方法转换返回的​​Mono​​对象。

同步POST请求

虽然​​Spring WebClient​​是异步的,但我们仍然可以通过调用block()方法进行同步调用,该方法会阻塞线程,直到执行结束;在方法执行后返回结果。


使用​​WebClient​​发出的同步POST请求示例如下:

HTTP客户端工具该选哪个?-鸿蒙开发者社区

  • 首先通过​​WebClient.create()​​创建HTTP客户端;
  • 通过​​client.post()​​设置请求方式为POST;
  • 通过​​body()​​​方法将​​prepaareRequest()​​方法中返回JSON字符串作为请求数据;
  • 调用​​exchange()​​​方法发送请求,并且会将响应数据封装到​​Mono​​​对象中,比​​retrieve()​​方法提供更多的操作方法;
  • 调用​​block()​​设置请求为同步阻塞的。

如何选择

在本文上述内容中我们通过不同的客户端工具实现了发送同步的GET请求和异步的POST请求。


各个工具的特点可以总结为以下几点:


  • 如果不想添加任何外部库并且应用程序的JDK版本是11+,那么原生​​HTTPClient​​是首选;
  • 如果是​​Spring Boot​​​应用并且是反应式API,则使用​​Spring WebClient​​;
  • ​Apache HttpClient​​的灵活性更高,相比其他库有更多的参考文档;
  • ​OkHttpClient​​的性能最佳,客户端对象可重复使用,功能丰富,高度可配置。


所以在实际开发中,按自己的实际需求和场景进行选择,俗话说没有最好的,只有最适合的


参考资料:

ttps://hc.apache.org/

https://reflectoring.io/spring-webclient/


我是小黑,一个在互联网“苟且”的程序员。

流水不争先,贵在滔滔不绝


分类
标签
已于2022-11-10 11:02:58修改
收藏
回复
举报
回复
    相关推荐