還在用 OpenFeign?來試試 SpringBoot3 中的這個(gè)新玩意!

好久沒發(fā)技術(shù)文章了,最近回到工作地,晚上有空又可以碼碼技術(shù)了,今天我們就來聊一個(gè) Spring Boot3 中的新鮮玩意,聲明式 HTTP 調(diào)用。

1. 由來

Spring Boot3 去年底就已經(jīng)正式發(fā)布,我也嘗了一把鮮,最近有空會(huì)和小伙伴們慢慢聊聊 Spring Boot3 都給我們帶來了哪些新東西。

今天我們就先來看看聲明式 HTTP 接口。

用過 Spring Cloud 的小伙伴都知道,在 Spring Cloud 家族中,負(fù)責(zé)進(jìn)程間通信的,我們可以使用 RestTemplate 或者 OpenFeign(當(dāng)然也有其他方式如基于消息中間件的消息驅(qū)動(dòng)的微服務(wù)或者基于 gRPC 的調(diào)用等)。

RestTemplate 我們可以將之當(dāng)作一個(gè)普普通通的 HTTP 調(diào)用工具來對(duì)待,區(qū)別于其他的 HTTP 客戶端,RestTemplate 用來調(diào)用 RESTful 風(fēng)格的接口特別方便。

不過,比 RestTemplate 更加方便的是 OpenFeign,通過接口聲明就可以實(shí)現(xiàn)遠(yuǎn)程調(diào)用,這些的具體用法松哥在之前的視頻中講過,這里就不再贅述了。

以前我們想要用聲明式 HTTP 調(diào)用,需要通過 OpenFeign 來實(shí)現(xiàn),這個(gè)需要第三方的依賴,從 Spring6 開始(Spring Boot3),Spring 自己提供了類似的功能通過 @HttpExchange 注解也能方便的實(shí)現(xiàn) 聲明式 HTTP 調(diào)用。以后跨服務(wù)調(diào)用又多了一個(gè)選擇。

2. 使用

接下來松哥通過一個(gè)案例來和小伙伴們演示一下 @HttpExchange 注解的具體玩法。

首先我們先創(chuàng)建一個(gè)普通的名為 server 的 Spring Boot 項(xiàng)目,這個(gè)普通的 Spring Boot 項(xiàng)目中只需要提供一個(gè)簡(jiǎn)單的測(cè)試接口即可,如下:

@RestController
public class HelloController {

    @GetMapping("/server/hello")
    public String hello(String name) {
        return "hello " + name;
    }

}

這個(gè)對(duì)大家來說應(yīng)該是沒什么難度的,我就不多說了。

現(xiàn)在假設(shè)我有另外一個(gè)服務(wù)名為 client,我想在 client 中調(diào)用 server 中提供的這個(gè)接口。

首先我們來創(chuàng)建 client 這個(gè)項(xiàng)目,大家注意,創(chuàng)建的時(shí)候我們不僅需要添加 Web 依賴,還需要 Reactive Web,因?yàn)檫@個(gè) @HttpExchange 底層基于 WebClient,而 WebClient 則是 Reactive Web 提供的:

image

創(chuàng)建完成后,接下來我們就可以聲明 Http 接口了:

@HttpExchange("/server")
public interface ToDoService {
    @GetExchange("/hello")
    String hello(@RequestParam String name);
}

這些用法跟我們?cè)?SpringMVC 中常用的 @RequestMapping 和 @GetMapping 等特別類似:

  • @HttpExchange 類似于 @RequestMapping,可以將之放在類上,起到一個(gè)請(qǐng)求窄化的作用,也可以放在方法上,放在方法上我們可以通過 method 屬性來指定具體的請(qǐng)求方法,這個(gè)也跟 @RequestMapping 類似: @HttpExchange(value = "/server",method = "GET")。
  • @GetExchange 類似于 @GetMapping,這個(gè)就不再贅述了,其他類似的注解還有 @DeleteExchange、@PatchExchange、@PostExchange、@PutExchange 等。
  • 另外需要注意的是請(qǐng)求方法的參數(shù)需要加上 @RequestParam 注解,這一點(diǎn)和 OpenFeign 比較類似。

接口聲明好之后還沒完,我們還需要配置一下才能使用。如下:

@Configuration
public class WebConfig {
    @Bean
    WebClient webClient() {
        return WebClient.builder()
                .baseUrl("http://localhost:8080")
                .build();
    }
    @Bean
    ToDoService toDoService() {
        HttpServiceProxyFactory httpServiceProxyFactory =
                HttpServiceProxyFactory.builder(WebClientAdapter.forClient(webClient()))
                        .build();
        return httpServiceProxyFactory.createClient(ToDoService.class);
    }
}

這個(gè)配置主要是兩方面:

  1. @HttpExchange 是基于 WebClient 的,所以我們首先需要配置 WebClient,配置 WebClient 的時(shí)候,也順便配置了請(qǐng)求的具體地址(因?yàn)樵?@HttpExchange 注解中并未指定請(qǐng)求的具體域名端口啥的);同時(shí),對(duì)于 HTTP 請(qǐng)求頭等如果需要定制,也是通過配置 WebClient 來實(shí)現(xiàn)的。
  2. 由于我們前面提供的 ToDoService 是一個(gè)接口,所以我們還需要提供一個(gè)該接口的實(shí)現(xiàn)類,當(dāng)然這個(gè)配置完全是套路化模版化的,這塊就沒啥好說了。

全部配置完成后,接下來我們就可以在任何需要的地方,直接注入 ToDoService 的實(shí)例去使用了,舉一個(gè)簡(jiǎn)單的例子小伙伴們參考下:

@SpringBootTest
class ClientApplicationTests {

    @Autowired
    ToDoService toDoService;

    @Test
    void contextLoads() {
        String hello = toDoService.hello("javaboy");
        System.out.println("hello = " + hello);
    }

}

好啦,一個(gè)簡(jiǎn)單的例子,小伙伴們不妨體驗(yàn)下。

以后,不用 OpenFeign 也能實(shí)現(xiàn)聲明式服務(wù)調(diào)用啦~

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容