OpenFeign微服务调用组件_微服务组件openfeigin

1.Feign是什么

GitHub - OpenFeign/feign: Feign makes writing java http clients easierhttps://github.com/OpenFeign/feign

Feign是Netflix开发的声明式、模板化的HTTP客户端， Feign可以帮助我们更快捷、优雅地调用HTTP API，目的是让编写HTTP接口的客户端变得更简洁和直接。

在Spring Cloud中，使用Feign非常简单——创建一个接口，并在接口上添加一些注解，代码就完成了。Feign支持多种注解，例如Feign自带的注解或者JAX-RS注解等。

Feign是一个声明式的Web服务客户端，让编写Web服务客户端变的更加容易。只需要创建一个接口并添加注解即可

优势：

Feign可以做到使用 HTTP 请求远程服务时就像调用本地方法一样的体验，开发者完全感知不到这是远程方法，更感知不到这是个 HTTP 请求，开发者无需关注与远程的交互细节，更无需关注分布式环境开发。

2.OpenFeign

Feign 和 OpenFeign 的区别（精简记忆版）？

1.支持spring mvc 注解

2.整合了更多的扩展 （请求重试策略、超时控制、请求拦截器）

 3.Spring Cloud Alibaba快速整合OpenFeign

1）创建order-service模块提供服务

 <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

application.properties配置

 controller文件

package com.by.controller;
 
import cn.by.heimidto.OrderQueryDTO;
import cn.by.heimidto.OrderingDTO;
import cn.by.heimidto.OrderingOkDTO;
import cn.hutool.core.thread.ThreadUtil;
import cn.hutool.core.util.StrUtil;
import org.springframework.web.bind.annotation.*;
 
import java.math.BigDecimal;
import java.util.List;
import java.util.stream.Collectors;
 
@RestController
@RequestMapping("/api/order")
public class OrderController {
    @GetMapping("/ordering")
    public String ordering() {
        return "下单成功";
        }
    @GetMapping("/ordering2")
    public OrderingOkDTO ordering2() {
        OrderingOkDTO dto = OrderingOkDTO.builder().id(1L).needPay(new BigDecimal(1000)).build();
        return dto;
    }
    @PostMapping ("/ordering3")
    public OrderingOkDTO ordering3(@RequestBody OrderingDTO dto) {
        List<String> names = dto.getProducts().stream().map(product -> product.getName()).collect(Collectors.toList());
        String msg = StrUtil.join( ",", names);
        OrderingOkDTO orderingOkDTO = OrderingOkDTO.builder().id(1L).needPay(new BigDecimal(1000)).msg(msg).build();
        return orderingOkDTO;
    }
 
 
    @GetMapping ("/select")
    public String select(OrderQueryDTO dto) {
        String msg = StrUtil.EMPTY;
        if (dto.getId() != null) {
            msg = "根据Id查询成功：Id= " + dto.getId();
        }
        if (dto.getUserId() != null){
            msg = "根据userId查询成功：userId= " + dto.getUserId();
        }
        return msg;
    }
 
    @GetMapping ("/sleep")
    public String sleep(@RequestParam Integer time) {
 
        ThreadUtil.safeSleep(time*1000);
 
        String msg = "睡眠了 " + time + " 秒";
 
        return msg;
    }
}

2)、创建user-service服务调用模块

1、引入依赖：

<!-- openfeign 远程调用 -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

2、编写调用接口+@FeignClient注解 并在启动类添加 @EnableFeignClients注解

package com.by.feignservice;
 
import cn.by.heimidto.OrderQueryDTO;
import cn.by.heimidto.OrderingDTO;
import cn.by.heimidto.OrderingOkDTO;
import com.by.config.FeignConfig;
import feign.RequestLine;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.cloud.openfeign.SpringQueryMap;
import org.springframework.web.bind.annotation.*;
 
//@FeignClient(name = "order-service-app",configuration = FeignConfig.class) //针对一个配置 日志级别
@FeignClient(name = "order-service-app")
@RequestMapping("/api/order")
public interface OrderService {
    @GetMapping("/ordering")
    String ordering();
    @GetMapping("/ordering2")
    OrderingOkDTO ordering2();
    @PostMapping("/ordering3")
    OrderingOkDTO ordering3(@RequestBody OrderingDTO dto);
    @GetMapping ("/select")
    public String select(@SpringQueryMap OrderQueryDTO dto);
 
    @GetMapping ("/sleep")
    String sleep(@RequestParam Integer time) ;
}

3、发起调用，像调用本地方法一样调用远程服务

package com.by.controller;
 
import cn.by.heimidto.OrderQueryDTO;
import cn.by.heimidto.OrderingDTO;
import cn.by.heimidto.OrderingOkDTO;
import cn.by.heimidto.ProductDTO;
import com.by.feignservice.OrderService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
 
import java.util.ArrayList;
import java.util.List;
 
@RestController
@RequestMapping("/api/user")
public class UserController {
    @Autowired
    RestTemplate restTemplate;
    @Autowired
    OrderService orderService;
 
    @GetMapping("/sleep")
    public String sleep() {
        String sleep = orderService.sleep( 15);
        return sleep;
    }
 
    @GetMapping("/shopping")
    public String shopping() {
        String str = orderService.ordering();
        return "下单";
    }
 
    @GetMapping("/shopping2")
    public String shopping2() {
        OrderingOkDTO orderingOkDTO = orderService.ordering2();
        return "orderingOkDTO";
    }
    @GetMapping("/shopping3")
    public String shopping3() {
        List<ProductDTO> products = new ArrayList<>();
        products.add(new ProductDTO(1,"手机"));
        products.add(new ProductDTO(2,"su7"));
        OrderingDTO orderingDTO = new OrderingDTO();
        orderingDTO.setUserId(1);
        orderingDTO.setProducts(products);
        OrderingOkDTO orderingOkDTO = orderService.ordering3(orderingDTO);
        return " ";
 
    }
    @GetMapping("/order/select")
    public String orderSelect() {
 
        OrderQueryDTO orderQueryDTO = new OrderQueryDTO();
        orderQueryDTO.setId(1);
        String select = orderService.select(orderQueryDTO);
 
        return " ";
 
    }
}

5）配置类

package com.by.config;
 
import feign.Logger;
import feign.Request;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
 
import java.util.concurrent.TimeUnit;
 
@Configuration
public class FeignConfig {
    //全局配置服务日志级别
    //@Bean
    Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL;
    }
 
     //配置请求超时时间
    @Bean
    public Request.Options options() {
        return new Request.Options(10, TimeUnit.SECONDS, 20,TimeUnit.SECONDS,true);
    }
}

package com.by.config;
 
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
import org.springframework.web.client.RestTemplate;
 
@Configuration
public class RestTemplateConfig {
    @Bean
    @LoadBalanced
    public RestTemplate restTemplate(){
        RestTemplate restTemplate = new RestTemplate();
        restTemplate.setRequestFactory(new HttpComponentsClientHttpRequestFactory());
        return restTemplate;
    }
}

6）用到的DTO

@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class OrderQuery {
    private Integer id;
    private String name;
}

@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
public class OrderingDTO {
   private Long id;
   private BigDecimal needPay;
}

7）Get 传递对象 使用@SpringQueryMap注解

 4.高级配置

Feign 提供了很多的扩展机制，让用户可以更加灵活的使用。

4.1 日志配置

有时候我们遇到 Bug，比如接口调用失败、参数没收到等问题，或者想看看调用性能，就需要配置 Feign 的日志了，以此让 Feign 把请求信息输出来。

Feign 提供了日志打印功能，我们可以通过配置来调整日志级别，从而了解 Feign 中 Http 请求的细节。说白了就是对Feign接口的调用情况进行监控和输出

通过源码可以看到日志等级有 4 种，分别是：

• NONE【性能最佳，适用于生产】：不记录任何日志（默认值）。

• BASIC【适用于生产环境追踪问题】：仅记录请求方法、URL、响应状态代码以及执行时间。

• HEADERS：记录BASIC级别的基础上，记录请求和响应的header。

• FULL【比较适用于开发及测试环境定位问题】：记录请求和响应的header、body和元数据

4.1.1 全局配置

注意一：此处配置@Configuration注解就会全局生效，如果想指定对应某一个服务生效，就不能配置.

注意二： 因为feign调试日志是debug级别输出,springboot默认的日志级别是info，所以feign的debug日志级别就不会输出，一定要将调用服务的日志级别调为debug

logging.level.com.by=DEBUG

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

 4.1.2 局部配置

局部配置，让调用的微服务生效，在@FeignClient 注解中指定使用的配置类

4.1.3 在配置文件配置 

logging.level.com.beiyou = debug开启日志
##配置feign 的日志级别
#-- default 全局配置
feign.client.config.default.loggerLevel=NONE
#-- nacos-a 具体服务名
feign.client.config.nacos-a.loggerLevel=FULL

4.2 超时配置 

通过 Options 可以配置连接超时时间和读取超时时间

4.2.1 全局配置

@Configurationpublic class FeignConfig { 
   @Bean    public Request.Options options() {    
  return new Request.Options(10L, TimeUnit.SECONDS, 60L,TimeUnit.SECONDS,true);   
 }}

4.2.2 配置文件中配置

#全局配置feign.client.config.default.connectTimeout=5000
feign.client.config.default.readTimeout=10000
这里default 是一个特殊的客户端名称，用于表示全局配置。设置 connectTimeout 和 readTimeout 属性的值来定义全局的连接超时时间和读取超时时间。
#局部配置 请将 <clientName> 替换为实际的Feign客户端名称。feign.client.config.<clientName>.connectTimeout=5000
feign.client.config.<clientName>.readTimeout=10000
feign.client.config.order-service.connectTimeout=5000   # 连接超时时间，默认10s order-service:  #对应微服务feign.client.config.order-service.readTimeout=10000     # 请求处理超时时间，默认60s

 补充说明： Feign的底层用的是Ribbon，但超时时间以Feign配置为准

04-OpenFeign-请求超时机制_openfeign.timeout-CSDN博客https://blog.csdn.net/xcg340123/article/details/136021389