Spring Boot 项目HTTP 客户端工具

最新推荐文章于 2024-09-25 23:47:00 发布
最新推荐文章于 2024-09-25 23:47:00 发布
阅读量396 收藏
点赞数
分类专栏： SpringBoot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Dome_/article/details/107910178
版权

链接：juejin.im/post/6854573211426750472

大家都知道okhttp是一款由square公司开源的java版本http客户端工具。实际上，square公司还开源了基于okhttp进一步封装的retrofit工具，用来支持通过接口的方式发起http请求。如果你的项目中还在直接使用RestTemplate或者okhttp，或者基于它们封装的HttpUtils，那么你可以尝试使用Retrofit。

retrofit-spring-boot-starter实现了Retrofit与spring-boot框架快速整合，并且支持了部分功能增强，从而极大的简化spring-boot项目下http接口调用开发。接下来我们直接通过retrofit-spring-boot-starter，来看看spring-boot项目发送http请求有多简单。

retrofit官方并没有提供与spring-boot快速整合的starter。retrofit-spring-boot-starter是笔者封装的，已在生产环境使用，非常稳定。造轮子不易，跪求各位大佬star。

项目源码：retrofit-spring-boot-starter

引入依赖

 

<dependency>
    <groupId>com.github.lianjiatech</groupId>
    <artifactId>retrofit-spring-boot-starter</artifactId>
    <version>2.0.2</version>
</dependency>

 

配置@RetrofitScan注解

你可以给带有@Configuration的类配置@RetrofitScan，或者直接配置到spring-boot的启动类上，如下：

@SpringBootApplication
@RetrofitScan("com.github.lianjiatech.retrofit.spring.boot.test")
public class RetrofitTestApplication {
    public static void main(String[] args) {
        SpringApplication.run(RetrofitTestApplication.class, args);
    }
}

定义http接口

接口必须使用@RetrofitClient注解标记！http相关注解可参考官方文档：retrofit官方文档。

@RetrofitClient(baseUrl = "${test.baseUrl}")
public interface HttpApi {
    @GET("person")
    Result<Person> getPerson(@Query("id") Long id);
}

注入使用

将接口注入到其它Service中即可使用。

@Service
public class TestService {

    @Autowired
    private HttpApi httpApi;

    public void test() {
        
    }
}

只要通过上述几个步骤，就能实现通过接口发送http请求了，真的很简单。如果你在spring-boot项目里面使用过mybatis，相信你对这种使用方式会更加熟悉。接下来我们继续介绍一下retrofit-spring-boot-starter更高级一点的功能。

注解式拦截器

很多时候，我们希望某个接口下的某些http请求执行统一的拦截处理逻辑。这个时候可以使用注解式拦截器。使用的步骤主要分为2步：

  1. 继承BasePathMatchInterceptor编写拦截处理器；

  2. 接口上使用@Intercept进行标注。

下面以给指定请求的url后面拼接timestamp时间戳为例，介绍下如何使用注解式拦截器。

继承BasePathMatchInterceptor编写拦截处理器

@Component
public class TimeStampInterceptor extends BasePathMatchInterceptor {

    @Override
    public Response doIntercept(Chain chain) throws IOException {
        Request request = chain.request();
        HttpUrl url = request.url();
        long timestamp = System.currentTimeMillis();
        HttpUrl newUrl = url.newBuilder()
                .addQueryParameter("timestamp", String.valueOf(timestamp))
                .build();
        Request newRequest = request.newBuilder()
                .url(newUrl)
                .build();
        return chain.proceed(newRequest);
    }
}

接口上使用@Intercept进行标注

@RetrofitClient(baseUrl = "${test.baseUrl}")
@Intercept(handler = TimeStampInterceptor.class, include = {"/api/**"}, exclude = "/api/test/savePerson")
public interface HttpApi {

    @GET("person")
    Result<Person> getPerson(@Query("id") Long id);

    @POST("savePerson")
    Result<Person> savePerson(@Body Person person);
}

 

上面的@Intercept配置表示：拦截HttpApi接口下/api/**路径下（排除/api/test/savePerson）的请求，拦截处理器使用TimeStampInterceptor。

扩展注解式拦截器

有的时候，我们需要在拦截注解动态传入一些参数，然后再执行拦截的时候需要使用这个参数。这种时候，我们可以扩展实现自定义拦截注解。自定义拦截注解必须使用@InterceptMark标记，并且注解中必须包括include()、exclude()、handler()属性信息。使用的步骤主要分为3步：

  1. 自定义拦截注解

  2. 继承BasePathMatchInterceptor编写拦截处理器

  3. 接口上使用自定义拦截注解；

例如我们需要在请求头里面动态加入accessKeyId、accessKeySecret签名信息才能正常发起http请求，这个时候可以自定义一个加签拦截器注解@Sign来实现。下面以自定义@Sign拦截注解为例进行说明。

自定义@Sign注解

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@InterceptMark
public @interface Sign {
    /**
     * 密钥key
     * 支持占位符形式配置。
     *
     * @return
     */
    String accessKeyId();

    /**
     * 密钥
     * 支持占位符形式配置。
     *
     * @return
     */
    String accessKeySecret();

    /**
     * 拦截器匹配路径
     *
     * @return
     */
    String[] include() default {"/**"};

    /**
     * 拦截器排除匹配，排除指定路径拦截
     *
     * @return
     */
    String[] exclude() default {};

    /**
     * 处理该注解的拦截器类
     * 优先从spring容器获取对应的Bean，如果获取不到，则使用反射创建一个！
     *
     * @return
     */
    Class<? extends BasePathMatchInterceptor> handler() default SignInterceptor.class;
}

扩展自定义拦截注解有以下2点需要注意：

  1. 自定义拦截注解必须使用@InterceptMark标记。

  2. 注解中必须包括include()、exclude()、handler()属性信息。

 

实现SignInterceptor

@Component
public class SignInterceptor extends BasePathMatchInterceptor {

    private String accessKeyId;

    private String accessKeySecret;

    public void setAccessKeyId(String accessKeyId) {
        this.accessKeyId = accessKeyId;
    }

    public void setAccessKeySecret(String accessKeySecret) {
        this.accessKeySecret = accessKeySecret;
    }

    @Override
    public Response doIntercept(Chain chain) throws IOException {
        Request request = chain.request();
        Request newReq = request.newBuilder()
                .addHeader("accessKeyId", accessKeyId)
                .addHeader("accessKeySecret", accessKeySecret)
                .build();
        return chain.proceed(newReq);
    }
}

上述accessKeyId和accessKeySecret字段值会依据@Sign注解的accessKeyId()和accessKeySecret()值自动注入，如果@Sign指定的是占位符形式的字符串，则会取配置属性值进行注入。另外，accessKeyId和accessKeySecret字段必须提供setter方法。

接口上使用@Sign

 

@RetrofitClient(baseUrl = "${test.baseUrl}")
@Sign(accessKeyId = "${test.accessKeyId}", accessKeySecret = "${test.accessKeySecret}", exclude = {"/api/test/person"})
public interface HttpApi {

    @GET("person")
    Result<Person> getPerson(@Query("id") Long id);

    @POST("savePerson")
    Result<Person> savePerson(@Body Person person);
}

 

这样就能在指定url的请求上，自动加上签名信息了。

 

连接池管理

默认情况下，所有通过Retrofit发送的http请求都会使用max-idle-connections=5 keep-alive-second=300的默认连接池。当然，我们也可以在配置文件中配置多个自定义的连接池，然后通过@RetrofitClient的poolName属性来指定使用。比如我们要让某个接口下的请求全部使用poolName=test1的连接池，代码实现如下：

配置连接池。

retrofit:
    # 连接池配置
    pool:
        test1:
        max-idle-connections: 3
        keep-alive-second: 100
        test2:
        max-idle-connections: 5
        keep-alive-second: 50

 

2. 通过@RetrofitClient的poolName属性来指定使用的连接池。

 

@RetrofitClient(baseUrl = "${test.baseUrl}", poolName="test1")
public interface HttpApi {

    @GET("person")
    Result<Person> getPerson(@Query("id") Long id);
}

 

日志打印

很多情况下，我们希望将http请求日志记录下来。通过@RetrofitClient的logLevel和logStrategy属性，您可以指定每个接口的日志打印级别以及日志打印策略。retrofit-spring-boot-starter支持了5种日志打印级别(ERROR,WARN,INFO,DEBUG,TRACE)，默认INFO；支持了4种日志打印策略（NONE,BASIC,HEADERS,BODY），默认BASIC。4种日志打印策略含义如下：

  1. NONE：No logs.

  2. BASIC：Logs request and response lines.

  3. HEADERS：Logs request and response lines and their respective headers.

  4. BODY：Logs request and response lines and their respective headers and bodies (if present).

retrofit-spring-boot-starter默认使用了DefaultLoggingInterceptor执行真正的日志打印功能，其底层就是okhttp原生的HttpLoggingInterceptor。当然，你也可以自定义实现自己的日志打印拦截器，只需要继承BaseLoggingInterceptor（具体可以参考DefaultLoggingInterceptor的实现），然后在配置文件中进行相关配置即可。

retrofit:
  # 日志打印拦截器
  logging-interceptor: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultLoggingInterceptor

Http异常信息格式化器

当出现http请求异常时，原始的异常信息可能阅读起来并不友好，因此retrofit-spring-boot-starter提供了Http异常信息格式化器，用来美化输出http请求参数，默认使用DefaultHttpExceptionMessageFormatter进行请求数据格式化。你也可以进行自定义，只需要继承BaseHttpExceptionMessageFormatter，再进行相关配置即可。

retrofit:
  # Http异常信息格式化器
  http-exception-message-formatter: com.github.lianjiatech.retrofit.spring.boot.interceptor.DefaultHttpExceptionMessageFormatter

调用适配器 CallAdapter

Retrofit可以通过调用适配器CallAdapterFactory将Call<T>对象适配成接口方法的返回值类型。retrofit-spring-boot-starter扩展2种CallAdapterFactory实现：

  1. BodyCallAdapterFactory

    • 默认启用，可通过配置retrofit.enable-body-call-adapter=false关闭

    • 同步执行http请求，将响应体内容适配成接口方法的返回值类型实例。

    • 除了Retrofit.Call<T>、Retrofit.Response<T>、java.util.concurrent.CompletableFuture<T>之外，其它返回类型都可以使用该适配器。

  2. ResponseCallAdapterFactory

    • 默认启用，可通过配置retrofit.enable-response-call-adapter=false关闭

    • 同步执行http请求，将响应体内容适配成Retrofit.Response<T>返回。

    • 如果方法的返回值类型为Retrofit.Response<T>，则可以使用该适配器。

Retrofit自动根据方法返回值类型选用对应的CallAdapterFactory执行适配处理！加上Retrofit默认的CallAdapterFactory，可支持多种形式的方法返回值类型：

  • Call<T>: 不执行适配处理，直接返回Call<T>对象

  • CompletableFuture<T>: 将响应体内容适配成CompletableFuture<T>对象返回

  • Void: 不关注返回类型可以使用Void。如果http状态码不是2xx，直接抛错！

  • Response<T>: 将响应内容适配成Response<T>对象返回

  • 其他任意Java类型：将响应体内容适配成一个对应的Java类型对象返回，如果http状态码不是2xx，直接抛错！

 
/**
     * Call<T>
     * 不执行适配处理，直接返回Call<T>对象
     * @param id
     * @return
     */
    @GET("person")
    Call<Result<Person>> getPersonCall(@Query("id") Long id);

    /**
     * CompletableFuture<T>
     * 将响应体内容适配成CompletableFuture<T>对象返回
     * @param id
     * @return
     */
    @GET("person")
    CompletableFuture<Result<Person>> getPersonCompletableFuture(@Query("id") Long id);

    /**
     * Void
     * 不关注返回类型可以使用Void。如果http状态码不是2xx，直接抛错！
     * @param id
     * @return
     */
    @GET("person")
    Void getPersonVoid(@Query("id") Long id);

    /**
     * Response<T>
     * 将响应内容适配成Response<T>对象返回
     * @param id
     * @return
     */
    @GET("person")
    Response<Result<Person>> getPersonResponse(@Query("id") Long id);

    /**
     * 其他任意Java类型
     * 将响应体内容适配成一个对应的Java类型对象返回，如果http状态码不是2xx，直接抛错！
     * @param id
     * @return
     */
    @GET("person")
    Result<Person> getPerson(@Query("id") Long id);

我们也可以通过继承CallAdapter.Factory扩展实现自己的CallAdapter；然后将自定义的CallAdapterFactory配置成spring的bean！

自定义配置的CallAdapter.Factory优先级更高！

数据转码器 Converter

Retrofi使用Converter将@Body注解标注的对象转换成请求体，将响应体数据转换成一个Java对象，可以选用以下几种Converter：

  • Gson: com.squareup.Retrofit:converter-gson

  • Jackson: com.squareup.Retrofit:converter-jackson

  • Moshi: com.squareup.Retrofit:converter-moshi

  • Protobuf: com.squareup.Retrofit:converter-protobuf

  • Wire: com.squareup.Retrofit:converter-wire

  • Simple XML: com.squareup.Retrofit:converter-simplexml

retrofit-spring-boot-starter默认使用的是jackson进行序列化转换！如果需要使用其它序列化方式，在项目中引入对应的依赖，再把对应的ConverterFactory配置成spring的bean即可。

我们也可以通过继承Converter.Factory扩展实现自己的Converter；然后将自定义的Converter.Factory配置成spring的bean！

自定义配置的Converter.Factory优先级更高！

 

全局拦截器 BaseGlobalInterceptor

如果我们需要对整个系统的的http请求执行统一的拦截处理，可以自定义实现全局拦截器BaseGlobalInterceptor, 并配置成spring中的bean！例如我们需要在整个系统发起的http请求，都带上来源信息。

@Component
public class SourceInterceptor extends BaseGlobalInterceptor {
    @Override
    public Response doIntercept(Chain chain) throws IOException {
        Request request = chain.request();
        Request newReq = request.newBuilder()
                .addHeader("source", "test")
                .build();
        return chain.proceed(newReq);
    }
}

 

结语

至此，spring-boot项目下最优雅的http客户端工具介绍就结束了，更多详细信息可以参考官方文档：retrofit以及retrofit-spring-boot-starter。实现原理解读可查看基于Retrofit实现自己的轻量级http调用工具。

K'illCode
关注
专栏目录
使用 Spring Boot 应用程序进行客户端开发
yueqian_edu的博客
01-05 687
本文探讨了 Spring Boot 开发人员在其应用程序的客户端（浏览器）端使用 Javascript 和 CSS 的不同选项。有一些在 Spring Web 应用程序的传统服务器端渲染世界中表现良好的 Javascript 库，这些库对应用程序开发人员来说往往是轻而易举的。 htmx：HTMX 是一个库，允许您直接从 HTML 访问现代浏览器功能，而不是使用 javascript。它非常易于使用并且非常适合服务器端渲染，因为它通过直接从远程响应替换 DOM 部分来工作。它似乎被 Python 社区很
SpringBoot 项目的Http客户端工具
CoKKKKone的博客
11-02 707
大家都知道OKHTTP是一款由square公司开源的java版本http客户端工具。实际上，square公司还开源了基于okhttp进一步封装的**retrofit工具，用来支持通过接口的方式发起http请求。如果还在直接使用RestTemplate或者okhttp，或者基于它们封装的HttpUtils，那么可以尝试使用Retrofit。 retrofit-spring-boot-starter实现了Retrofit与spring-boot框架快速整合，并且支持了部分功能增强，从而极大的简化spring-b
SpringBoot 项目高效 HTTP 通信：常用客户端大比拼！
最新发布
weixin_45593273的博客
09-25 910
RestTemplate 是 Spring 框架提供的用于进行 HTTP 请求的强大工具。它封装了许多常见的 HTTP 操作，使得开发者可以轻松地与 RESTful 服务进行交互。OkHttp 是一个高效的 HTTP 客户端，被广泛应用于 Android 和 Java 项目中。WebClient 是 Spring 5 引入的一个非阻塞式的 HTTP 客户端。它基于 Reactive Streams 规范，提供了一种响应式的编程模型。
Springboot使用Feign客户端发送HTTP请求，代替​RestTemplate​远程调用
Xmi2599的博客
06-12 3125
在 Spring Boot 中，可以使用 Feign 来创建 HTTP 客户端，通过简单的注解方式即可实现服务间的远程调用。Feign是一种声明式、模板化的HTTP客户端，在往常的 HTTP 调用中，一直都是使用的官方提供的来进行远程调用，该调用方式将组装代码冗余到正常业务代码中，不够优雅，因此，可以考虑用Feign来替代。
2024年最全Spring Boot项目下最优雅的http客户端工具，用它就够了，太香了，真的醉了
2301_82241647的博客
05-07 1275
金三银四马上就到了，希望大家能好好学习一下这些技术点学习视频：本文已被CODING开源项目：【一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码】收录需要这份系统化的资料的朋友，可以点击这里获取r（具体可以参考DefaultLoggingInterceptor的实现），然后在配置文件中进行相关配置即可。金三银四马上就到了，希望大家能好好学习一下这些技术点学习视频：[外链图片转存中…
Spring HTTP 客户端
wwtg9988的博客
07-31 1147
Spring 提供了一些 HTTP 客户端类，可以方便地发起 HTTP 请求。
Spring boot整合MinIO客户端实现文件管理
06-27
本项目集成Minio的java客户端SDK，对Minio文件服务器进行读写，将操作封装为MinioUtil工具，直接在项目中可以复用。其操作主要包括： 上传文件 下载文件 读取桶列表 读取桶中的文件列表 删除桶 删除文件 Spring ...
Spring Boot项目中实现OAuth2客户端模式（Client Credentials Grant Type）
lucky_love816的博客
09-13 1374
创建一个实现了ClientDetailsService接口的服务类，用于加载客户端详情。
spring boot中使用http请求的示例代码
08-28
1. 使用Http请求在Spring Boot中的必要性: 在项目中，需要两个系统之间进行通信，以便实现数据的交换和共享。在这种情况下，使用Http请求是最为常见和简单的方式。 2. 自定义Http请求工具类: 在本示例中，我们...
spring boot admin3.1.x客户端
06-30
Spring Boot Admin是一款强大的用于监控Spring Boot应用程序的工具，它提供了丰富的UI界面，使得...通过集成Spring Boot Actuator和其他监控工具，客户端能为开发团队提供全面的应用运行视图，提高开发和运维效率。
Spring Boot入门(02)：【教程】轻松搭建Spring Boot开发环境，启动你的第一个Web项目！
热门推荐
**My Coding Family**
08-11 3万+
快速搭建开发环境和启动项目是每个开发人员必备的技能。本文将为您提供一些简单易懂的方法和技巧，以帮助您快速搭建开发环境和启动项目。我们将介绍如何选择适合您的开发工具、配置您的操作系统、安装必要的软件包和依赖项，并开始编写您的第一个应用程序。无论您是一位新手还是一位经验丰富的开发人员，本文都会给您提供有用的信息和实用的建议，让您在最短时间内快速搭建和启动开发项目。
Spring 实现远程访问详解——httpclient
04-19
上两章我们分别利用Spring rmi和httpinvoker实现的远程访问功能，具体见《》和《》。本章将通过apache httpclient实现远程访问。说得简单就是直接通过spring requestmapping即请求映射url访问远程服务。 1. 远程访问流程 1) 服务器在控制器定义远程访问请求映射路径 2) 客户端通过apache httpclient的 httppost方式访问远程服务 2. Httpclient方式具体实现 1) 服务器在控制器定义远程访问请求映射路径
springboot_host
01-11
springboot 解决host漏洞的实例
自定义springboot组件--统一封装http客户端实现
Instanceztt的博客
07-25 1222
http是第三方接口调用的常用工具,该组件通过对常见的http客户端工具进行统一的整合,参考了feign的上下文和springmvc的拦截器等相关设计思路,设计了相应的Context用于对请求上下文的相关配置进行统一的配置,避免客户端配置混乱配置,保证了项目的统一配置,并内置了相应拦截器,用于客户端自定义相关的业务逻辑,比如通过模仿feign的拦截器,解决了feig三方接口调用时无token的尴尬..........
一款 SpringBoot 项目下最优雅的 HTTP 客户端工具，真心强大！
程序员闪充宝
08-31 1560
大家好，我是宝哥！ 大家都知道okhttp是一款由square公司开源的java版本http客户端工具。实际上，square公司还开源了基于okhttp进一步封装的retrofit工具，用来支持通过接口的方式发起http请求。如果你的项目中还在直接使用RestTemplate或者okhttp，或者基于它们封装的HttpUtils，那么你可以尝试使用Retrofit。retrofit-spring...
SpringBoot3 响应式网络请求客户端
Lifelong learning
07-29 1323
WebClient 是Spring WebFlux 模块提供的一个非阻塞的基于响应式编程的进行 Http 请求的客户端工具。完全非阻塞，支持流式处理。
Springboot-Retrofit HTTP工具框架快速使用
weixin_44831330的博客
08-10 1396
Retrofit是适用于Android和Java且类型安全的HTTP客户端，其最大的特性的是支持通过接口的方式发起HTTP请求。而spring-boot是使用最广泛的Java开发框架，但是Retrofit官方没有支持与spring-boot框架快速整合，因此我们开发了retrofit-spring-boot-starter。retrofit-spring-boot-starter实现了Retrofit与spring-boot框架快速整合，并且支持了诸多功能增强，极大简化开发。
java http框架_java-Spring HTTP客户端
weixin_33764463的博客
02-27 268
java-Spring HTTP客户端我是Spring的新手，我需要Java应用程序通过HTTP(JSON，RESTful)连接到另一个API。 Spring框架是否具有JSON HTTP Rest Client之类的东西？ Spring开发人员通常使用什么？marcelorocks asked 2020-07-25T09:45:09Z3个解决方案44 votes通过以下工作，我实现了所需的功能：...
spring boot netty mqtt 客户端源码下载
12-22
您可以通过以下步骤下载Spring Boot Netty MQTT客户端源码： 首先，打开您的浏览器并访问GitHub的官方网站，然后在搜索栏中输入“Spring Boot Netty MQTT客户端源码”并点击搜索按钮。 在搜索结果中，您可以找到与Spring Boot Netty MQTT客户端相关的项目仓库，点击进入该项目的页面。 在项目页面中，您可以找到一个按钮或链接，通常是“Clone”或“Download”，点击它可以选择下载源代码的方式。您可以选择通过Git克隆或直接下载ZIP文件。 如果选择通过Git克隆，您需要在命令行中使用Git工具执行类似于“git clone <项目URL>”的命令来克隆整个代码库到本地。 如果选择直接下载ZIP文件，您可以在浏览器中点击相应的链接，然后解压下载的ZIP文件到您的本地计算机上一个合适的位置。 下载完成后，您就可以在本地计算机上查看并编辑Spring Boot Netty MQTT客户端源码了。 总的来说，通过以上步骤您可以轻松下载Spring Boot Netty MQTT客户端的源码，并进行进一步定制和开发。祝您成功！
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值