前言
上一篇文章 点击此处 在之前的工程中我们使用了Ribbon的负载均衡功能,大大简化了远程调用时的代码:
代码语言:javascript复制String user = this.restTemplate.getForObject("http://service-provider/user/" id, String.class);
如果就学到这里,你可能以后需要编写类似的大量重复代码,格式基本相同,无非参数不一样。有没有更简洁的方式,来对这些代码再次优化呢?
简介
Feign可以把Rest的请求进行隐藏,伪装成类似SpringMVC的Controller一样。你不用再自己拼接url,拼接参数等等操作,一切都交给Feign去做。、
快速入门
调用是在消费者 所以在消费者出使用feign
导入依赖
代码语言:javascript复制 <!--引入feign依赖 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
开启Feign
代码语言:javascript复制* feign使用步骤:
* 1.导入依赖
* 2.启动类上加入注解@EnableFeignClients
* 3.编写接口 告知 请求方式 请求路径 请求参数 返回结果
* 使用feign不需要RestTemplate方法了
在启动类上加入注解
代码语言:javascript复制@EnableFeignClients
@SpringCloudApplication//springCloud注解 包含了以上三个注解配置这个不需要配置以上三个注解
public class UserConsumerDemoApplication {
//使用feign 就不需要这个方法了
// @Bean
// @LoadBalanced//负载均衡的另一种使用方法 内置一个拦截器 拦截所有restTemplate请求
// public RestTemplate restTemplate() {
// return new RestTemplate();
// }
public static void main(String[] args) {
SpringApplication.run(UserConsumerDemoApplication.class, args);
}
}
删除RestTemplate:feign已经自动集成了Ribbon负载均衡的RestTemplate。所以,此处不需要再注册RestTemplate。
Feign的客户端
工程中,添加UserClient接口:
代码语言:javascript复制@FeignClient(value = "user-service")
public interface UserClient {
//底层调用动态代理 会自动为我们实现方法
@GetMapping("/user/{id}")
User queryById(@PathVariable("id") Long id);
}
这是一个接口,Feign会通过动态代理,帮我们生成实现类。 @FeignClient,声明这是一个Feign客户端,类似@Mapper注解。同时通过value属性指定服务名称。 接口中的定义方法,完全采用SpringMVC的注解,Feign会根据注解帮我们生成URL,并访问获取结果。
改造Controller
代码语言:javascript复制@RestController
@RequestMapping("/consumer")
//@DefaultProperties(defaultFallback = "defaultFallBack")//默认属性 写在类上 类中所有方法通用属性
public class ConsumerController {
//注入接口
@Autowired
private UserClient userClient;
@GetMapping("{id}")
public User queryById(@PathVariable("id") Long id){
return userClient.queryById(id);//调用feign中的方法 进行远程调用
}
}
启动 测试
feign负载均衡
Feign中本身已经集成了Ribbon依赖和自动配置 因此我们不需要额外引入依赖,也不需要再注册RestTemplate对象 yaml配置
代码语言:javascript复制ribbon:
ConnectionTimeOut: 500 #默认获取链接超时时长是1秒
ReadTimeOut: 2000 #读取超时时长 默认是一秒
Hystrix支持
Feign默认也有对Hystrix的集成: 只不过,默认情况下是关闭的。我们需要通过配置参数来开启 yaml
代码语言:javascript复制#Feign的配置
feign:
hystrix:
enabled: true #配置feign开启熔断
Feign中的Fallback配置 首先,我们要定义一个类UserClientFallback,实现刚才编写的UserClient,作为fallback的处理类、
代码语言:javascript复制/**
* 写熔断的业务逻辑
* 这是一个新建的类
*/
@Component//写注解注入到spring中
public class UserClientFallback implements UserClient {
@Override
public User queryById(Long id) {
User user = new User();
user.setName("未知用户!");
return user;
}
}
在UserFeignClient中,指定刚才编写的实现类
代码语言:javascript复制@FeignClient(value = "user-service",fallback = UserClientFallback.class)
public interface UserClient {
//底层调用动态代理 会自动为我们实现方法
@GetMapping("/user/{id}")
User queryById(@PathVariable("id") Long id);
}
重启测试即可
请求压缩
Spring Cloud Feign 支持对请求和响应进行GZIP压缩,以减少通信过程中的性能损耗。 通过yaml配置开启
代码语言:javascript复制feign:
compression:
request:
enabled: true # 开启请求压缩
response:
enabled: true # 开启响应压缩
同时,我们也可以对请求的数据类型,以及触发压缩的大小下限进行设置:
代码语言:javascript复制feign:
compression:
request:
enabled: true # 开启请求压缩
mime-types: text/html,application/xml,application/json # 设置压缩的数据类型
min-request-size: 2048 # 设置触发压缩的大小下限