openfeign

时间：2022-10-21 08:56:04

目录

一、概述

1.feign是什么

2.作用

①Feign能干什么

 ②Feign集成了Ribbon

③feign和opqnfeign的区别

二、使用步骤

1.接口 + 注解

2.新建项目：cloud-consumer-feign-order80

3.pom.xml

4.application.yml

5.主启动类

6.业务类

⚪业务逻辑接口 + @FeignClient配置调用provider服务

⚪新建PaymentFeignService接口并新增注解@FeignClient

⚪控制层Controller

7.测试

​编辑三、OpenFeign超时控制

​编辑1.超时设置，故意设置超时演示出错情况

2.OpenFeign默认等待1秒钟，超时后报错

3.application.yml

四、 OpenFeign日志打印功能

⭐日志级别

⭐配置日志bean 

⭐YML文件里需要开启日志的Feign客户端

一、概述

1.feign是什么

官网解释：Spring Cloud
openfeign 

  • Feign是一个声明式WebService客户端。
  • 使用Feign能让编写Web Service客户端更加简单。
  • 使用方法：定义一个服务接口然后在上面添加注解。
  • Feign也支持可拔插式的编码器和解码器。
  • Spring Cloud对Feign进行了封装，使其支持Spring MVC标准注解和HttpMessageConverters
  • Feign可以与Eureka和Ribbon组合使用以支持负载均衡
  • Feign 对 Ribbon 进行了集成，利用 Ribbon 维护了一份可用服务清单，并通过 Ribbon 实现了客户端的负载均衡。
  • 2019 年 Netflix 公司宣布 Feign 组件正式进入停更维护状态，于是 Spring 官方便推出了一个名为 OpenFeign 的组件作为 Feign 的替代方案。

2.作用

①Feign能干什么

  • Feign旨在使编写Java Http客户端变得更容易
  • 前面在使用Ribbon+RestTemplate时，利用RestTemplate对http请求的封装处理，形成了一套模版化的调用方法。
  • 在实际开发中，由于对服务依赖的调用可能不止一处，往往一个接口会被多处调用，所以通常都会针对每个微服务自行封装一些客户端类来包装这些依赖服务的调用。所以，Feign在此基础上做了进一步封装，由他来帮助我们定义和实现依赖服务接口的定义。
  • 在Feign的实现下，我们只需创建一个接口并使用注解的方式来配置它(以前是Dao接口上面标注Mapper注解,现在是一个微服务接口上面标注一个Feign注解即可)，即可完成对服务提供方的接口绑定
  • 简化了使用Spring cloud Ribbon时，自动封装服务调用客户端的开发量。

 
②Feign集成了Ribbon

  • 利用Ribbon维护了Payment的服务列表信息，并且通过轮询实现了客户端的负载均衡。
  • 与Ribbon不同的是，通过feign只需要定义服务绑定接口且以声明式的方法，优雅而简单的实现了服务调用
     

③feign和opqnfeign的区别

feign opqnfeign
  • Feign是Spring Cloud组件中的一个轻量级RESTful的HTTP服务客户端
  • Feign内置了Ribbon，用来做客户端负载均衡，去调用服务注册中心的服务。
  • Feign的使用方式是：使用Feign的注解定义接口，调用这个接口，就可以调用服务注册中心的服务
  • OpenFeign是Spring Cloud 在Feign的基础上支持了SpringMVC的注解，如@RequesMapping等等。
  • OpenFeign的@FeignClient可以解析通过动态代理的方式产生实现类，实现类中做负载均SpringMVC的@RequestMapping注解下的接口，并衡并调用其他服务。
<dependency>
 <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-feign</artifactId>
</dependency>    		 <dependency>
 <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

 

二、使用步骤

openfeign

1.接口 + 注解

微服务调用接口 + @FeignClient

2.新建项目：cloud-consumer-feign-order80

feign在消费端使用

openfeign

openfeign

3.pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>cloud2022</artifactId>
        <groupId>com.atxupt.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-consumer-feign-order80</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>
    <dependencies>
        <!--openfeign-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <!--eureka client-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <!-- 引入自己定义的api通用包，可以使用Payment支付Entity -->
        <dependency>
            <groupId>com.atxupt.springcloud</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <!--web-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <!--一般基础通用配置-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

</project>

4.application.yml

server:
  port: 80

eureka:
  client:
    register-with-eureka: false
    service-url: # 配置服务中心，openFeign去里面找服务
      defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/

5.主启动类

@SpringBootApplication
@EnableFeignClients
public class OrderFeignMain80 {
    public static void main(String[] args) {
        SpringApplication.run(OrderFeignMain80.class,args);
    }
}

6.业务类

⚪业务逻辑接口 + @FeignClient配置调用provider服务

⚪新建PaymentFeignService接口并新增注解@FeignClient

@Component
@FeignClient(value = "CLOUD-PAYMENT-SERVICE")
public interface PaymentFeignService {
    @GetMapping(value = "/payment/get/{id}")
    public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id);
}

⚪控制层Controller

@RestController
@Slf4j
public class OrderFeignController {
    @Resource
    private PaymentFeignService paymentFeignService;
    
    @GetMapping(value = "/consumer/payment/get/{id}")
    public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id){
        return paymentFeignService.getPaymentById(id);
    }
}

7.测试

openfeign

openfeign
⭐成功查询（刷新后8001、8002交替出现）

openfeign

openfeign三、OpenFeign超时控制

openfeign1.超时设置，故意设置超时演示出错情况

  • 服务提供方8001故意写暂停程序
  • 服务消费方80添加超时方法PaymentFeignService
  • 服务消费方80添加超时方法OrderFeignControIIer
  • 测试：http://localhost/consumer/payment/feign/timeout
  • 错误页面
  • Openfeign默认超时等待为一秒，在消费者里面配置超时时间
//8001服务提供方 
@GetMapping(value = "/payment/feign/timeout")
public String paymentFeignTimeout(){
    // 业务逻辑处理正确，但是需要耗费3秒钟
    try { TimeUnit.SECONDS.sleep(3); } catch (InterruptedException e) { e.printStackTrace(); }
    return serverPort;
}

2.OpenFeign默认等待1秒钟，超时后报错

默认Feign客户端只等待一秒钟，但是服务端处理需要超过1秒钟，导致Feign客户端不想等待了，直接返回报错。
为了避免这样的情况，有时候我们需要设置Feign客户端的超时控制。

openfeign

3.application.yml

eureka:
  client:
    register-with-eureka: false
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/
#设置feign客户端超时时间(OpenFeign默认支持ribbon)
ribbon:
  #指的是建立连接所用的时间，适用于网络状况正常的情况下,两端连接所用的时间
  ReadTimeout: 5000
  #指的是建立连接后从服务器读取到可用资源所用的时间
  ConnectTimeout: 5000

四、 OpenFeign日志打印功能

openfeign

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

⭐日志级别

  • NONE：默认的，不显示任何日志
  • BASIC：仅记录请求方法、URL、响应状态码及执行时间 
  • HEADERS：除了 BASIC 中定义的信息之外，还有请求和响应的头信息
  • FULL：除了 HEADERS 中定义的信息之外，还有请求和响应的正文及元数据

⭐配置日志bean 

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;
    }
}

⭐YML文件里需要开启日志的Feign客户端

server:
  port: 80

eureka:
  client:
    register-with-eureka: false
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka/,http://eureka7002.com:7002/eureka/

#设置feign客户端超时时间
#springCloud默认开启支持ribbon
ribbon:
#指的是建立连接所用的时间，适用于网络状况正常的情况下,两端连接所用的时间
  ReadTimeout: 5000
#指的是建立连接后从服务器读取到可用资源所用的时间
  ConnectTimeout: 5000

logging:
  level:
    # feign日志以什么级别监控哪个接口
    com.atguigu.springcloud.service.PaymentFeignService: debug
标签：

相关文章