对于前面的Ribbon和Hystrix的介绍,Spring Cloud Feign基于Netflix Feign实现,封装整合了以上两个工具,来简化开发。
因为我们看到对于RestTemplate,往往会使用Ribbon,并且形成了一套模版化的调用方法。在实际开发中,由于对于服务依赖的调用不止一处,往往一个借口会被多次调用,所以Feign在此基础上做了进一步的封装。
Feign快速入门
修改之前的服务消费者。
加入依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-openfeign-core</artifactId>
</dependency>
在application应用主类上加入@EnableFeignClients
@SpringBootApplication
@EnableFeignClients
public class Demo2Application {
public static void main(String[] args) {
SpringApplication.run(Demo2Application.class, args);
}
}
定义HelloService:
@FeignClient("hello-service")
public interface HelloService {
@RequestMapping("/hello")
String hello();
}
注意,hello-service是服务提供者的spring.application.name。
Controller:
@RestController
@RequestMapping("/")
public class ConsumerController {
@Autowired
HelloService helloService;
@RequestMapping("/f")
public String hello() {
return helloService.hello();
}
}
最后同ribbon实现的服务消费者一样,需要在properties中加入服务注册中心。
server.port=9000
spring.application.name=eureka-client
#eureka服务注册中心地址
eureka.client.service-url.defaultZone=http://localhost:1111/eureka/
运行后发现服务仍然可用。
以声明式的方法,优雅而简单的实现了服务调用。
参数绑定
上一节展示的示例是不带参数的REST风格的绑定。在开始介绍Spring Cloud Feign的参数绑定之前,先拓展一下服务方,增加下面的接口定义。
@RestController
@EnableEurekaClient
public class HelloServerController {
@RequestMapping(value = "/hello1",method = RequestMethod.GET)
public String hello(@RequestParam String name){
return "hello "+name;
}
@RequestMapping(value = "/hello2",method = RequestMethod.GET)
public User hello(@RequestHeader String name, @RequestHeader Integer age){
User user=new User(name, age);
return user;
}
@RequestMapping(value = "/hello3",method = RequestMethod.POST)
public String hello(@RequestBody User user){
return "hello "+user.getName()+","+user.getAge();
}
}
User对象定义如下,需要注意的是,必须要有User的默认构造函数,不然Feign会根据Json字符串转换User对象时抛出异常。
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
private String name;
private Integer age;
}
完成了对“eureka-provider”的改造后,在服务消费者做如下改造,首先创建一个相同的User类。
然后,在HelloService接口中增加三个接口的绑定声明。
@RequestMapping(value = "/hello1", method = RequestMethod.GET)
String hello(@RequestParam("name") String name);
@RequestMapping(value = "/hello2", method = RequestMethod.GET)
User hello(@RequestHeader("name") String name, @RequestHeader("age") Integer age);
@RequestMapping(value = "/hello3", method = RequestMethod.POST)
String hello(@RequestBody User user);
注意,这里的@RequestParam
和@RequestHeader
后面的参数value不能少,因为在Spring Mvc中,注解会根据参数名来作为默认值,但是在Feign中绑定参数必须通过value属性来指明具体参数名。
最后在Controller里调用服务:
@RequestMapping("/f2")
public String hello2(){
StringBuilder stringBuilder=new StringBuilder();
stringBuilder.append(helloService.hello("name1")).append("\n");
stringBuilder.append(helloService.hello("name2",2)).append("\n");
stringBuilder.append(helloService.hello(new User("name3",3))).append("\n");
return stringBuilder.toString();
}
继承特性
在上一节的内容编写代码的过程中,我们几乎完全可以从服务方提供的Controller依靠复制操作,构建出相应的服务客户端绑定借口。
既然存在这么多复制操作,Feign提供了继承特性来解决复制操作,减少编码量。
创建新的mvn工程:hello-service-api
创建完成后,写入User类和HelloSerivce:
@Data
@ToString
@NoArgsConstructor
@AllArgsConstructor
public class User{
private String name;
private Integer age;
}
@RequestMapping("/refactor")
public interface HelloService {
@RequestMapping(value = "/hello4", method = RequestMethod.GET)
String hello(@RequestParam("name") String name);
@RequestMapping(value = "/hello5", method = RequestMethod.GET)
User hello(@RequestHeader("name") String name, @RequestHeader("age") Integer age);
@RequestMapping(value = "/hello6", method = RequestMethod.POST)
String hello(@RequestBody User user);
}
将工程打包放到本地库或者私库。
mvn clean package install解释:clean,清楚旧的构建;package打包项目;install:将项目安装到本地仓库这样就ok了。
然后将依赖引入pom.xml后,引入项目module即可。
注意:
这里使用多模块效果更好。
下面是代码重构后的版本。spring cloud脚手架地址https://github.com/BonjourMondo/SpringCloud
服务提供者项目中,新增Controller并implements:
@RestController
public class RefactorHelloServerController implements com.didiname.helloserviceapi.service.HelloService{
@Override
public String hello(String name) {
return "hello,"+name;
}
@Override
public User hello(String name, Integer age) {
return new User(name,age);
}
@Override
public String hello(User user) {
return "hello,"+user.getName()+",age:"+user.getAge();
}
}
在服务消费者项目中,新增Service:
@FeignClient("EUREKA-PROVIDER")
public interface RefactorConsumerService extends com.didiname.helloserviceapi.service.HelloService{
}
在Controller里加入:
@RequestMapping("/f3")
public String hello3(){
StringBuilder stringBuilder=new StringBuilder();
stringBuilder.append(refactorConsumerService.hello("name4")).append("\n");
stringBuilder.append(refactorConsumerService.hello("name5",5)).append("\n");
stringBuilder.append(refactorConsumerService.hello(new com.didiname.helloserviceapi.dto.User("name6",6))).append("\n");
return stringBuilder.toString();
}
运行三个项目,得到结果。
继承特性优缺点:
- 优点:配合Maven私有库可以轻易的实现接口定义的共享,减少服务客户端的绑定配置。
- 缺点:由于接口在构建期间就产生了依赖,所以接口变动会对项目构建产生影响。如果服务方修改了一个接口定义,会导致客户端工程的构建失败。所以,开发团队应该严格遵守开闭原则,进行前后版本的兼容。
Ribbon配置
Feign的客户端负载均衡是通过Ribbon来实现的,所以我们可以直接通过配置Ribbon客户端的方式来自定义各个服务器客户端调用的参数。
全局配置:
比如修改客户端超时时间:
ribbon.ConnectTimeout=500
ribbon.ReadTimeout=500
制定服务配置
大多数情况下,我们对于服务调用的超时时间会根据服务的特性做一些调整,所以仅仅依靠默认的全局配置是不行的。
在使用Feign客户端的时间,我们使用了@FeignClient注解,并指定了name表明服务名。那么,我们就可以通过服务名来设置参数:
eureka-provider.ribbon.ConnectTimeout=500
eureka-provider.ribbon.ReadTimeout=500
重试机制:
在Feign中默认实现了重试机制。以后有机会再详细了解 。
Hystrix配置
全局配置:
Hystrix全局配置同Ribbon差不多,比如设置全局超时时间:
禁用Hystrix:
指定命令配置:
以后再了解。
服务降级配置:
在服务消费方进行如下改造:
@FeignClient(value = "eureka-server",fallback = HelloServiceFallback.class)
@Service
public interface HelloService {
@GetMapping(value = "/hello1")
String hello(@RequestParam("name") String name);
@GetMapping(value = "/hello2")
User hello(@RequestHeader("name") String name, @RequestHeader("age") Integer age);
@PostMapping(value = "/hello3")
String hello(@RequestBody User user);
}
以及:
@Component
public class HelloServiceFallback implements HelloService {
@Override
public String hello(String name) {
return "error"+name;
}
@Override
public User hello(String name, Integer age) {
return new User("未知",0);
}
@Override
public String hello(User user) {
return "未知";
}
}