Java Http 接口对接太繁琐?试试 UniHttp 框架~

简介: 【10月更文挑战第10天】在企业级项目开发中,HTTP接口对接是一项常见且重要的任务。传统的编程式HTTP客户端(如HttpClient、Okhttp)虽然功能强大,但往往需要编写大量冗长且复杂的代码,这对于项目的可维护性和可读性都是一个挑战。幸运的是,UniHttp框架的出现为这一问题提供了优雅的解决方案。

Java Http 接口对接太繁琐?试试 UniHttp 框架~

在企业级项目开发中,HTTP接口对接是一项常见且重要的任务。传统的编程式HTTP客户端(如HttpClient、Okhttp)虽然功能强大,但往往需要编写大量冗长且复杂的代码,这对于项目的可维护性和可读性都是一个挑战。幸运的是,UniHttp框架的出现为这一问题提供了优雅的解决方案。

UniHttp框架简介

UniHttp是一个声明式的HTTP接口对接框架,它能够极大地简化HTTP请求的发送过程。使用UniHttp,开发者可以像调用本地方法一样发起HTTP请求,而无需关注请求的发送细节、参数传递、结果处理和反序列化等问题。这种框架的设计哲学是将HTTP请求的复杂性封装起来,让开发者更专注于业务逻辑的实现。

快速开始

引入依赖

首先,需要在项目的pom.xml文件中引入UniHttp的依赖:

<dependency>
    <groupId>io.github.burukeyou</groupId>
    <artifactId>uniapi-http</artifactId>
    <version>0.0.4</version>
</dependency>

对接接口

接下来,可以创建一个接口,并使用@HttpApi注解来标记。在接口中定义的方法将对应于要对接的HTTP接口。例如:

@HttpApi(url = "http://localhost:8080")
interface UserHttpApi {
   
    @GetHttpInterface("/getUser")
    BaseRsp<String> getUser(@QueryPar("name") String param, @HeaderPar("userId") Integer id);
    @PostHttpInterface("/addUser")
    BaseRsp<Add4DTO> addUser(@BodyJsonPar Add4DTO req);
}

在这里,@GetHttpInterface@PostHttpInterface注解分别用于定义GET和POST请求,而@QueryPar@HeaderPar@BodyJsonPar注解用于指定请求的查询参数、请求头和请求体。

配置自定义的Http客户端

默认情况下,UniHttp使用的是Okhttp客户端。如果需要自定义HttpClient,可以在Spring的配置类中定义一个OkHttpClient的Bean:

@Configuration
public class CustomConfiguration {
   
    @Bean
    public OkHttpClient myOHttpClient(){
   
        return new OkHttpClient.Builder()
            .readTimeout(50, TimeUnit.SECONDS)
            .writeTimeout(50, TimeUnit.SECONDS)
            .connectTimeout(10, TimeUnit.SECONDS)
            .connectionPool(new ConnectionPool(20,10, TimeUnit.MINUTES))
            .build();
    }
}

企业级渠道对接实战

假设我们需要对接一个天气服务的所有接口,这些接口需要在请求的cookie中带上token和sessionId字段,这些字段需要通过调用特定接口获取。此外,还需要在请求头上带上一个签名字段,该字段的生成规则需要用渠道方提供的公钥对所有请求体和请求参数进行加签生成。

application.yml中配置对接渠道方的信息

channel:
  mtuan:
    url: http://127.0.0.1:8999
    appId: UUU-asd-01
    publicKey: fajdkf9492304jklfahqq

自定义该渠道方的HttpAPI注解

通过定义自定义注解和处理器,可以轻松实现上述需求。例如,可以实现一个HttpApiProcessor来处理请求前的签名、发送请求时的动态令牌获取和日志打印、响应后的数据处理等。

对接接口

使用@MTuanHttpApi注解对接具体的接口,例如获取令牌和天气情况的接口。

自定义HttpApiProcessor

通过实现HttpApiProcessor接口,可以自定义HTTP请求的生命周期钩子,例如在请求发送前对请求体进行加签、在发送请求时动态获取令牌重新构建请求体和打印日志、在发送请求后给响应对象设置code为999等。

总结

UniHttp框架通过提供声明式的HTTP接口对接方式,极大地简化了HTTP请求的发送过程。它不仅支持基本的GET、POST请求,还支持请求和响应的拦截器、自定义HTTP客户端配置等高级功能。使用UniHttp,开发者可以更加专注于业务逻辑的实现,而不是被HTTP请求的细节所困扰。如果你的项目中也需要对接第三方HTTP接口,不妨试试UniHttp框架,它可能会给你带来意想不到的便利和效率提升。

目录
相关文章
|
1月前
|
Java 开发者
在 Java 中,一个类可以实现多个接口吗?
这是 Java 面向对象编程的一个重要特性,它提供了极大的灵活性和扩展性。
148 57
|
1月前
|
Java
在Java中实现接口的具体代码示例
可以根据具体的需求,创建更多的类来实现这个接口,以满足不同形状的计算需求。希望这个示例对你理解在 Java 中如何实现接口有所帮助。
87 38
|
7天前
|
数据采集 JSON Java
利用Java获取京东SKU接口指南
本文介绍如何使用Java通过京东API获取商品SKU信息。首先,需注册京东开放平台账号并创建应用以获取AppKey和AppSecret。接着,查阅API文档了解调用方法。明确商品ID后,构建请求参数并通过HTTP客户端发送请求。最后,解析返回的JSON数据提取SKU信息。注意遵守API调用频率限制及数据保护法规。此方法适用于电商平台及其他数据获取场景。
|
12天前
|
安全 Java API
java如何请求接口然后终止某个线程
通过本文的介绍,您应该能够理解如何在Java中请求接口并根据返回结果终止某个线程。合理使用标志位或 `interrupt`方法可以确保线程的安全终止,而处理好网络请求中的各种异常情况,可以提高程序的稳定性和可靠性。
43 6
|
29天前
|
Java API
Java中内置的函数式接口
Java中内置的函数式接口
25 2
|
1月前
|
Java API Maven
商汤人像如何对接?Java代码如何写?
商汤人像如何对接?Java代码如何写?
41 5
|
1月前
|
Java
在Java中,接口之间可以继承吗?
接口继承是一种重要的机制,它允许一个接口从另一个或多个接口继承方法和常量。
97 1
|
Web App开发 前端开发
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html><head><meta http-equiv="Cont
总结和计划总是让人喜悦或镇痛,一方面以前一段时间没有荒废,能给现在的行动以信心,另一方面看到一年的时间并不能完成很多事情,需要抓紧时间。
623 0
|
Web App开发 监控 前端开发
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html><head><meta http-equiv="Cont
系统的升级涉及各个架构组件,细节很多。常年累月的修修补补使老系统积累了很多问题。 系统升级则意味着需要repair之前埋下的雷,那为何还要升级,可以考虑以下几个方面 成熟老系统常见问题: 1. 缺乏文档(这应该是大小公司都存在的问题。
627 0