Spring Cloud微服务学习系列11 Feign

最新推荐文章于 2023-09-08 08:55:17 发布

一只胡说八道的猴子

最新推荐文章于 2023-09-08 08:55:17 发布

阅读量183

点赞数

分类专栏： SpringCloud

本文链接：https://blog.csdn.net/pjh88/article/details/119577860

版权

SpringCloud 专栏收录该内容

17 篇文章 0 订阅

订阅专栏

Feign

简介

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

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

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

Feign也叫伪装：

Feign可以把Rest的请求进行隐藏，伪装成类似SpringMVC的Controller一样。你不用再自己拼接url，拼接参数等等操作，一切都交给Feign去做。
项目主页：https://github.com/OpenFeign/feign

快速入门

步骤介绍

1.导入依赖
2.Feign的客户端
3.开启Feigb功能
4.启动测试

1.导入依赖

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

2.Feign的客户端

代码

package com.pjh.user.Client;

import com.pjh.user.pojo.user;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
/*原来所需的拼接语句
* String url = "http://user-service/user/" + id;
User user = this.restTemplate.getForObject(url, User.class)
* */
@FeignClient("producer-service" ) //注册中心中所注册的所需服务的名称
public interface UserClient {
    @GetMapping("/user/{id}")
    user  queryById(@PathVariable("id")Long id);
}

注意事项

1.首先这是一个接口，Feign会通过动态代理，帮我们生成实现类。这点跟mybatis的mapper很像
2.@FeignClient ，声明这是一个Feign客户端，同时通过 value 属性指定服务名称
3.接口中的定义方法，完全采用SpringMVC的注解，Feign会根据注解帮我们生成URL，并访问获取结果4.@GetMapping中的**/user**，请不要忘记；因为Feign需要拼接可访问的地址

3.编写Controller类

package com.pjh.user.Controller;

import com.pjh.user.Client.UserClient;
import com.pjh.user.pojo.user;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
@RequestMapping("/test")
public class FeignController {
    @Autowired(required = false)
    private UserClient userClient;
    @GetMapping("/{id}")
    public user queryById(@PathVariable("id")Long id){
        return  userClient.queryById(id);
    }
}

4.开启Feigb功能

在Application启动类上添加@Feign注解，开启Feign功能

package com.pjh;

import com.netflix.discovery.DiscoveryClient;
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.loadbalancer.LoadBalanced;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;
/*@EnableEurekaClient
@SpringBootApplication
@EnableCircuitBreaker*/
@SpringCloudApplication
@EnableFeignClients
public class ConsumerApplication {
    public static void main(String[] args) {
        SpringApplication.run(ConsumerApplication.class,args);
    }
    @Bean
    @LoadBalanced
    public RestTemplate getRestTemplate(){
        return new RestTemplate();
    }
}

**注：**Feign中已经自动集成了Ribbon负载均衡，因此不需要自己定义RestTemplate进行负载均衡的配置。

5…启动测试

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

负载均衡

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

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

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

producer-service:
  ribbo:
    NFLoadBalancerRuleClassName: com.netflix.loadbalancer.RandomRule #随机选取
    ReadTimeout: 2000 # 读取超时时长
    ConnectTimeout: 1000 # 建立链接的超时时长

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

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

Hystrix支持

Feign默认也有对Hystrix的集成：

只不过，默认情况下是关闭的。需要通过下面的参数来开启；
修改 application.yml 添加如下配置：
**

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

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

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

package com.pjh.user.Client;

import com.pjh.user.pojo.user;
import org.apache.catalina.User;
import org.springframework.stereotype.Component;

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

2.在UserClient中指定刚才编写的类
**

package com.pjh.user.Client;

import com.pjh.user.pojo.user;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
/*原来所需的拼接语句
* String url = "http://user-service/user/" + id;
User user = this.restTemplate.getForObject(url, User.class)
* */
@FeignClient(value = "producer-service",fallback = UserClienFallBack.class ) //注册中心中所注册的所需服务的名称
public interface UserClient {
    @GetMapping("/user/{id}")
    user  queryById(@PathVariable("id")Long id);
}

3.重启测试

请求压缩

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）在 consumer-demo 的配置文件中设置com.pjh包下的日志级别都为 debug修改 consumer-demo\src\main\resources\application.yml 添加如下配置：

logging:
  level: 
    com.pjh: debug

2）在 consumer-demo 编写FeignConfig配置类，定义日志级别

package com.pjh.user.Config;
import feign.Logger;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class FeignConfig {
    @Bean
    Logger.Level feignLoggerLevel(){
        return  Logger.Level.FULL;
    }
}

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

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

package com.pjh.user.Client;

import com.pjh.user.Config.FeignConfig;
import com.pjh.user.pojo.user;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
/*原来所需的拼接语句
* String url = "http://user-service/user/" + id;
User user = this.restTemplate.getForObject(url, User.class)
* */
@FeignClient(value = "producer-service",fallback = UserClienFallBack.class ,configuration = FeignConfig.class) //注册中心中所注册的所需服务的名称
public interface UserClient {
    @GetMapping("/user/{id}")
    user  queryById(@PathVariable("id")Long id);
}

4）重启项目，访问：http://localhost:8080/cf/8 ；即可看到每次访问的日志：