SpringCloud从入门到放弃 05——OpenFeign服务接口调用

最新推荐文章于 2024-09-14 18:46:05 发布

半晨烟宇

最新推荐文章于 2024-09-14 18:46:05 发布

阅读量375

点赞数 1

本文链接：https://blog.csdn.net/Mr_Gone/article/details/122972849

版权

springcloud 专栏收录该内容

6 篇文章 0 订阅

订阅专栏

文章目录

SpringCloud从入门到放弃 05 ——OpenFeign服务接口调用

SpringCloud从入门到放弃 05 ——OpenFeign服务接口调用

一、OpenFeign概述

1.什么是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组合使用以支持负载均衡

在这里插入图片描述

2.OpenFeign能做什么

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

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

3.OpenFeign和Feign的区别

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

Feign已经停止服务
之前是使用restTemplate+ribbon 实现服务的调用，现在可以通过OpenFeign 来实现服务的调用，且OpenFeign已经集成了ribbon

二、OpenFeign使用

1.OpenFeign 入门使用

1.建module
新建 cloud-consumer-feign-order80
在这里插入图片描述
2.写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>mscloud</artifactId>
        <groupId>com.avgrado.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-consumer-feign-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.avgrado.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>

3.写application.yml

server:
  port: 80
eureka:
  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka,http://eureka7002.com:7003/eureka

4.主启动类（注意主启动类的注解需要有 @EnableFeignClients ）

package com.avgrado.springcloud;

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

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

5.业务类
新建IPaymenFeignService接口并在接口类上加上 @FeignClient 注解

package com.avgrado.springcloud.service;

import com.avgrado.springcloud.entity.CommonResult;
import com.avgrado.springcloud.entity.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;

@Component
@FeignClient(value="CLOUD-PAYMENT-SERVICE")
public interface IPaymenFeignService {

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

新建FeignOrderController

package com.atguigu.springcloud.controller;

import com.atguigu.springcloud.entities.CommonResult;
import com.atguigu.springcloud.entities.Payment;
import com.atguigu.springcloud.service.PaymentFeignService;
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;

/**
 * @auther zzyy
 * @create 2020-02-03 14:10
 */
@RestController
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);
    }
}

6.先启动Eureka 集群，然后再启动Payment 服务，最后启动 OrderFeignApplicaiton,启动完成之后，访问：http://localhost/order/consumer/payment/get/1
在这里插入图片描述

可以看到通过 OpenFeign 负载均衡轮询访问了 Payment 服务

小总结：
在这里插入图片描述

2.OpenFeign 访问超时控制

超时设置：服务提供方8001和8002中故意写暂停程序：
1.在PaymentController种添加如下方法

@GetMapping(value = "/feign/timeout")
    public String paymentFeignTimeOut()
    {
        System.out.println("*****paymentFeignTimeOut from port: "+serverPort);
        //暂停几秒钟线程
        try { TimeUnit.SECONDS.sleep(3); } catch (InterruptedException e) { e.printStackTrace(); }
        return serverPort;
    }

2.在服务消费方cloud-consumer-feign-order 中的 IPaymenFeignService 接口中添加如下方法

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

3.在服务消费方cloud-consumer-feign-order 中的 OrderFeignController 中添加如下方法

@GetMapping(value = "/consumer/payment/feign/timeout")
    public String paymentFeignTimeOut()
    {
        return feignService.paymentFeignTimeOut();
    }

4.先测试下直接访问服务提供方payment :http://localhost:8001/payment/feign/timeout
在这里插入图片描述
可以看到访问地址后转3秒后会刷新出来
5.直接通过消费方访问，等待1秒左右后 访问超时

6.修改默认的超时时间

server:
  port: 80
eureka:
  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka,http://eureka7002.com:7003/eureka
ribbon:
  #指的是建立连接所用的时间，适用于网络状况正常的情况下,两端连接所用的时间
  ReadTimeout: 5000
  #指的是建立连接后从服务器读取到可用资源所用的时间
  ConnectTimeout: 5000

重启服务后再次访问，
在这里插入图片描述

3.OpenFeign 日志打印功能

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

日志级别：
NONE：默认的，不显示任何日志；

BASIC：仅记录请求方法、URL、响应状态码及执行时间；

HEADERS：除了 BASIC 中定义的信息之外，还有请求和响应的头信息；

FULL：除了 HEADERS 中定义的信息之外，还有请求和响应的正文及元数据。

配置过程：
1.配置日志bean

package com.avgrado.springcloud.config;

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

@Configuration
public class FeignConfig {

    /**
     * NONE：默认的，不显示任何日志；
     * BASIC：仅记录请求方法、URL、响应状态码及执行时间；
     * HEADERS：除了 BASIC 中定义的信息之外，还有请求和响应的头信息；
     * FULL：除了 HEADERS 中定义的信息之外，还有请求和响应的正文及元数据。
     * @return
     */
    @Bean
    Logger.Level feignLoggerLevel()
    {
        return Logger.Level.FULL;
    }

}

2.application.yml里开启需要开启的Feign客户端（最后的4行）

server:
  port: 80
eureka:
  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka,http://eureka7002.com:7003/eureka
ribbon:
  #指的是建立连接所用的时间，适用于网络状况正常的情况下,两端连接所用的时间
  ReadTimeout: 5000
  #指的是建立连接后从服务器读取到可用资源所用的时间
  ConnectTimeout: 5000
logging:
  level:
    # feign日志以什么级别监控哪个接口
    com.avgrado.springcloud.service.IPaymenFeignService: debug

启动服务并调用：http://localhost/order/consumer/payment/get/1
查看后台日志：

2022-02-17 00:15:15.413 DEBUG 10468 --- [p-nio-80-exec-1] c.a.s.service.IPaymenFeignService        : [IPaymenFeignService#getPaymentById] <--- HTTP/1.1 200 (286ms)
2022-02-17 00:15:15.414 DEBUG 10468 --- [p-nio-80-exec-1] c.a.s.service.IPaymenFeignService        : [IPaymenFeignService#getPaymentById] connection: keep-alive
2022-02-17 00:15:15.414 DEBUG 10468 --- [p-nio-80-exec-1] c.a.s.service.IPaymenFeignService        : [IPaymenFeignService#getPaymentById] content-type: application/json
2022-02-17 00:15:15.414 DEBUG 10468 --- [p-nio-80-exec-1] c.a.s.service.IPaymenFeignService        : [IPaymenFeignService#getPaymentById] date: Wed, 16 Feb 2022 16:15:15 GMT
2022-02-17 00:15:15.414 DEBUG 10468 --- [p-nio-80-exec-1] c.a.s.service.IPaymenFeignService        : [IPaymenFeignService#getPaymentById] keep-alive: timeout=60
2022-02-17 00:15:15.414 DEBUG 10468 --- [p-nio-80-exec-1] c.a.s.service.IPaymenFeignService        : [IPaymenFeignService#getPaymentById] transfer-encoding: chunked
2022-02-17 00:15:15.414 DEBUG 10468 --- [p-nio-80-exec-1] c.a.s.service.IPaymenFeignService        : [IPaymenFeignService#getPaymentById] 
2022-02-17 00:15:15.415 DEBUG 10468 --- [p-nio-80-exec-1] c.a.s.service.IPaymenFeignService        : [IPaymenFeignService#getPaymentById] {"code":200,"message":"查询成功8001","data":{"id":1,"serial":"H20220124"}}
2022-02-17 00:15:15.415 DEBUG 10468 --- [p-nio-80-exec-1] c.a.s.service.IPaymenFeignService        : [IPaymenFeignService#getPaymentById] <--- END HTTP (78-byte body)
2022-02-17 00:15:16.283  INFO 10468 --- [erListUpdater-0] c.netflix.config.ChainedDynamicProperty  : Flipping property: CLOUD-PAYMENT-SERVICE.ribbon.ActiveConnectionsLimit to use NEXT property: niws.loadbalancer.availabilityFilteringRule.activeConnectionsLimit = 2147483647