天天看点
返回

SpringCloud FeignFeign

文章目录

  • Feign
    • 1. 简介
    • 2. 入门案例
    • 3. 负载均衡Ribbon支持
    • 4. Hystrix支持
    • 5. 请求压缩
    • 6. 日志级别

Feign

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

SpringCloud FeignFeign

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

1. 简介

Feign中文意思是伪装，为什么叫伪装？

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

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

2. 入门案例

1.导入依赖

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

2.Feign的客户端

在consumer-demo新建一个celient包，用来放Feign客户端，新建UserClient接口，用来生成调用user-service服务的url。

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

  • @FeignClient

     ，声明这是一个Feign客户端，同时通过 value 属性指定服务名称
  • 接口中的定义方法，完全采用SpringMVC的注解，Feign会根据注解帮我们生成URL，并访问获取结果

3.编写新的控制器类

ConsumerFeignController

，使用UserClient访问：

@RestController
@RequestMapping("/cf")
public class ConsumerFeignController {
    
    @Autowired
    private UserClient userClient;
    
    @GetMapping("/{id}")
    public User queryUserById(@PathVariable("id") Long id){
        return userClient.queryUserById(id);
    }
}

4.开启Feign功能

在 ConsumerApplication 启动类上，添加注解

@EnableFeignClients

，开启Feign功能

@SpringCloudApplication
@EnableFeignClients  //开启feign功能
public class ConsumerApplication {
    public static void main(String[] args) {
        SpringApplication.run(ConsumerApplication.class, args);
    }

    @Bean
    @LoadBalanced
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }
}
Feign中已经自动集成了Ribbon负载均衡，因此不需要自己定义RestTemplate进行负载均衡的配置。

5.启动测试

访问接口：http://localhost:8080/cf/2

SpringCloud FeignFeign

正常获取到了结果。

3. 负载均衡Ribbon支持

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

SpringCloud FeignFeign

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

Fegin内置的Ribbon默认设置了请求超时时长，默认是1000ms，我们可以通过手动配置来修改这个超时时长：

ribbon:
	ReadTimeout: 2000 # 读取超时时长
	ConnectTimeout: 1000 # 建立链接的超时时长

或者为某一个具体service指定:

user-service:
	ribbon:
		ReadTimeout: 2000 # 读取超时时长
		ConnectTimeout: 1000 # 建立链接的超时时长

因为ribbon内部有重试机制，一旦超时，会自动重新发起请求。如果不希望重试，可以添加配置：

修改 consumer-demo的application.yml添加如下配置 ：

ribbon:
	ConnectTimeout: 1000 # 连接超时时长
	ReadTimeout: 2000 # 数据通信超时时长
	MaxAutoRetries: 0 # 当前服务器的重试次数
	MaxAutoRetriesNextServer: 0 # 重试多少次服务
	OkToRetryOnAllOperations: false # 是否对所有的请求方式都重试

4. Hystrix支持

Feign默认也有对Hystrix的集成：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-uNnOhJzY-1615822897527)(https://i.loli.net/2021/03/13/CAuk3wI7FaUXyPQ.png)]

只不过，默认情况下是关闭的。需要通过下面的步骤来开启使用：

修改 consumer-demo的application.yml 添加如下配置：

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

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

1.首先，要定义一个类，实现刚才编写的UserClient接口，作为fallback的处理类

@Component
public class UserClientFallback implements UserClient{
    @Override
    public User queryUserById(Long id) {
        User user = new User();
        user.setId(id);
        user.setName("用户异常");
        return user;
    }
}

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

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

3.重启测试

重启 consumer-demo 并关闭 user-service 服务，然后在页面访问：http://localhost:8080/cf/2

SpringCloud FeignFeign

说明发生了服务降级，调用了UserClientFallback中的方法处理了异常。

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

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

6. 日志级别

前面讲过，通过

logging.level.包名=debug

来设置日志级别。然而这个对Feign客户端而言不会产生效果。因为

@FeignClient

注解修改的客户端在被代理时，都会创建一个新的

Fegin.Logger

实例。我们需要额外指定这个日志的级别才可以。

1.在 consumer-demo的配置文件中设置top.peng包下的日志级别都为debug

logging:
  level: 
    top.peng: debug

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

package top.peng.consumer.config;

import feign.Logger;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class FeignConfig {
    @Bean
    Logger.Level feignLoggerLevel(){		//Logger为feign包下的，注意正确的导包
        return Logger.Level.FULL;
    }
}

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

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

3.在 consumer-demo 的 UserClient 接口类上的@FeignClient注解中指定配置类：

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

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

SpringCloud FeignFeign

⏮ 上一 节： Hystrix ⏭下一节：SpringCloud Gateway网关

SpringCloud学习 java spring
上一篇: ZOJ 2969 Easy Task
下一篇: springboot 调用第三方天气接口

继续阅读