一、简介
Feign可以把Rest的请求进行隐藏,伪装成类似SpringMVC的Controller一样。你不用再自己拼接url,拼接参数等等操作,一切都交给Feign去做。
二、 入门
2.1 引入依赖
在消费者pom文件中引入依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
2.2 启动Feign
我们在启动类上,添加注解@EnableFeignClients,开启Feign功能
删除RestTemplate**:feign已经自动集成了Ribbon负载均衡的RestTemplate。所以,此处不需要再注册RestTemplate。
@SpringCloudApplication
@EnableFeignClients // 开启feign客户端
public class DemoServiceConsumerApplication {
public static void main(String[] args) {
SpringApplication.run(DemoServiceConsumerApplication.class);
}
}
2.3 Feign的客户端
在消费者中,添加接口
@FeignClient(value = "service-provider") // 标注该类是一个feign接口
public interface UserClient {
@GetMapping("user/{id}")
User queryById(@PathVariable("id") Long id);
}
首先这是一个接口,Feign会通过动态代理,帮我们生成实现类。这点跟mybatis的mapper很像
@FeignClient
,声明这是一个Feign客户端,类似@Mapper
注解。同时通过value
属性指定服务名称接口中的定义方法,完全采用SpringMVC的注解,Feign会根据注解帮我们生成URL,并访问获取结果
改造原来的调用逻辑,调用UserClient接口:
@RestController
@RequestMapping("consumer/user")
public class UserController {
@Autowired
private UserClient userClient;
@GetMapping
public User queryUserById(@RequestParam("id") Long id){
User user = this.userClient.queryUserById(id);
return user;
}
}
2.4 负载均衡
Feign中本身已经集成了Ribbon依赖和自动配置,因此我们不需要额外引入依赖,也不需要再注册RestTemplate
对象。
2.5 Hystrix支持
Feign默认也有对Hystrix的集成,只不过,默认情况下是关闭的。我们需要通过下面的参数来开启:(在demo-service-consumer工程添加配置内容)
feign:
hystrix:
enabled: true # 开启Feign的熔断功能
但是,Feign中的Fallback配置不像hystrix中那样简单了。
2.5.1 首先,我们要定义一个fallback的处理类
我们要定义一个类UserClientFallback, 实现刚才编写的UserClient,作为fallback的处理类
@Component
public class UserClientFallback implements FallbackFactory<UserClient> {
@Override
public UserClient create(Throwable throwable) {
return new UserClient() {
@Override
public User queryById(Long id) {
User user=new User();
user.setUserName("出错啦");
return user;
}
};
}
}
2.5.2 在UserFeignClient中,指定刚刚编写的实现类
注意:这时候原生hystrixs的支持熔断方法的注解如:
@EnableCircuitBreaker,@DefaultProperties(defaultFallback = "queryByIdFallBack"),@HystrixCommand就可以删除了
在@FeignClient注解中加入fallbackFactory = UserClientFallback.class
@FeignClient(value = "service-provider",fallbackFactory = UserClientFallback.class)
@RequestMapping("user")
public interface UserClient {
@GetMapping("{id}")
public User queryById(@PathVariable(name = "id") Long id);
}
2.6 请求压缩
Spring Cloud Feign 支持对请求和响应进行GZIP压缩,以减少通信过程中的性能损耗。通过下面的参数即可开启请求与响应的压缩功能:
feign:
compression:
request:
enabled: true # 开启请求压缩
response:
enabled: true # 开启响应压缩
同时,我们也可以对请求的数据类型,以及触发压缩的大小下限进行设置:
feign:
compression:
request:
enabled: true # 开启请求压缩
mime-types: text/html,application/xml,application/json # 设置压缩的数据类型
min-request-size: 2048 # 设置触发压缩的大小下限
注:上面的数据类型、压缩大小下限均为默认值。
2.7 日志级别
通过logging.level.xx=debug
来设置日志级别。然而这个对Fegin客户端而言不会产生效果。因为@FeignClient
注解修改的客户端在被代理时,都会创建一个新的Fegin.Logger实例。我们需要额外指定这个日志的级别才可以。
1)设置com.demo包下的日志级别都为debug
logging:
level:
com.demo: debug
2)编写配置类,定义日志级别
@Configuration
public class FeignLogConfiguration {
@Bean
Logger.Level feignLoggerLevel(){
return Logger.Level.FULL;
}
}
这里指定的Level级别是FULL,Feign支持4种级别 :
-
NONE:不记录任何日志信息,这是默认值。
-
BASIC:仅记录请求的方法,URL以及响应状态码和执行时间
-
HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息
-
FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据。
3)在FeignClient中指定配置类:
@FeignClient(value = "service-privider", fallbackFactory = UserFeignClientFallback.class, configuration = FeignConfig.class)
public interface UserFeignClient {
@GetMapping("/user/{id}")
User queryUserById(@PathVariable("id") Long id);
}