SpringCloud 学习第十二节 OpenFeign服务接口调用

最新推荐文章于 2023-07-24 18:12:03 发布

瑾年丶深蓝

最新推荐文章于 2023-07-24 18:12:03 发布

阅读量171

点赞数

分类专栏： Spring Cloud java 文章标签： spring cloud openfeign

本文链接：https://blog.csdn.net/GayFei/article/details/108442977

版权

java 同时被 2 个专栏收录

25 篇文章 1 订阅

订阅专栏

Spring Cloud

22 篇文章 0 订阅

订阅专栏

OpenFeign服务接口调用

OpenFeign 概述

官网介绍 https://cloud.spring.io/spring-cloud-static/Hoxton.SR1/reference/htmlsingle/#spring-cloud-openfeign
简要说明 Feign是一个声明式的WebService客户端，使用Feign能让编写 WebService客户端更加简单，它的使用方法是：定义一个服务接口然后在上面添加注解。Feign也支持可拔插式的编码器和解码器，SpringCloud对Feign进行了封装，Feign支持了SpringMVC标准注解和HttpMessageConverters。Feign也可以与Eureka和Ribbon组合使用以支持负载均衡。
Feign的主要作用：
Feign旨在编写Java Http客户端更加容易
前面在使用Ribbon + RestTemplate时，利用RestTemplate对Http请求的封装处理，形成了一套模版化的调用方法，但是在实际开发中，由于对服务依赖的调用可能不只一处，往往一个接口会被多处调用，所以通常都会针对每个微服务自行封装一些客户端的类来包装这些依赖服务的调用。所以Feign在此基础上做了进一步封装，由他来帮助我们定义和实现依赖服务接口的定义。在Feign的实现下，我们只需要创建一个接口并使用注解的方式来配置他（类比Mybatis使用Dao接口上的Mapper注解，微服务接口上标注一个Feign注解即可使用），这样完成对服务提供方的接口绑定。简化了使用 SpringCloud Ribbon时，自动封装服务调用客户端的开发量
Feign 集成了Ribbon
利用Feign维护服务提供者的服务列表信息，并且通过轮询实现了客户端的负载均衡。与Ribbon不同的是，通过Feign只需要定义服务绑定接口且以声明式的方法，简化了服务之间的调用。
Feign 和 Open Feign 两者的区别

Feign	Open Feign
Feign 是Spring Cloud 组件中的一个轻量级RestFul的HTTP服务客户端。Feign内置了Ribbon，用来做客户端负载均衡，去调用服务注册中心的服务。Feign的使用方式是：使用Feign的注解定义接口，调用这个接口，就可以调用服务注册中心的服务	Open Feign 是 SpringCloud在 Feign 的基础上支持了SpringMVC的注解，如@RequestMapping等等。Open Feign 的@FeignClient可以解析SpringMvc中使用的注解接口，并可以通过动态代理的方式产生实现类，实现类中做负载均衡并调用其他服务

OpenFeign 使用步骤

新建Module

新建 cloud-fegin-order80 模块

修改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>zjt-cloud-api</artifactId>
        <groupId>com.zjt.cloud-api</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-fegin-order80</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通用包，可以使用Payment支付Entity -->
        <dependency>
            <groupId>com.zjt.cloud-api</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.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>

写application.yml

server:
  port: 80

spring:
  application:
    name: cloud-feign-server
eureka:
  client:
    register-with-eureka: true
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka

主启动类

package com.zjt.cloud;

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

import java.util.TimeZone;

/**
 * @author zjt
 * @date 2020-09-07
 */
@EnableEurekaClient
@EnableFeignClients
@SpringBootApplication
public class FeignOrder80Application {

    public static void main(String[] args) {
        // 时区设置
        TimeZone.setDefault(TimeZone.getTimeZone("Asia/Shanghai"));

        SpringApplication.run(FeignOrder80Application.class, args);
    }

}

业务类

远程调用服务提供者的方法接口

package com.zjt.cloud.rpcserve;

import com.zjt.cloud.domain.CommonResult;
import com.zjt.cloud.domain.Payment;
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 zjt
 * @date 2020-09-07
 */
@Component
@FeignClient("CLOUD-PAYMENT-SERVICE")
public interface PaymentFeignRPC {
	// 调用路径 
	// @PathVariable(value = "id") 注意value = "id" 在controller时可以省去，
	// 但是这里省去可能会报错 PathVariable annotation was empty on param 0
    @GetMapping("/payments/payment/{id}")
    CommonResult<Payment> findById(@PathVariable(value = "id") Long id);

}

controller

package com.zjt.cloud.controller;

import com.zjt.cloud.domain.CommonResult;
import com.zjt.cloud.domain.Payment;
import com.zjt.cloud.rpcserve.PaymentFeignRPC;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author zjt
 * @date 2020-09-07
 */
@RestController
@RequestMapping("/feign-order")
public class FeignOrderController {

    @Autowired
    private PaymentFeignRPC paymentFeignRPC;

    @GetMapping("/{id}")
    public CommonResult<Payment> findById(@PathVariable Long id) {
        return paymentFeignRPC.findById(id);
    }

}

测试

自测通过采用轮询的方式获取服务提供者提供的服务，但是首次访问出现了偶发超时异常 java.net.SocketTimeoutException: Read timed out 再次访问就正常了。
在这里插入图片描述

OpenFeign 超时控制

默认Feign客户端仅等待1s，如果服务提供者处理时长超过1s，feign客户端不再等待直接抛出错误信息，也就是上一步测试中偶发的超时异常，但是对于长业务逻辑，处理时间超过1s的，需要在feign客户端设置超时控制

超时异常自测

修改payment8001 controller

@GetMapping("/time-out")
    public String paymentFeignTimeOut() {
        try {
            TimeUnit.SECONDS.sleep(3);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        return port;
    }

feign客户端远程调用修改

@FeignClient("CLOUD-PAYMENT-SERVICE")
public interface PaymentFeignRPC {

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

    @GetMapping("/payments/payment/time-out")
    String paymentTimeOut();

}

feign客户端 controller 修改

@GetMapping("/time-out")
    public String paymentTimeOut() {
        return paymentFeignRPC.paymentTimeOut();
    }

8001 自测正常返回
在这里插入图片描述
feign客户端测试则抛出异常

修改feign application.yml

server:
  port: 80

spring:
  application:
    name: cloud-feign-server
eureka:
  client:
    register-with-eureka: true
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka
# open feign 默认支持ribbon 超时控制交给ribbon 设置feign客户端超时时间
ribbon:
  # 建立链接后从服务器读取到可用资源所用的时间
  ReadTimeOut: 5000
  # 建立链接所用的时间，用户网络正常的情况下，两端连接所用的时间
  ConnectTimeOut: 5000

重启之后再次测试正常返回
在这里插入图片描述

OpenFeign 日志

Feign 提供了日志打印功能，我们可以通过配置来调整日志级别，从而了解 Feign 中 Http 请求的细节
Feign 日志级别
NONE：默认的，不打印任何日志
BASIC：仅记录请求方法、URL、响应状态码以及执行时间
HEADERS：除了BASIC定义的信息，还有请求和响应的头信息
FULL:除了HEADERS定义的信息，还有请求和响应的正文以及元数据
日志配置Bean

package com.zjt.cloud.config;

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


/**
 * @author zjt
 * @date 2020-09-07
 */
@Configuration
public class FeignLogConfig {

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

application.yml 添加日志监控级别

logging:
  level:
    # feign日志以什么级别监控哪个接口
    com.zjt.cloud.rpcserve: debug

请求测试
在这里插入图片描述