自定义springboot组件--统一封装http客户端实现

置顶 已于 2022-07-25 15:54:49 修改
阅读量1.3k 收藏
点赞数 3
分类专栏： 自定义springboot组件 文章标签： spring boot http java
于 2022-07-25 15:49:16 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Instanceztt/article/details/125975900
版权

http是第三方接口调用的常用工具,该组件通过对常见的http客户端工具进行统一的整合,参考了feign的上下文和springmvc的拦截器等相关设计思路,设计了相应的Context用于对请求上下文的相关配置进行统一的配置,避免客户端配置混乱配置,保证了项目的统一配置,并内置了相应拦截器,用于客户端自定义相关的业务逻辑,比如:通过模仿feign的拦截器,解决了feig三方接口调用时无token的尴尬.

一 基本原理

在这里插入图片描述

  • 客户端发起http调用时,通过请求执行器,执行底层请求逻辑
  • 从请求的上下文中获得相应编码器,对body进行统一的序列化处理
  • 获得相应的前置处理器,执行自定义的业务前置处理(如token等公用参数的绑定)
  • 调用httprequestclient执行http请求(更具项目的自身需求,配置相应的客户端,默认为:JDK HttpURLConnection)
  • 请求发生异常,执行requestExceptionHandler中handler逻辑
  • 解析当前响应状态码,状态码不为200执行responseErrorHandler逻辑
  • 根据当前请求是否配置相应的响应前置处理器,做响应前置处理,没有直接通过解码器反序列化后相应当前请求的数据

二 客户端调用

2.1 根据项目的实际需求配置核心参数

详见源码具体配置
在这里插入图片描述

2.2 根据项目的实际需求选择相应的http客户端

在这里插入图片描述

在这里插入图片描述
在这里插入图片描述
默认http客户端
在这里插入图片描述

2.3 引入相应的组件

 <dependency>
            <groupId>com.cncloud</groupId>
            <artifactId>shell-platform-common-http-client</artifactId>
 </dependency>

2.4 bean方式调用

@RestController
@RequestMapping("/client")
@Slf4j
public class HttpClientController {

    @Autowired
    private HttpRequestExecutor httpRequestExecutor;

    public static final String LOGIN_URL = "https://develop.shequtalk.com/auth/oauth/token";

    public static final String GET_URL = "https://develop.shequtalk.com/admin/user/getUserListByDept";



    @PostMapping("/testPost")
    @Inner(value = false)
    public void testPost(){
        HttpRequest request = getLoginRequest();
        final R result = httpRequestExecutor.execute(request);
        log.info("login result : {}",result);
    }

    @GetMapping("/testGet")
    @Inner(value = false)
    public void testGet(){
        HttpRequest request = new BasicRequestBuilder(GET_URL)
                .header("tenant-id", "6054656364413952")
                .header("authorization", "Bearer 8350ebce-1f98-41e3-a30f-69f4f6702119")
                .method(RequestMethod.GET)
                .query("sysDeptId", "6054656376194048")
                .query("current", 1)
                .query("size", 10)
                .resultType(R.class)
                .build();
        R result = httpRequestExecutor.execute(request);
        log.info("query result: {}",result);
    }
    private HttpRequest getLoginRequest() {
        HashMap<String, Object> bodyMap = new HashMap<>();
        bodyMap.put("username","szs");
        bodyMap.put("password","rKu1/348LvKp0rsVC06eCA==");
        bodyMap.put("grant_type","password");

        HttpRequest request = new BodyRequestBuilder<>(LOGIN_URL)
                .header("tenant-id", "6054656364413952")
                .header("authorization","Basic c2hlbGxwYzpzaGVsbHBj")
                .method(RequestMethod.POST)
                .form(bodyMap)
                .resultType(R.class)
                .build();
        return request;
    }
}

采用相应的构造者构建相应的请求
在这里插入图片描述

2.5 非bean方式调用

@RestController
@RequestMapping("/client")
@Slf4j
public class HttpClientController {

    @Autowired
    private HttpRequestExecutor httpRequestExecutor;

    public static final String LOGIN_URL = "https://develop.shequtalk.com/auth/oauth/token";

    public static final String GET_URL = "https://develop.shequtalk.com/admin/user/getUserListByDept";
    
    @PostMapping("/testNoBeanWithHutool")
    @Inner(value = false)
    public void testNoBeanWithHutool(){
        HttpRequestClient httpRequestClient = new HutoolRequestClient();
        final HttpRequestExecutor httpRequestExecutor = initHttpRequestExecutor(httpRequestClient);
        HttpRequest request = getLoginRequest();
        final R result = httpRequestExecutor.execute(request);
        log.info("login result : {}",result);
    }

    private HttpRequestExecutor initHttpRequestExecutor(HttpRequestClient httpRequestClient) {

        return new DefaultHttpRequestExecutor(getContext(), httpRequestClient);
    }

    private Context getContext() {
        TimeoutSetting timeoutSetting = new TimeoutSetting();
        Encoder encoder = new DefaultEncoder();
        Decoder decoder = new DefaultDecoder();
        return new DefaultContext(timeoutSetting, decoder, encoder);
    }



    private HttpRequest getLoginRequest() {
        HashMap<String, Object> bodyMap = new HashMap<>();
        bodyMap.put("username","szs");
        bodyMap.put("password","rKu1/348LvKp0rsVC06eCA==");
        bodyMap.put("grant_type","password");

        HttpRequest request = new BodyRequestBuilder<>(LOGIN_URL)
                .header("tenant-id", "6054656364413952")
                .header("authorization","Basic c2hlbGxwYzpzaGVsbHBj")
                .method(RequestMethod.POST)
                .form(bodyMap)
                .resultType(R.class)
                .build();
        return request;
    }
}

三 核心API

/**
 * http请求执行器
 * @author likun
 * @date 2022/7/25 10:14
 */
public interface HttpRequestExecutor {
    /**
     *  执行http请求(异常处理器及前置拦截器均可传入)
     * @param request 核心请求
     * @param requestExceptionHandler 请求发送异常处理器
     * @param responseErrorHandler 相应异常处理器
     * @param requestInterceptor 请求拦截器
     * @param responseInterceptor 相应拦截器
     * @param <T>
     * @return
     */
    <T> T execute(HttpRequest request, RequestExceptionHandler requestExceptionHandler, ResponseErrorHandler responseErrorHandler,
                  RequestInterceptor requestInterceptor, ResponseInterceptor responseInterceptor);

    /**
     * 执行http请求(使用默认的拦截器和异常处理器)
     * @param request
     * @param <T>
     * @return
     */
    default <T> T execute(HttpRequest request){
        return execute(request,null,null,null,null);
    }

    /**
     * 执行http请求 (可以传入请求异常及响应状态码非200的请求处理器)
     * @param request
     * @param requestExceptionHandler
     * @param responseErrorHandler
     * @param <T>
     * @return
     */
    default <T> T execute(HttpRequest request, RequestExceptionHandler requestExceptionHandler, ResponseErrorHandler responseErrorHandler){
        return execute(request, requestExceptionHandler, responseErrorHandler, null, null);
    }

    /**
     * 执行http请求(可以传入请求前置拦截器及响应解码的前置拦截器)
     * @param request
     * @param requestInterceptor
     * @param responseInterceptor
     * @param <T>
     * @return
     */
    default <T> T execute(HttpRequest request, RequestInterceptor requestInterceptor, ResponseInterceptor responseInterceptor) {
        return execute(request, null, null, requestInterceptor, responseInterceptor);
    }


}

四 项目源码

由于改组件的源码较长,这里不在文章中展示,需要的可以私信笔者.

SpringBoot 封装Http请求
谁念西风独自凉
04-15 693
Java SpringBoot 实现Http请求的封装
Spring Boot项目封装OkHttp，并实现重试调用（超时、返回HTTP错误、返回业务异常）
qq_38404990的博客
05-26 1730
Spring Boot封装OkHttp，实现重试调用，解决response.body().string()调用后关闭问题
Springboot统一封装Http响应内容实战
12-30
Springboot统一封装Http响应内容实战
在 Spring Boot 中选择合适的 HTTP 客户端
最新发布
weixin_41544125的博客
05-09 718
如果你需要一个简单的同步客户端，可以选择Java 的HttpClient或Spring 的。如果你需要处理高并发的异步请求，Spring 的WebClient是一个不错的选择。如果你需要一个功能强大的客户端，支持复杂的 HTTP 请求，可以考虑。如果你需要与 Elasticsearch 交互，可以使用Elasticsearch 的。
Spring boot 发送http请求组件RestTemplate使用实例
dns007
01-26 5568
原文链接 Spring Boot 网络请求 之 RestTemplate 使用例子 引入SpringBoot依赖 1234567891011121314151617181920212223242526272829303132333435 org.springframework.boot spring-boot-starter-parent 1.5.2.R
Spring Boot 项目HTTP 客户端工具
KHOST的博客
08-10 425
链接：juejin.im/post/6854573211426750472 大家都知道okhttp是一款由square公司开源的java版本http客户端工具。实际上，square公司还开源了基于okhttp进一步封装的retrofit工具，用来支持通过接口的方式发起http请求。如果你的项目中还在直接使用RestTemplate或者okhttp，或者基于它们封装的HttpUtils，那么你可以尝试使用Retrofit。 retrofit-spring-boot-starter实现了Retrofit与s
自定义springboot组件--基于模板模式对原生springboot的rabbitmq组件进行扩展
Instanceztt的博客
06-22 774
在我们的日常开发中,消息中间件已经成为了java研发工程师的一项必备技能,本文主要是基于对springboot原生组件的扩展开发,基于模板设计模式和静态代理模式,简化了队列路由的绑定,交由公共模板进行统一的绑定,并在公用模板中保证了消息的幂等性和消息的可靠性投递,将这些类似的代码抽离出来,让开发者只专注于业务逻辑的开发.整体实现思路: 将静态代理器和初始器交由spring容器管理 将初始化容器交给spring容器管理 2.4 申明公用基础属性 2.5定义sprin
rocketmq-spring-boot-starter:RocketMQ客户端封装类，基于最新版本4.5.2
05-26
你可以通过本项目轻松的集成Rocketmq到你的SpringBoot项目中。 本项目主要包含以下特性 同步发送消息 异步发送消息 广播发送消息 有序发送和消费消息 发送延时消息 消息tag和key支持 自动序列化和反序列化...
案例实战-SpringBoot3.x自定义封装starter实战
06-03
在本案例实战中，我们将深入探讨如何在Spring Boot 3.x框架中自定义并封装一个starter。Spring Boot的starter是其核心特性之一，它提供了一种便捷的方式来配置和使用各种功能模块，使得开发者可以快速搭建应用。理解...
SpringBoot2--国际化
weixin_43233653的博客
09-30 462
前言 国际化信息也称为本地化信息 。 Java 通过 java.util.Locale 类来表示本地化对象，它通过 “语言类型” 和 “国家/地区” 来创建一个确定的本地化对象 。举个例子吧，比如在发送一个具体的请求的时候，在header中设置一个键值对：“Accept-Language”：“zh”，通过Accept-Language对应值，服务器就可以决定使用哪一个区域的语言，找到相应的资源文件，格式化处理，然后返回给客户端。 一、国际化原理 国际化首先要获得区域信息对象LocaleResolver，在W
微服务常用组件封装项目过程详细介绍总述(七)---基于springboot的自定义security starter组件开发
weixin_47407416的博客
12-16 893
对spring-security-oauth2进行springboot starter组件封，同时集成spring-security-oauth2,justauth-spring-boot-starter,,对spring-security进行简单扩充,自定义处理各种handle,但不涉及具体的认证，具体认证后续会有一个认证服务专门去处理认证跟三方登录问题
httpclient(springboot)demo
05-06
基于springboot+httpClient无缝整合在一起的demo例子（资源分享）！
spring boot封装HttpClient的示例代码
08-28
主要介绍了spring boot封装HttpClient的示例代码，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
SpringBoot发送http请求
LifeBackwards的专栏
05-26 2526
此外，需要定义一个RestTemplate配置类。HttpUtils工具类如下。
SpringBoot 项目高效 HTTP 通信：常用客户端大比拼！
weixin_45593273的博客
09-25 1187
RestTemplate 是 Spring 框架提供的用于进行 HTTP 请求的强大工具。它封装了许多常见的 HTTP 操作，使得开发者可以轻松地与 RESTful 服务进行交互。OkHttp 是一个高效的 HTTP 客户端，被广泛应用于 Android 和 Java 项目中。WebClient 是 Spring 5 引入的一个非阻塞式的 HTTP 客户端。它基于 Reactive Streams 规范，提供了一种响应式的编程模型。
Springboot使用Feign客户端发送HTTP请求，代替​RestTemplate​远程调用
Xmi2599的博客
06-12 3448
在 Spring Boot 中，可以使用 Feign 来创建 HTTP 客户端，通过简单的注解方式即可实现服务间的远程调用。Feign是一种声明式、模板化的HTTP客户端，在往常的 HTTP 调用中，一直都是使用的官方提供的来进行远程调用，该调用方式将组装代码冗余到正常业务代码中，不够优雅，因此，可以考虑用Feign来替代。
SpringBoot3 响应式网络请求客户端
Lifelong learning
07-29 1493
WebClient 是Spring WebFlux 模块提供的一个非阻塞的基于响应式编程的进行 Http 请求的客户端工具。完全非阻塞，支持流式处理。
springboot发送http请求
weixin_34405557的博客
11-14 817
springboot中实现http请求调用api 创建发送http请求service层 importorg.springframework.http.*; importorg.springframework.stereotype.Service; importorg.springframework.util.MultiValueMap; im...
【Spring】httpClient 类封装
qq_34416331的博客
05-16 289
一、httpClient 使用的场景 当服务器后端需要向其他服务请求时，常用到 httpClient。HttpClient 可以模拟浏览器向服务器发送 http 请求，并获取响应。 二、使用 2.1 添加依赖 <!-- httpclient --> <dependency> <groupId>org.apache.httpcomponents</groupId> <artifactId>httpclient</.
springboot-HTTP RESTful API
12-27
### 如何使用 Spring Boot 创建 HTTP RESTful API #### 项目创建与依赖管理 要开始构建基于 Spring Boot 的 RESTful API 应用程序，首先需要设置一个新的 Maven 或 Gradle 项目，并引入必要的依赖项。对于大多数 Web 应用来说，`spring-boot-starter-web` 是必需的，因为它包含了构建 Web 应用所需的核心库。 ```xml <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> </dependencies> ``` #### 启动类定义 接着，在应用程序入口处编写启动类，该类通常带有 `@SpringBootApplication` 注解，用于启用自动配置和其他特性。此注解集成了组件扫描、配置属性加载等功能[^3]。 ```java package cn.juwatech.springbootrest; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class SpringBootRestApplication { public static void main(String[] args) { SpringApplication.run(SpringBootRestApplication.class, args); } } ``` #### 控制器层设计 为了暴露 REST 接口给客户端调用，需创建一个控制器类。此类中的每一个公共方法都映射到具体的 URL 路径上，并通过相应的 HTTP 方法访问。例如： - 使用 `@RestController` 来标记这是一个返回 JSON 数据而非视图页面的控制器； - 利用 `@RequestMapping`, `@GetMapping`, `@PostMapping` 等注解指定路由规则以及所支持的方法类型； 下面是一个简单的例子展示如何获取单个用户的详情信息[^5]。 ```java @RestController @RequestMapping("/api/users") public class UserController { private final UserService userService; @Autowired public UserController(UserService userService){ this.userService = userService; } /** * 获取指定ID的用户对象. */ @GetMapping("/{id}") public ResponseEntity<User> getUserById(@PathVariable Long id) { User user = userService.findById(id).orElseThrow(() -> new ResourceNotFoundException("User not found")); return ResponseEntity.ok(user); } // 更多接口... } ``` 这里展示了基本 CRUD 操作之一——读取资源的操作模式。当接收到 GET 请求 `/api/users/{id}` 时，会触发上述方法执行查询逻辑并将结果封装成 `ResponseEntity` 返回给前端。 #### 错误处理机制 良好的错误处理也是高质量 API 设计的一部分。可以自定义全局异常处理器来统一管理和标准化不同类型的异常情况下的响应格式。这有助于提高用户体验的一致性和可靠性。 ```java @ControllerAdvice public class GlobalExceptionHandler extends ResponseEntityExceptionHandler { @ExceptionHandler(ResourceNotFoundException.class) protected ResponseEntity<Object> handleResourceNotFound(RuntimeException ex, WebRequest request) { String bodyOfResponse = "This should be application specific"; return handleExceptionInternal(ex, bodyOfResponse, new HttpHeaders(), HttpStatus.NOT_FOUND, request); } // 处理更多异常... } ``` 以上就是利用 Spring Boot 构建简单却功能完备的 RESTful API 所涉及的关键要素概述[^1]。
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值