Feign

2 Feign

2.1.简介

有道词典的英文解释：

为什么叫伪装？

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

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

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

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

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

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

2.2.快速入门

2.2.1.导入依赖

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

2.2.2.Feign的客户端

注意 ：

@PathVariable("变量名") 的用法，这个是将形参的值赋值给路径的中的变量

@PathVariable 变量 这个是将路径的值赋值给变量

package cn.clocktt.client;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

@FeignClient("user-service")
public interface UserFeignClient {

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

定义一个Feign中的一个方法需要做4件事

  1. 请求的方式 @GetMapping
  2. 请求的路径 /user/
  3. 请求的参数 @PathVariable("id") Long userId 将 userId 赋值给路径中的id
  4. 返回值 String

2.2.3 Controller层

注入 Feign 客户端，直接调用即可

package cn.clocktt.controller;

import cn.clocktt.client.UserFeignClient;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class WebController {

    @Autowired
    private UserFeignClient userFeignClient;

    @ResponseBody
    @RequestMapping("/consumer/user")
    public String queryUserById(long id) {
        return userFeignClient.queryUserById(id);
    }
}

2.2.4 开启Feign功能

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

package cn.clocktt;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.SpringCloudApplication;
import org.springframework.cloud.client.circuitbreaker.EnableCircuitBreaker;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;

@SpringCloudApplication
@EnableFeignClients
public class UserConsumerApplication {

    public static void main(String[] args) {
        SpringApplication.run(UserConsumerApplication.class,args);
    }
}
  • 你会发现RestTemplate的注册被我删除了。Feign中已经自动集成了Ribbon负载均衡，因此我们不需要自己定义RestTemplate了

2.2.5 启动测试

访问接口：http://localhost:8082/consumer/user?id=1

1547594598017

正常获取到结果。

2.3 负载均衡

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

1547594729442

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

另外，我们可以像上节课中讲的那样去配置Ribbon，可以通过ribbon.xx来进行全局配置。也可以通过服务名.ribbon.xx来对指定服务配置：

ribbon:
  ConnectTimeout: 250 # 连接超时时间(ms)
  ReadTimeout: 1000 # 通信超时时间(ms)

2.4 Hystrix支持

Feign默认也有对Hystrix的集成

1547595194967

只不过，默认情况下是关闭的。我们需要通过下面的参数来开启：

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

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

1）首先，我们要定义一个类，实现刚才编写的UserFeignClient，作为fallback的处理类

package cn.clocktt.clientImpl;

import cn.clocktt.client.UserFeignClient;
import org.springframework.stereotype.Component;

@Component
public class UserFeignClientImpl implements UserFeignClient {

    @Override
    public String queryUserById(Long userId) {
        return "不好意思，服务繁忙，请稍后再试";
    }
}

2）然后在UserFeignClient中，指定刚才编写的实现类

package cn.clocktt.client;

import cn.clocktt.clientImpl.UserFeignClientImpl;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

@FeignClient(value = "user-service",fallback = UserFeignClientImpl.class)
public interface UserFeignClient {

    //String url = "http://user-service/user/"+id;
    //这个请求url 由 Feign 动态代理来生成
    @GetMapping("/user/{id}")
    String queryUserById(@PathVariable("id") Long userId);
}

3）重启测试：

我们关闭user-service服务，这样consumer就获取不到 user-service服务了，然后Hystrix会进行服务降级，调用FallBack方法。

页面访问结果：

1547595677101

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

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

2.6.日志级别(了解)

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

1）设置 cn.clocktt 包下的日志级别都为debug

logging:
  level:
    cn.clocktt: debug

2）编写配置类，定义日志级别

@Configuration
public class FeignConfig {
    @Bean
    Logger.Level feignLoggerLevel(){
        return Logger.Level.FULL;
    }
}

这里指定的Level级别是FULL，Feign支持4种级别：

  • NONE：不记录任何日志信息，这是默认值。
  • BASIC：仅记录请求的方法，URL以及响应状态码和执行时间
  • HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息
  • FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据。

3）在FeignClient中指定配置类：

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

4）重启项目，即可看到每次访问的日志：

posted @ 2019-01-16 07:48  竹子の云  阅读(245)  评论(0)    收藏  举报