Spring Cloud OpenFeign是一种基于Spring Cloud的声明式REST客户端,它简化了与HTTP服务交互的过程。它将REST客户端的定义转化为Java接口,并且可以通过注解的方式来声明请求参数、请求方式、请求头等信息,从而使得客户端的使用更加方便和简洁。同时,它还提供了负载均衡和服务发现等功能,可以与Eureka、Consul等注册中心集成使用。Spring Cloud OpenFeign能够提高应用程序的可靠性、可扩展性和可维护性,是构建微服务架构的重要工具之一。也就是说OpenFeign主要的作用是实现在微服务中不同服务之间的通讯的。
OpenFeign是一个声明式Rest客户端,也就是说本身OpenFeign的使用则是非常方便简单的。通过采用注解+配置文件的方式即可进行使用。
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
@SpringBootApplication
@EnableFeignClients // 启用 Feign
public class OrderServiceApplication {
public static void main(String[] args) {
SpringApplication.run(OrderServiceApplication.class, args);
}
}
@FeignClient(name = "product-service") // 目标服务名(注册到Eureka的名称)
public interface ProductClient {
@GetMapping("/products/{id}") // 对应远程API路径
Product getProduct(@PathVariable Long id);
@PostMapping("/products")
Product createProduct(@RequestBody Product product);
}
上述三大代码块一个是依赖关系,启动配置,以及feign客户端的使用
需要注意的是:FeignClient注解当中一些属性需要知道
其中product-service则是服务名称,也就是注册到注册中心的服务名称要与其保持一致。
同时还含有其他属性:
value注解:作用则是重新定义bean的名称
@FeignClient(value = "storeService")
public interface StoreClient { ... }
上述代码则是修改了bean的名称StoreClient 修改为storeService表示调用目标的storeService对象
url注解:可以不借助注册中心直接通过url直连的方式进行通信
@FeignClient(name = "user-service", url = "http://localhost:8080")
public interface UserClient {
@GetMapping("/users/{id}")
User getUser(@PathVariable("id") Long id);
}
可以看出直接采用了url直连的方式进行连接对其进行通讯
其中在 name
和 url
属性中支持占位符。
@FeignClient(name = "${feign.name}", url = "${feign.url}")
public interface StoreClient {
//..
}
如果不是用url则需要在配置文件中添加注册中心的url
OpenFeign的覆盖设置遵循着后者覆盖前者的原则,对于配置文件相较于注解则是先一步加载到spring容器中的因此一般来说注解的配置会覆盖配置文件的配置
primary注解:对于如果存在多个相同的bean的时候优先选择此bean
qualifier注解:指定需要注入的bean名称
Feign继承的支持:
Feign 通过单继承接口支持模板式的api。这允许将常见的操作分组到方便的基础接口中。
public interface UserService {
@RequestMapping(method = RequestMethod.GET, value ="/users/{id}")
User getUser(@PathVariable("id") long id);
}
@RestController
public class UserResource implements UserService {
}
@FeignClient("users")
public interface UserClient extends UserService {
}
上述代码可以看出可以子类带有feignclient接口同时可以直接调用父类的接口方法