一起养成写作习惯!这是我参与「掘金日新计划 · 4 月更文挑战」的第1天,点击查看活动详情。
Feign 和 OpenFeign
OpenFeign 组件的前身是 Netflix Feign 项目,它最早是作为 Netflix OSS 项目的一部分,由 Netflix 公司开发。后来 Feign 项目被贡献给了开源组织,于是才有了我们今天使用的 Spring Cloud OpenFeign 组件。
Feign 和 OpenFeign 有很多大同小异之处,不同的是 OpenFeign 支持 MVC 注解。
可以认为 OpenFeign 为 Feign 的增强版。
简单总结下 OpenFeign 能用来做什么:
- OpenFeign 是声明式的 HTTP 客户端,让远程调用更简单。
- 提供了HTTP请求的模板,编写简单的接口和插入注解,就可以定义好HTTP请求的参数、格式、地址等信息
- 整合了Ribbon(负载均衡组件)和 Hystix(服务熔断组件),不需要显示使用这两个组件
- Spring Cloud Feign 在 Netflix Feign的基础上扩展了对SpringMVC注解的支持。
OpenFeign 如何用?
OpenFeign 的使用也很简单,这里还是用我的开源 SpringCloud 项目 PassJava 作为示例。
开源地址: github.com/Jackson0714…
喜欢的小伙伴来点个 Star 吧,冲 2K Star。
Member 服务远程调用 Study 服务的方法 memberStudyTime(),如下图所示。
第一步:Member 服务需要定义一个 OpenFeign 接口:
@FeignClient("passjava-study")
public interface StudyTimeFeignService {
@RequestMapping("study/studytime/member/list/test/{id}")
public R getMemberStudyTimeListTest(@PathVariable("id") Long id);
}
我们可以看到这个 interface 上添加了注解@FeignClient,而且括号里面指定了服务名:passjava-study。显示声明这个接口用来远程调用 passjava-study服务。
第二步:Member 启动类上添加 @EnableFeignClients注解开启远程调用服务,且需要开启服务发现。如下所示:
@EnableFeignClients(basePackages = "com.jackson0714.passjava.member.feign")
@EnableDiscoveryClient
第三步:Study 服务定义一个方法,其方法路径和 Member 服务中的接口 URL 地址一致即可。
URL 地址:"study/studytime/member/list/test/{id}"
@RestController
@RequestMapping("study/studytime")
public class StudyTimeController {
@RequestMapping("/member/list/test/{id}")
public R memberStudyTimeTest(@PathVariable("id") Long id) {
...
}
}
第四步:Member 服务的 POM 文件中引入 OpenFeign 组件。
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
第五步:引入 studyTimeFeignService,Member 服务远程调用 Study 服务即可。
Autowired
private StudyTimeFeignService studyTimeFeignService;
studyTimeFeignService.getMemberStudyTimeListTest(id);
通过上面的示例,我们知道,加了 @FeignClient 注解的接口后,我们就可以调用它定义的接口,然后就可以调用到远程服务了。
这里你是否有疑问:为什么接口都没有实现,就可以调用了?
OpenFeign 使用起来倒是简单,但是里面的原理可没有那么简单,OpenFeign 帮我们做了很多事情,接下来我们来看下 OpenFeign 的架构原理。