來試試 SpringBoot3 中的這個新玩意!
今天我們就來聊一個 Spring Boot3 中的新鮮玩意,聲明式 HTTP 調(diào)用。
1. 由來
Spring Boot3 去年底就已經(jīng)正式發(fā)布,我也嘗了一把鮮,最近有空會和小伙伴們慢慢聊聊 Spring Boot3 都給我們帶來了哪些新東西。
今天我們就先來看看聲明式 HTTP 接口。
用過 Spring Cloud 的小伙伴都知道,在 Spring Cloud 家族中,負責(zé)進程間通信的,我們可以使用 RestTemplate 或者 OpenFeign(當然也有其他方式如基于消息中間件的消息驅(qū)動的微服務(wù)或者基于 gRPC 的調(diào)用等)。
RestTemplate 我們可以將之當作一個普普通通的 HTTP 調(diào)用工具來對待,區(qū)別于其他的 HTTP 客戶端,RestTemplate 用來調(diào)用 RESTful 風(fēng)格的接口特別方便。
不過,比 RestTemplate 更加方便的是 OpenFeign,通過接口聲明就可以實現(xiàn)遠程調(diào)用。
以前我們想要用聲明式 HTTP 調(diào)用,需要通過 OpenFeign 來實現(xiàn),這個需要第三方的依賴,從 Spring6 開始(Spring Boot3),Spring 自己提供了類似的功能通過 @HttpExchange 注解也能方便的實現(xiàn) 聲明式 HTTP 調(diào)用。以后跨服務(wù)調(diào)用又多了一個選擇。
2. 使用
接下來通過一個案例來和小伙伴們演示一下 @HttpExchange 注解的具體玩法。
首先我們先創(chuàng)建一個普通的名為 server 的 Spring Boot 項目,這個普通的 Spring Boot 項目中只需要提供一個簡單的測試接口即可,如下:
這個對大家來說應(yīng)該是沒什么難度的,我就不多說了。
現(xiàn)在假設(shè)我有另外一個服務(wù)名為 client,我想在 client 中調(diào)用 server 中提供的這個接口。
首先我們來創(chuàng)建 client 這個項目,大家注意,創(chuàng)建的時候我們不僅需要添加 Web 依賴,還需要 Reactive Web,因為這個 @HttpExchange 底層基于 WebClient,而 WebClient 則是 Reactive Web 提供的:

創(chuàng)建完成后,接下來我們就可以聲明 Http 接口了:
這些用法跟我們在 SpringMVC 中常用的 @RequestMapping 和 @GetMapping 等特別類似:
@HttpExchange 類似于 @RequestMapping,可以將之放在類上,起到一個請求窄化的作用,也可以放在方法上,放在方法上我們可以通過 method 屬性來指定具體的請求方法,這個也跟 @RequestMapping 類似:@HttpExchange(value = "/server",method = "GET")。
@GetExchange 類似于 @GetMapping,這個就不再贅述了,其他類似的注解還有 @DeleteExchange、@PatchExchange、@PostExchange、@PutExchange 等。
另外需要注意的是請求方法的參數(shù)需要加上 @RequestParam 注解,這一點和 OpenFeign 比較類似。
接口聲明好之后還沒完,我們還需要配置一下才能使用。如下:
這個配置主要是兩方面:
@HttpExchange 是基于 WebClient 的,所以我們首先需要配置 WebClient,配置 WebClient 的時候,也順便配置了請求的具體地址(因為在 @HttpExchange 注解中并未指定請求的具體域名端口啥的);同時,對于 HTTP 請求頭等如果需要定制,也是通過配置 WebClient 來實現(xiàn)的。
由于我們前面提供的 ToDoService 是一個接口,所以我們還需要提供一個該接口的實現(xiàn)類,當然這個配置完全是套路化模版化的,這塊就沒啥好說了。
全部配置完成后,接下來我們就可以在任何需要的地方,直接注入 ToDoService 的實例去使用了,舉一個簡單的例子小伙伴們參考下:
好啦,一個簡單的例子,小伙伴們不妨體驗下。
以后,不用 OpenFeign 也能實現(xiàn)聲明式服務(wù)調(diào)用啦~