当前位置 > it书童 > java > 正文

Feign 入门介绍

java it书童 2020-09-14 16:05:33 0赞 0踩 59阅读 0评论

简介

在前面的学习中,我们使用了Ribbon的负载均衡功能,大大简化了远程调用时的代码:

String user = this.restTemplate.getForObject("http://service-provider/user/" + id, String.class);

如果就学到这里,你可能以后需要编写类似的大量重复代码,格式基本相同,无非参数不一样。有没有更优雅的方式,来对这些代码再次优化呢?

这就是我们接下来要学的Feign的功能了。

feign 的英文释义是伪装,它可以把Rest的请求进行隐藏,伪装成类似SpringMVC的Controller一样。你不用再自己拼接url,拼接参数等等操作,一切都交给Feign去做。

1525652009416

快速入门

改造 service-customer 工程

导入依赖

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

开启Feign功能

我们在启动类上添加注解,开启Feign功能

@SpringCloudApplication // 组合注解
@EnableFeignClients // 启用 feign 组件
public class ItshutongServiceCustomerApplication {
}

feign已经自动集成了Ribbon负载均衡的RestTemplate。所以,此处不需要再注册RestTemplate。

Feign的客户端

在 service-customer 工程中,添加 UserClient 接口:

@FeignClient("service-provider") // 标注该类是一个feign接口
public interface UserClient {
    @GetMapping("user/{id}")
    User queryUserById(@PathVariable("id") Long id);
}
  • 首先这是一个接口,Feign会通过动态代理,帮我们生成实现类。这点跟mybatis的mapper很像

  • @FeignClient,声明这是一个Feign客户端,类似@Mapper注解。同时通过value属性指定服务名称

  • 接口中的定义方法,完全采用SpringMVC的注解,Feign会根据注解帮我们生成URL,并访问获取结果

改造原来的调用逻辑,调用UserClient接口:

@Controller
@RequestMapping("customer/user")
public class UserController {

    @Autowired
    private UserClient userClient;

    @GetMapping
    @ResponseBody
    @HystrixCommand // 声明熔断的方法
    public String queryUserById(@RequestParam("id")Long id) {
        return this.userClient.queryUserById(id).toString();
    }
}

负载均衡

Feign中本身已经集成了Ribbon依赖和自动配置:

image-20200914155635324

因此我们不需要额外引入依赖,也不需要再注册RestTemplate对象。

Hystrix支持

Feign默认也有对Hystrix的集成:

image-20200914155754372

只不过,默认情况下是关闭的。我们需要通过下面的参数来开启:(在service-customer工程添加配置内容)

feign:
  hystrix:
      enabled: true # 开启熔断

但是,Feign中的Fallback配置不像hystrix中那样简单了。

1)首先,我们要定义一个类UserClientFallback,实现刚才编写的UserClient,作为fallback的处理类

@Component
public class UserClientFallback implements UserClient {
    @Override
    public User queryUserById(Long id) {
        User user = new User();
        user.setUsername("服务器正忙,请稍后再试");
        return user;
    }
}

2)然后在 UserClient 中,指定刚才编写的实现类

@FeignClient(value = "service-provider", fallback = UserClientFallback.class)
public interface UserClient {
    @GetMapping("user/{id}")
    User queryUserById(@PathVariable("id") Long id);
}

3)重启测试:http://localhost:85/customer/user?id=2

请求压缩(了解)

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 # 设置触发压缩的大小下限

注:上面的数据类型、压缩大小下限均为默认值。

日志级别(了解)

前面讲过,通过logging.level.xx=debug来设置日志级别。然而这个对Fegin客户端而言不会产生效果。因为@FeignClient注解修改的客户端在被代理时,都会创建一个新的Fegin.Logger实例。我们需要额外指定这个日志的级别才可以。

1)设置com.leyou包下的日志级别都为debug

logging:
  level:
    cn.itcast: debug

2)编写配置类,定义日志级别

@Configuration
public class FeignLogConfiguration {

    @Bean
    Logger.Level feignLoggerLevel(){
        return Logger.Level.FULL;
    }
}

这里指定的Level级别是FULL,Feign支持4种级别:

1528863525224

  • NONE:不记录任何日志信息,这是默认值。

  • BASIC:仅记录请求的方法,URL以及响应状态码和执行时间

  • HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息

  • FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据。

3)在FeignClient中指定配置类:

@FeignClient(value = "service-privider", fallback = UserFeignClientFallback.class, configuration = FeignConfig.class)
public interface UserFeignClient {
    @GetMapping("/user/{id}")
    User queryUserById(@PathVariable("id") Long id);
}

4)重启项目,即可看到每次访问的日志:

1528863489923

转载须注明出处:https://www.itshutong.com/articles/708/introduction-to-feign
关于我
一个文科出身的程序员,追求做个有趣的人,传播有价值的知识,微信公众号主要分享读书思考心得,不会有代码类文章,非程序员的同学请放心订阅
发表评论
我有句话,不知当讲不当讲?
要讲之前请先 登录