OpenFeign使用

谁借莪１个温暖的怀抱￠ 2023-10-01 19:06 120阅读 0赞

### 一、OpenFeign ###

#### 1.1 基本使用 ####

OpenFeign是Spring Cloud在Feign的基础上支持了Spring MVC的注解,列如@RequestMapping等，OpenFeign的@FeignClient可以解析SpringMVC的@RequestMapping注解下的接口，并通过动态代理的方式产生实现类，实现类中做负载均衡并调用其他服务。

在`shop-common`模块的`pom`文件中添加`OpenFeign`依赖包

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

创建`OpenFeign`接口，在接口上添加`@FeignClient`注解，通过`value`属性指定提供服务的服务名称，这个名称是注册到`Nacos`中的服务名称，`path`属性设置接口访问的根路径，在接口方法可以通过`@RequestMapping`注解来指定访问路径，根路径与指定的访问路径拼装后才是真正的访问路径

如果需要传参数，可以像`Controller`里面的接收参数一样，通过`@RequestParm、@PathVariable`等来传递参数

@Component
    @FeignClient(value = "shop-order",path = "order")
    public interface UserToOrderFeignClient {
        
    
        /**
         * 订单详情
         *
         * @date 2022/2/8
         * @param uid
         * @return java.util.List<com.lizhi.entity.Order>
         */
        @GetMapping("details")
        List<Order> details(@RequestParam("uid") Integer uid);
    
    }

在`shop-order`服务中，编写`Controller`类，同时在启动类上添加`@EnableFeignClients`注解，表示允许通过`OpenFeign`的方式来访问接口

@RestController
    @RequestMapping
    public class OrderController {
        
    
        @Resource
        OrderService orderService;
    
        @GetMapping("details")
        List<Order> details(@RequestParam("uid") Integer uid){
        
            return orderService.details(uid);
        }
    
    }
    
    @SpringBootApplication
    @EnableDiscoveryClient
    @EnableFeignClients
    public class OrderApplication {
        
    
        public static void main(String[] args) {
        
            SpringApplication.run(OrderApplication.class,args);
        }
    
    }

配置`shop-order`服务访问的根路径

spring:
      mvc:
        servlet:
          path: /order

在`shop-user`模块注入`UserToOrderFeignClient`的代理对象，然后就可以直接通过调用UserToOrderFeignClient的`details()`方法来调用`shop-order`提供的接口

@Resource
    UserToOrderFeignClient userToOrderFeignClient;
    
    @GetMapping("test")
    List<Order> test(){
        
        return userToOrderFeignClient.details(1);
    }

#### 1.2 客户端参数配置 ####

`@FeignClient`注解的`configuration`属性可以配置客户端参数，默认的配置类为`FeignClientsConfiguration`，其提供了`Encoder`、`Decoder`、`Logger`、`Contract`、`Retryer`、`FeignClientConfigurer`等的配置

我们可以通过自定义配置类来配置这些参数，然后在`@FeignClient`注解中配置`configuration`属性

@Configuration
    public class FeignConfiguration {
        
    
        @Bean
        public Contract feignContract(){
        ...}
    
        @Bean
        public Encoder encoder(){
        ...}
        ……
    }

@Component
    @FeignClient(value = "shop-order",path = "order",fallback = OrderFeignClientFallBack.class,configuration = FeignConfiguration.class)
    public interface UserToOrderFeignClient {
        
    
        @GetMapping("details")
        List<Order> details(@RequestParam("uid") Integer uid);
    
    }

除了通过配置类的方式，还可以通过配置文件来进行配置，`feign.client.config`是一个Map，所以需要自定义一个KEY，下面实例把服务名`shop-user`作为KEY，而属性对应于`FeignClientProperties`的内部类`FeignClientConfiguration`

feign:
      sentinel:
        enabled: true
      client:
        config:
          shop-user:
            connectTimeout:
            loggerLevel:
            readTimeout: 5000
            oggerLevel: full
            encoder: com.lizhi.config.Encoder
            decoder: com.lizhi.config.Decoder
            contract: com.lizhi.config.Contract

#### 1.3 断路器配置 ####

SpringCloud断路器支持`fallBack`的概念，以`Sentinel`为例，演示OpenFeign中`fallBack`的使用

首先在配置文件中添加`feign.sentinel.enabled=true`参数，Spring配置的元数据对该参数做了详细的介绍

{
        
        "name": "feign.sentinel.enabled",
        "type": "java.lang.Boolean",
        "description": "If true, an OpenFeign client will be wrapped with a Sentinel circuit breaker.",
        "defaultValue": "false"
    }

我们创建一个`OrderFeignClientFallBack`类，让其实现`UserToOrderFeignClient`这个FeignClient的接口，并把这个类定义为一个Bean

@Component
    public class OrderFeignClientFallBack implements UserToOrderFeignClient {
        
    
        @Override
        public List<Order> details(Integer uid) {
        
            throw new NoFallbackAvailableException("service degrade",new RuntimeException());
        }
    }

然后在FeignClient接口的`@FeignClient`注解中，指定`fallBack`对应的处理类

@Component
    @FeignClient(value = "shop-order",path = "order",fallback = OrderFeignClientFallBack.class)
    public interface UserToOrderFeignClient {
        
    
        @GetMapping("details")
        List<Order> details(@RequestParam("uid") Integer uid);
    
    }

再集成Sentinel之后，可以对`/order/detail`接口设置熔断规则，如果接口调用触发了熔断规则，就会调用`fallBack`类中对应接口的方法