Skip to main content

Command Palette

Search for a command to run...

Spring Framework 6.0/Spring Boot 3.0新特性:简单的远程调用HTTP Interfaces

Published
Spring Framework 6.0/Spring Boot 3.0新特性:简单的远程调用HTTP Interfaces

在Spring 6.0之前,我们访问第三方服务或者微服务的http接口主要有这些方式:

  • RestTemplate:可同步访问HTTP服务。
  • WebClient:可同步或异步访问HTTP服务。
  • Feign:在微服务架构中(不限于微服务),用声明式的方式访问HTTP服务。 在Spring 6.0中,我们有了一个更方便的HTTP请求的手段,HTTP Interfaces。HTTP Interfaces类似于Spring Data的Repository或者Spring Cloud OpenFeign一样,我们只需要声明接口就可以完成工作,框架会直接给我们自动代理一个实现。

在实际使用中HTTP Interfaces和Spring Cloud OpenFeign使用感受极其类似。

下面我进行一个极其简单的演示。

1、创建Spring Boot 3工程

打开https://start.spring.io,Spring Boot版本选择3.0.0(SNAPSHOT)(当前最新版本,若有更新版本选择最新版本),Java版本选择17(Spring Boot最低支持版本),依赖选择Spring Web、Spring Reactive Web、Lombok(此时我们还是常规使用Tomcat的同步调用,添加Spring Reactive Web是为了使用WebClient)。

image.png

2、一个在线REST HTTP服务

https://jsonplaceholder.typicode.com

提供多个REST资源。

image.png

我们可以对这些资源进行增删查改的操作,本例选用todos资源。

3、编写客户端和服务端之间的数据传值对象(DTO)

image.png

根据在线资源服务的数据结构编写DTO

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Todo {
   private Long id;
   private Long userId;
   private String title;
   private Boolean completed;
}

4、编写HTTP客户端

@HttpExchange("/todos")
public interface TodoClient {

    @GetExchange("/{todoId}")
    Todo getTodo(@PathVariable Integer todoId);

    @GetExchange
    List<Todo> getTodos();

    @PostExchange
    Todo save(@RequestBody Todo todo);
}

这里和Spring WebMVC的用法是很类似的,不过它声明的是远程的资源,和Spring Cloud OpenFeign一样。

  • @HttpExchange:最通用的一个注解,在类级别将会被所有方法继承,如基础路径地址;在方法级别,需要指定具体的method类型。相当于@RequestMapping
  • @GetExchange:HTTP GET请求。相当于@GetMapping
  • @PostExchange:HTTP POST请求。相当于@PostMapping
  • @PutExchange:HTTP PUT请求。相当于@PutMapping
  • @DeleteExchange:HTTP DELETE请求。相当于@DeleteMapping
  • @PatchExchange:HTTP PATCH请求。相当于@PatchMapping

    5、注册HTTP客户端

    @Configuration
    public class ClientConfig {
      @Bean
      public TodoClient todoClient() throws Exception {
          WebClient webClient = WebClient.builder()
                  .baseUrl("https://jsonplaceholder.typicode.com")
                  .build();
          HttpServiceProxyFactory factory = new HttpServiceProxyFactory(WebClientAdapter.forClient(webClient));
          factory.afterPropertiesSet();
          return factory.createClient(TodoClient.class);
      }
    }
    
    我们的HTTP客户端TodoClient是利用WebClient来实现的。这块以后WebClient应该从Spring Reactive Web剥离出来,或者提供更多其他的HTTP Client的实现,这样就不需要依赖于Spring Reactive Web了。

6、演示

@SpringBootApplication
@Slf4j
public class HttpInterfacesApplication {

    public static void main(String[] args) {
        SpringApplication.run(HttpInterfacesApplication.class, args);
    }

    @Bean
    CommandLineRunner clr(TodoClient todoClient){
        return args -> {
            log.info(todoClient.getTodo(1).toString());
            log.info(todoClient.save(new Todo(null, 1L, "看书", false)).toString());
            for(Todo todo : todoClient.getTodos()){
                log.info(todo.toString());
            }
        };
    }

}

image.png

结语

HTTP interfaces使用起来比RestTemplate和WebClient要简单很多,使用声明式类似于OpenFeign的方式进行远程的HTTP资源的调用,但不需要额外引用Spring Cloud OpenFeign,极大的简化了代码和提高了开发效率。

More from this blog

用Java 17的Records加速Spring Boot开发

在《Spring Boot 2.6新特性:使用Java 17的Record作为配置属性》,我们提到了使用Java Records来作为Spring Boot的配置属性(configuration properties),从而减少了大量样板代码的编写,我们本篇将进一步拓展Records在Spring Boot下的应用场景,从而进一步减少我们的样板代码,使代码看上去更简洁清晰。 1、什么是Records record是一种特殊类型的类声明,目的是为了减少样板代码。record引入的主要目的是快速创...

Nov 11, 2022
用Java 17的Records加速Spring Boot开发

Spring Boot 2.6新特性:使用Java 17的Record作为配置属性

Spring Boot 3.0的基线版本是Java 17,Spring Boot 3.0版本将全面对Java 17的支持。较新版本的2.x的Spring Boot版本也可以使用Java 17的特性。 本文介绍Spring Boot 2.6对Java 17支持的一个新特性,使用Java 17的Record来做为Spring Boot的配置属性(ConfiguartionProperties)。 什么是Record record是一种特殊类型的类声明,目的是为了减少样板代码。record引入的主要目...

Nov 3, 2022
Spring Boot 2.6新特性:使用Java 17的Record作为配置属性

使用Gradle全面加速Spring Boot开发

大家都知道Gradle和Maven一样,是一个项目的构建工具。它通过任务来控制开发的进程,这些任务包括:编译、打包、测试、部署和发布等。Gradle诞生于2008年,仅仅比Maven晚4年。Android也采用Gradle作为默认的构建工具。 本文期望通过以下的讲述,帮助你快速轻松的使用Gradle加速您的Spring Boot开发应用。 1、Gradle越来越流行 2012年开始,Spring框架已全部使用Gradle来构建;2020年开始,Spring Boot也全部采用Gradle来构建...

Oct 31, 2022
使用Gradle全面加速Spring Boot开发

Spring/Spring Boot下如何动态配置计划任务

在Spring/Spring Boot下实现计划任务是很简单的,我们只需通过@EnableScheduling 开启计划任务的支持,然后通过@Scheduled 注解来制定计划任务,这样的实现解决了我们对计划任务的绝大部分需求。 但在很多时候,通过上述方式实现的计划任务是在代码里写死的,我们需要修改计划任务只能通过修改代码的方式实现。很多时候,我们需要从外部来设置计划任务执行的时间和方式。所以在本文中,我们着重讲解一下如何动态地配置计划任务。 和Spring对异步任务的支持一样,通过@Enabl...

Oct 29, 2022
Spring/Spring Boot下如何动态配置计划任务

Spring 6/Spring Boot 3新特性:优雅的业务异常处理

当你使用Spring Boot(Spring MVC)进行RESTful API开发的时候,你会发现HTTP的状态码很多时候不能足够有效的传递错误的信息。 HTTP里有一个RFC 7807规范:https://www.rfc-editor.org/rfc/rfc7807。这个规范里定义了HTTP API的“问题细节”(Problem Details)内容。 该规范定义了一个“问题细节”(Problem Details),用它来携带HTTP错误返回信息,避免自定义新的错误返回格式。我们通常情况下是...

Oct 28, 2022
Spring 6/Spring Boot 3新特性:优雅的业务异常处理

汪云飞的工具箱

24 posts