SpringBoot4.0新特性-声明式HTTP远程调用客户端

SpringBoot中远程调用HTTP接口有很多种现成的方案,比如:RestTemplate、RestClient、WebClient等,以及SpringCloud中经常用到的一个非常好用的组件Openfeign。现在在4.0中再也不用羡慕Openfeign了,因为4.0也提供了类似于Openfeign的声明式远程调用客户端Http Service Interface Client。

快速入门

使用起来非常简单那,总共就3步:

  • 定义接口
  • 导入接口
  • 使用接口

比如现在已经有一个商品服务GoodsService:

java 复制代码
@RestController
@RequestMapping("/api/goods/")
public class GoodsController {
    @GetMapping("/{goodsId}")
    Goods getById(@PathVariable("goodsId")Integer goodsId){
        return new Goods(goodsId);
    }
    record Goods(Integer id){}
}

如何对里面的接口进行远程调用呢?

定义接口

java 复制代码
@HttpExchange(url = "http://localhost:8082/api/goods")
public interface GoodsApi {
    @GetExchange(url="/{goodsId}")
    Goods getById(@PathVariable("goodsId")Integer goodsId);
    record Goods(Integer id){}
}
  • HttpExchange: 对应于RequestMapping,说明这个是Rest客户端, url可以设置服务的地址,当然base-url部分也可以用其他方式来指定,稍后会说明
  • GetExchange:对应GetMapping,说明这个是GET请求,聪明的你一定可以想到还会有对应的PostExchange、PutExchange、DeleteExchange等。
  • PathVariable:就是路径参数,传参这一部分跟Controller的传参是一模一样的。

导入接口

java 复制代码
@SpringBootApplication
@ImportHttpServices(basePackages = "com.github.xjs.client", types = GoodsApi.class)
public class ClientApplication {
    public static void main(String[] args) {
        SpringApplication.run(ClientApplication.class, args);
    }
}
  • ImportHttpServices:用来把接口注入到Spring容器,其中:
    • basePackages:是做包扫描,这个包下面所有的接口都会被当成是Rest客户端
    • types: 可以显示指定一个或者多个Rest客户端
    • 二者选其中任何一个就可以

使用接口

跟使用一个普通的bean没有任何区别:

java 复制代码
@RestController
@RequestMapping("/api/client/")
public class ClientController {
    //注入bean
    @Autowired
    private GoodsApi goodsApi;
    @GetMapping("/goods/{goodsId}")
    public GoodsApi.Goods getById(@PathVariable("goodsId")Integer goodsId){
        //直接调用接口
        return goodsApi.getById(goodsId);
    }
}

就是这么简单!简直爽的飞起!

上面的案例中我们硬编码了服务的绝对地址,在实际的开发中一般是在配置文件中进行配置的,那应该如何进行配置呢?请参考:SpringBoot4.0新特性-声明式Rest客户端

相关推荐
少年的范儿10 分钟前
IntelliJ IDEA 配置 JDK 21 与 Maven 教程(Windows):开发环境配置与验证
java·jdk·maven·intellij idea
RuoyiOffice12 分钟前
SpringBoot3 + openGauss:RuoYi Office 登录、流程发布与用印填报适配实战
java·数据库·spring boot·opengauss·信创
Dwzun29 分钟前
基于SpringBoot3+Vue3的油莎豆种植管理系统
java·前端·vue.js·spring boot·后端·python·计算机网络
学长毕设9 小时前
基于SpringBoot的实验室资产管理系统
java·spring boot·后端
zzu123zsw10 小时前
从臃肿的模板调用到声明式契约:深入 UniHttp 动态代理与多渠道生命周期扩展
java·spring boot·microsoft·unihttp
源码集结号11 小时前
云诊所门诊系统源码,基于SpringBoot+Vue.js架构,支持多租户设计与Docker容器化部署
java·spring boot·源码·医院信息系统·门诊系统·诊所系统
论文复现现场11 小时前
WRF、FEA 能用 L40S 加速吗?求解器检查、断点恢复与长期运行
java·数据库·算法·wrf·有限元分析·gpu计算·断点续算
啃瓜子的松鼠12 小时前
泛微OAe9-后端二开异步调用
java
秋天的怀念_David13 小时前
第二十一夜 · 数字黑洞与西西弗斯的惩罚
java·程序人生·算法
外收内放13 小时前
Python基础语法练习题(73)
java·前端·python