springcloud(七)--OpenFeign服务接口调用

2023-11-28 08:34:10

OpenFeign服务接口调用

概述

OpenFeign是什么

官网解释： https://cloud.spring.io/spring-cloud-static/Hoxton.SR1/reference/htmlsingle/#spring-cloud-openfeign

Feign是一个声明式Webservice客户端。使用Feign能让编写Web Service客户端更加简单。
它的使用方法是定义一个服务接口然后在上面添加注解。Feign也支持可拔插式的编码器和解码器。Spring Cloud对Feign进行了封装，使其支持Spring MVC标准注解和HttpMessageConverters。Feign可以与Eureka和Ribbon组合使用以支持负载均衡。
springcloud(七)--OpenFeign服务接口调用
Feign是一个声明式的Web服务客户端，让编写Web服务客户端变得非常容易，只需要创建一个接口并在接口上添加注解即可。

GitHub地址：https://github.com/spring-cloud/spring-cloud-openfeign

Feign能做什么

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

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

Feign和OpenFeign两者的区别

Feign OpenFeign
Feign是Spring Cloud组件中的一个轻量级RESTful的HTTP服务客户端Feign内置了Ribbon，用来做客户端的负载均衡，去调用服务注册中心的服务。Feign的使用方法是：使用Feign的注解定义接口，调用这个接口，就可以调用服务注册中心的服务 OpenFeign是Spring Cloud在Feign的基础上支持了Spring MVC的注解，如@RequesMapping等等。OpenFeign的@FeignClient可以解析Spring MVC的@RequesMapping注解下的接口，并通过动态代理方式实现类，实现类中做负载均衡并调用其他服务。
<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使用步骤

微服务调用接口 + @FeignClient

新建cloud-consumer-feign-order-80(Feign在消费端使用)
pom文件：

<?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>cloud2020</artifactId>
        <groupId>com.zzp.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-consumer-feign-order-80</artifactId>

    <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通用包 实体类 -->
        <dependency>
            <groupId>com.zzp.springcloud</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>${project.version}</version>
        </dependency>
        <!--boot web actuator-->
        <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>
        <!-- lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <!-- test -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

</project>

application.yml配置文件：

server:
  port: 80

eureka:
  client:
    register-with-eureka: false
    service-url:
      #defaultZone: http://localhost:7001/eureka # 单机版
      defaultZone: http://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka  #集群版

主启动类：添加@EnableFeignClients注解

package com.zzp.springcloud;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.openfeign.EnableFeignClients;

/**
 * @author zzp
 * @create 2021-02-24
 */
@SpringBootApplication
@EnableFeignClients
public class OrderFeignMain80 {

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

}

feign配置类：添加@FeignClient注解

package com.zzp.springcloud.feign;


import com.zzp.springcloud.entities.CommonResult;
import com.zzp.springcloud.entities.Payment;
import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

/**
 * @author zzp
 * @create 2021-02-24
 */
@Component
@FeignClient(value = "CLOUD-PAYMENT-SERVICE")
public interface PaymentFeign {

    @GetMapping(value = "/payment/get/{id}")
    CommonResult<Payment> getPaymentById(@PathVariable("id") Long id);

}

控制类：

package com.zzp.springcloud.controller;

import com.zzp.springcloud.entities.CommonResult;
import com.zzp.springcloud.entities.Payment;
import com.zzp.springcloud.feign.PaymentFeign;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

/**
 * @author zzp
 * @create 2021-02-24
 */
@RestController
@Slf4j
public class OrderFeignController {

    @Resource
    private PaymentFeign paymentFeign;

    @GetMapping(value = "/consumer/payment/get/{id}")
    public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id){
        return paymentFeign.getPaymentById(id);
    }


}

启动
springcloud(七)--OpenFeign服务接口调用

springcloud(七)--OpenFeign服务接口调用

OpenFeign超时控制

8001服务添加接口：

 @GetMapping(value = "/payment/feign/timeout")
    public String paymentFeignTimeout(){
        try
        {
            // 睡眠3秒
            TimeUnit.SECONDS.sleep(3);
        } catch (InterruptedException e)
        {
            e.printStackTrace();
        }
        return servicePort;
    }

cloud-consumer-feign-order-80服务添加feign接口：

 @GetMapping(value = "/payment/feign/timeout")
 String paymentFeignTimeout();

控制类添加接口：

@GetMapping(value = "/consumer/payment/feign/timeout")
    public String paymentFeignTimeout(){
        //openfeign-ribbon,客户端一般默认等待1秒钟
        return paymentFeign.paymentFeignTimeout();
    }

启动测试：
springcloud(七)--OpenFeign服务接口调用
springcloud(七)--OpenFeign服务接口调用
默认Feign客户端只等待一秒钟，但是服务端处理需要超过1秒钟，导致Feign客户端不想等待了，直接放回错误。为了避免这样的的情况，有时候我们需要设置Feign客户端的超时控制。

yml文件中添加开启配置：

#设置feign客户端超时时间（openfeign默认支持ribbon）
ribbon:
  #指的是建立使用的时间，适用于网络状况正常的情况下，两端连接的时间 （设置10秒）
  ReadTimeout: 10000
  #指的是建立连接后从服务器读取到可用资源的时间 （设置10秒）
  ConnectTimeout: 10000

重启测试：
springcloud(七)--OpenFeign服务接口调用

OpenFeign日记打印功能

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

日记级别：

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

cloud-consumer-feign-order-80服务
添加Bean配置类：

package com.zzp.springcloud.config;

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

import feign.Logger;

/**
 * @author zzp
 * @create 2021-02-24
 */
@Configuration
public class FeignConfig {

    @Bean
    Logger.Level feignLoggerLevel(){
        return Logger.Level.FULL;
    }
}

springcloud(七)--OpenFeign服务接口调用

yml文件中添加配置：

logging:
  level:
    # feign日记以什么级别监控哪个接口
    com.zzp.springcloud.feign.PaymentFeign: debug

启动测试：

springcloud(七)--OpenFeign服务接口调用

上一篇：Spring Cloud OpenFeign 动态Url


下一篇：OpenFeign的简单介绍和快速使用