SpringCloud-01-微服务的起源
SpringCloud-02-SpringCloud入门
SpringCloud-03-Eureka服务管理
SpringCloud-04-Ribbon负载均衡
SpringCloud-05-Hystrix熔断器
SpringCloud-06-Feign声明式WebService客户端
SpringCloud-07-Gateway网关路由
文章目录
7. Feign
在前面的学习中,我们使用了Ribbon的负载均衡功能,大大简化了远程调用时的代码:
String url = "http://user-service/user/";
User user = this.restTemplate.getForObject(url + id, User.class)
但是这种方式需要编写类似的大量重复代码,格式基本相同,无非参数不一样。有没有更优雅的方式,来对这些代码再次优化呢?
7.1 Feign概念
Feign可以把Rest的请求进行隐藏,伪装成类似SpringMVC的Controller一样。你不用再自己拼接url,拼接参数等等操作,一切都交给Feign去做。
Feign和Ribbon是SpringCloud的Netflix中提供的两个实现软负载均衡的组件,Ribbon和Feign都是用于调用其他服务的,方式不同。Feign则是在Ribbon的基础上进行了一次改进,采用接口的方式。
7.2 Feign入门案例
以之前的Hystrix为基础,要是记不清可以看以下本专栏里的其他文章。
7.2.1 添加依赖
<!--Feign依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
7.2.2 Feign的客户端
@FeignClient("user-service")//声明这是一个Feign客户端,同时通过 value 属性指定服务名称
@RequestMapping("user")//全局映射
public interface UserClient {
@RequestMapping(value = "{id}",method = RequestMethod.GET)
public abstract User queryById(@PathVariable("id") Long id);
}
注意:Feign的客户端接口UserClient中抽象方法的注解、方法签名要和提供服务的方法完全一致。
-
首先这是一个接口,Feign会通过动态代理,帮我们生成实现类;
这点跟Mybatis的mapper很像。
-
@FeignClient ,声明这是一个Feign客户端,同时通过 value 属性指定服务名称;
-
接口中的定义方法,完全采用SpringMVC的注解,Feign会根据注解帮我们生成URL,并访问获取结果;
-
@RequestMapping中的/user,请不要忘记,也可以设置成全局的,因为Feign需要拼接可访问的地址。
7.2.3 修改controller层
使用UserClient访问:
@RestController
@RequestMapping("feign/call")
public class CallFeignController {
@Autowired
private UserClient userClient;
@RequestMapping(value = "{id}", method = RequestMethod.GET)
public String queryById(@PathVariable("id") Long id) {
return JSON.toJSONString(userClient.queryById(id));
}
}
7.2.4 开启Feign功能
在启动类上添加注解 @EnableFeignClients。
@SpringCloudApplication
@EnableFeignClients//开启Feign功能
public class UserCallApplication {
public static void main(String[] args) {
SpringApplication.run(UserCallApplication.class, args);
}
}
注意:Feign中已经自动集成了Ribbon负载均衡,因此不需要自己定义RestTemplate进行负载均衡的配置。
7.2.5 测试
7.3 Feign集成Ribbon
Feign中本身已经集成了Ribbon依赖和自动配置:
因此,不需要额外引入Ribbon依赖,也不需要再注册RestTemplate对象。Fegin内置的Ribbon默认设置了请求超时时长,默认是1秒,我们可以通过手动配置来修改这个超时时长:
ribbon:
ReadTimeout: 1000 # 读取超时时长,默认1s
ConnectTimeout: 1000 # 建立链接的超时时长,默认1s
或者为某一个服务指定:
user-service:
ribbon:
ReadTimeout: 1000 # 读取超时时长
ConnectTimeout: 1000 # 建立链接的超时时长
因为Ribbon内部有重试机制,一旦超时,会自动重新发起请求(Ribbon默认会对当前服务实例重试一次,然后对下一个服务实例重试一次。当然,这是有前提的)。如果不希望重试,可以添加配置:
ribbon:
ConnectTimeout: 1000 # 连接超时时长
ReadTimeout: 1000 # 数据通信超时时长
MaxAutoRetries: 0 # 当前服务器的重试次数
MaxAutoRetriesNextServer: 0 # 重试多少次服务
OkToRetryOnAllOperations: false # 是否对所有的请求方式都重试
7.4 Feign集成Hystrix
Feign默认也有对Hystrix的集成:
Feign中的Fallback配置不像Hystrix中那样简单了 :
-
首先,要定义一个类,实现刚才编写的UserFeignClient,作为fallback的处理类;
@Component public class UserClientFallback implements UserClient { @Override public User queryById(Long id) { User user = new User(); user.setName("用户异常"); return user; } }
也可以实现FallbackFactory,fallbackFactory相当于fallback的增强版,可以捕获异常。
-
在Feign客户端UserClient中声明fallback;
@FeignClient(value = "user-service", fallback = UserClientFallback.class) public interface UserClient {...}
-
在全局配置文件中开启熔断;
feign: hystrix: enabled: true # 开启Feign的熔断功能,默认情况下是关闭的。
-
测试
可能遇到的问题:
解决方法:
修改Feign的客户端接口UserClient,不使用全局映射。
@FeignClient(value = "user-service", fallback = UserClientFallback.class)//声明这是一个Feign客户端,同时通过 value 属性指定服务名称
//@RequestMapping("user")//全局映射,,此处注释掉feign和hystrix都在扫描注解导致多测注册
public interface UserClient {
@RequestMapping(value = "user/{id}",method = RequestMethod.GET)
public abstract User queryById(@PathVariable("id") Long id);
}
7.5 请求压缩[了解]
Spring Cloud Feign 支持对请求和响应进行GZIP压缩,以减少通信过程中的性能损耗。通过下面的参数即可开启请求与响应的压缩功能:
feign:
compression:
request:
enabled: true # 开启请求压缩
mime-types: text/html,application/xml,application/json # 设置压缩的数据类型
min-request-size: 2048 # 设置触发压缩的大小下限,单位是字节
response:
enabled: true # 开启响应压缩
上面的数据类型、压缩大小下限均为默认值。
7.6 日志级别[了解]
在SpringBoot中,我们可以通过配置 logging.level=debug 来设置日志级别。然而这个对Fegin客户端而言不会产生效果。因为@FeignClient 注解修改的客户端在被代理时,都会创建一个新的Fegin.Logger实例。我们需要额外指定这个日志的级别才可以。
-
配置日志级别(只在配置文件里配置日志级别是不行的);
logging: level: com.lijinghua: debug
-
编写配置类,定义日志级别;
@Configuration public class FeignConfig { @Bean Logger.Level feignLoggerLevel(){ //记录所有请求和响应的明细,包括头信息、请求体、元数据 return Logger.Level.FULL; } }
这里指定的Level级别是FULL,Feign支持4种级别:
- NONE:不记录任何日志信息,这是默认值;
- BASIC:仅记录请求的方法,URL以及响应状态码和执行时间;
- HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息;
- FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据。
-
在服务消费者(这里是user_call)中的 UserClient 接口类上的@FeignClient注解中指定配置类;
@FeignClient(value = "user-service", fallback = UserClientFallback.class, configuration = FeignConfig.class)
-
重启项目,即可看到每次访问的日志。