我們?cè)谌粘ｉ_(kāi)發(fā)中，經(jīng)常會(huì)需要遠(yuǎn)程調(diào)用其他服務(wù)提供的接口，比較常用的 HTTP 遠(yuǎn)程代理框架有OpenFeign、Retrofit以及一些第三方封裝工具類(lèi)，例如Hutool提供的HttpUtil。

11月24日，Spring Boot 3正式發(fā)布，Spring官方已經(jīng)自身支持使用聲明式服務(wù)調(diào)用的方式來(lái)調(diào)用遠(yuǎn)程接口。

雖然類(lèi)似的遠(yuǎn)程調(diào)用框架如OpenFeign和Retrofit仍然可以使用，但HttpServiceProxyFactory增加了對(duì) Spring 框架的原生支持。如果Spring本身可以做到遠(yuǎn)程調(diào)用的話，這些大量的第三方庫(kù)應(yīng)該很快會(huì)被原生方法取代，我們今天來(lái)了解一下這個(gè)新特征。

聲明式 Http 接口

聲明性 HTTP 接口可以讓你像定義Java接口那樣定義HTTP服務(wù)，用法和你平時(shí)寫(xiě)Controller中方法完全一致。

引入

聲明性 HTTP 接口功能是spring-web依賴項(xiàng)的一部分，使用前必須引入如下依賴包：

<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webartifactId>
dependency>

<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webfluxartifactId>
dependency>

創(chuàng)建 HTTP 服務(wù)接口

在 Spring 中，HTTP 服務(wù)接口是一個(gè)帶有@HttpExchange方法的 Java 接口。注釋方法被視為 HTTP 端點(diǎn)，細(xì)節(jié)通過(guò)注釋屬性和輸入方法參數(shù)類(lèi)型靜態(tài)定義。

支持的注解類(lèi)型

• @HttpExchange ：是用于指定 HTTP 端點(diǎn)的通用注釋。在接口級(jí)別使用時(shí)，它適用于所有方法。
• @GetExchange ：為 HTTP GET請(qǐng)求指定@HttpExchange。
• @PostExchange ：為 HTTP POST請(qǐng)求指定@HttpExchange。
• @PutExchange ：為 HTTP PUT請(qǐng)求指定@HttpExchange。
• @DeleteExchange ：為 HTTP DELETE請(qǐng)求指定@HttpExchange。
• @PatchExchange ：為 HTTP PATCH請(qǐng)求指定@HttpExchange。

方法參數(shù)

返回值

聲明性 HTTP 接口支持以下返回值：

使用示例

@PutExchange
voidupdate(@PathVariableLongid,@RequestBodyUseruser);

完整使用案例

我們以一個(gè)簡(jiǎn)單的用戶信息請(qǐng)求為例

0、構(gòu)建HttpServiceProxyFactory：

HttpServiceProxyFactory是一個(gè)從 HTTP 服務(wù)接口創(chuàng)建客戶端代理的工廠類(lèi)。使用HttpServiceProxyFactory.builder(client).build()方法來(lái)獲取代理 bean 的實(shí)例。

importcom.fasterxml.jackson.databind.ObjectMapper;
importcom.howtodoinjava.app.web.UserClient;
importlombok.SneakyThrows;
importorg.springframework.context.annotation.Bean;
importorg.springframework.context.annotation.Configuration;
importorg.springframework.web.reactive.function.client.WebClient;
importorg.springframework.web.reactive.function.client.support.WebClientAdapter;
importorg.springframework.web.service.invoker.HttpServiceProxyFactory;
@Configuration
publicclassWebConfig{
@Bean
WebClientwebClient(ObjectMapperobjectMapper){
returnWebClient.builder()
.baseUrl("https://jsonplaceholder.typicode.com/")
.build();
}
@SneakyThrows
@Bean
UserClientpostClient(WebClientwebClient){
HttpServiceProxyFactoryhttpServiceProxyFactory=
HttpServiceProxyFactory.builder(WebClientAdapter.forClient(webClient))
.build();
returnhttpServiceProxyFactory.createClient(UserClient.class);
}
}

1、定義一個(gè)簡(jiǎn)單的用戶信息實(shí)體類(lèi)：

publicclassUser{

privateintid;

privateStringusername;

privateStringpassword;

//省略

}

2、請(qǐng)求接口：

importcom.howtodoinjava.app.model.User;
importorg.springframework.http.ResponseEntity;
importorg.springframework.web.bind.annotation.PathVariable;
importorg.springframework.web.bind.annotation.RequestBody;
importorg.springframework.web.service.annotation.DeleteExchange;
importorg.springframework.web.service.annotation.GetExchange;
importorg.springframework.web.service.annotation.HttpExchange;
importorg.springframework.web.service.annotation.PostExchange;
importorg.springframework.web.service.annotation.PutExchange;
importreactor.core.publisher.Flux;
importreactor.core.publisher.Mono;
@HttpExchange(url="/users",accept="application/json",contentType="application/json")
publicinterfaceUserClient{
@GetExchange("/")
FluxgetAll();
@GetExchange("/{id}")
MonogetById(@PathVariable("id")Longid);
@PostExchange("/")
Mono>save(@RequestBodyUseruser);
@PutExchange("/{id}")
Mono>update(@PathVariableLongid,@RequestBodyUseruser);
@DeleteExchange("/{id}")
Mono>delete(@PathVariableLongid);
}

3、將UserClient bean 注入應(yīng)用程序類(lèi)并調(diào)用方法來(lái)獲取 API 響應(yīng)：

@Autowired
UserClientuserClient;
//GetAllUsers
userClient.getAll().subscribe(
data->log.info("User:{}",data)
);
//GetUserById
userClient.getById(1L).subscribe(
data->log.info("User:{}",data)
);
//CreateaNewUser
userClient.save(newUser(null,"Lokesh","lokesh","admin@email.com"))
.subscribe(
data->log.info("User:{}",data)
);
//DeleteUserById
userClient.delete(1L).subscribe(
data->log.info("User:{}",data)
);

完工，不需要定義方法實(shí)現(xiàn)就能進(jìn)行遠(yuǎn)程HTTP調(diào)用，非常方便！