1. Feign

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

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

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

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

1.1 简介

有道词典的英文解释:

spring cloud feign 配置 springcloud feign调用_User


为什么叫伪装?

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

项目主页:https://github.com/OpenFeign/feign

spring cloud feign 配置 springcloud feign调用_User_02

1.2 快速入门

改造zwwnb-user工程

1.2.1 导入依赖

spring cloud feign 配置 springcloud feign调用_User_03

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

1.2.2 开启Feign功能

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

spring cloud feign 配置 springcloud feign调用_Spring Cloud_04


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

spring cloud feign 配置 springcloud feign调用_ide_05

@SpringCloudApplication
@EnableFeignClients // 开启feign客户端
public class UserApplication {

    public static void main(String[] args) {
        SpringApplication.run(UserApplication.class);
    }
}

1.2.3 Feign的客户端

在zwwnb-user工程中,添加UserClient接口:

spring cloud feign 配置 springcloud feign调用_负载均衡_06

@FeignClient(value = "provider-service") // 标注该类是一个feign接口
public interface UserClient {

    @GetMapping("user/{id}")
    User queryById(@PathVariable("id") Long id);
}
  • 首先这是一个接口,Feign会通过动态代理,帮我们生成实现类。这点跟mybatis的mapper很像
  • @FeignClient,声明这是一个Feign客户端,类似@Mapper注解。同时通过value属性指定服务名称
  • 接口中的定义方法,完全采用SpringMVC的注解,Feign会根据注解帮我们生成URL,并访问获取结果

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

spring cloud feign 配置 springcloud feign调用_User_07


原来熔断的代码先删除,也可以注释起来现在暂时用不到。

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

    @Autowired
    private UserClient userClient;

    @GetMapping
    @ResponseBody
    @HystrixCommand // 标记该方法需要熔断
    public User queryUserById(@RequestParam("id") Long id){
        User user = this.userClient.queryUserById(id);
        return user;
    }
}

1.2.4 启动测试

访问接口:

spring cloud feign 配置 springcloud feign调用_User_08


正常获取到了结果。

1.3 负载均衡

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

spring cloud feign 配置 springcloud feign调用_负载均衡_09


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

1.4 Hystrix支持

Feign默认也有对Hystrix的集成:

spring cloud feign 配置 springcloud feign调用_负载均衡_10


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

spring cloud feign 配置 springcloud feign调用_User_11

feign:
  hystrix:
    enabled: true # 开启Feign的熔断功能

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

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

spring cloud feign 配置 springcloud feign调用_负载均衡_12

@Component
public class UserClientFallback implements UserClient {

    @Override
    public User queryUserById(Long id) {
        User user = new User();
        user.setUsername("服务器繁忙,请稍后再试!");
        return user;
    }
}

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

spring cloud feign 配置 springcloud feign调用_Spring Cloud_13

@FeignClient(value = "provider-service",fallback = UserClientFallback.class) // 标注该类是一个feign接口
public interface UserClient {

    @GetMapping("user/{id}")
    User queryUserById(@PathVariable("id") Long id);
}

重启服务进行测试:

正常访问:

spring cloud feign 配置 springcloud feign调用_ide_14


关闭服务提供方:

spring cloud feign 配置 springcloud feign调用_User_15


spring cloud feign 配置 springcloud feign调用_负载均衡_16

1.5 请求压缩(了解)

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

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