SpringCloud（第九章 OpenFeign服务接口调用）

已于 2023-08-02 11:03:57 修改
阅读量679 收藏 2
点赞数
分类专栏： SpringCloud java 文章标签： restful spring java
于 2021-09-17 21:52:45 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_45087487/article/details/120318666
版权

文章目录

一、概述

1.OpenFeign是什么

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

1.Feign是一个声明式WebService客户端。使用Feign能让编写WebService客户端更加简单。
2.它的使用方法是定义一个服务接口然后在上面添加注解。Feign也支持可拔插式的编码器和解码器。Spring Cloud对Feign进行了封装，使其支持了Spring MVC标准注解和HttpMessageConverters。Feign可以与Eureka和Ribbon组合使用以支持负载均衡。
在这里插入图片描述

1.Feign是一个声明式的Web服务客户端，让编写Web服务客户端变得非常容易，只需创建一个接口并在接口上添加注解即可。
2.GitHub地址
https://github.com/spring-cloud/spring-cloud-openfeign

2.能干嘛

1.Feign旨在使编写java Http客户端变得更容易。
2.前面在使用Ribbon + RestTemplate时，利用RestTemplate对http请求的封装处理，形成了一套模板化的调用方法。但是在实际开发中，由于对服务依赖的调用可能不止一处，往往一个接口会被多处调用，所以通常都会针对每个微服务自行封装一些客户端来包装这些依赖服务的调用。所以，Feign在此基础上做了进一步封装，由他来帮助我们定义和实现依赖服务接口的定义。在Feign的实现下，我们只需创建一个接口并使用注解的方式来配置它（以前是Dao接口上面标注Mapper注解，现在是一个微服务接口上面标注一个Feign注解即可），即可完成对服务提供方的接口绑定，简化了使用Spring cloud Ribbon时，自动封装服务调用客户端的开发量。
3.Feign集成了Ribbon
利用Ribbon维护了Payment的服务列表信息，并且通过轮询实现了客户端的负载均衡。而与Ribbon不同的是，通过feign只需要定义服务绑定接口且以声明式的方法，优雅而简单的实现了服务调用。

3.Feign和OpenFeign两者区别

在这里插入图片描述

二、OpenFeign使用步骤

1.接口+注解

微服务调用接口+@FeignClient

2.新建cloud-consumer-feign-order80

Feign在消费端使用
在这里插入图片描述
3.新建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>mscloud03</artifactId>
        <groupId>com.atguigu.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.atguigu.springcloud</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>${project.version}</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.yml文件

server:
  port: 80

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

5.主启动类

package com.atguigu.springcloud;

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

/**
 * @auther zzyy
 * @create 2020-02-03 11:55
 */
@SpringBootApplication
@EnableFeignClients
public class OrderFeignMain80
{
    public static void main(String[] args)
    {
        SpringApplication.run(OrderFeignMain80.class,args);
    }
}

6.业务类
6.1业务逻辑接口+@FeignClient配置调用provider服务
6.2新建PaymentFeignService接口并新增注解@FeignClient

package com.atguigu.springcloud.service;

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

/**
 * @auther zzyy
 * @create 2020-02-03 12:00
 */
@Component
@FeignClient(value = "CLOUD-PAYMENT-SERVICE")
public interface PaymentFeignService
{
    @GetMapping(value = "/payment/get/{id}")
    CommonResult<Payment> getPaymentById(@PathVariable("id") Long id);
}

6.3控制层Controller

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

7.测试

1.先启动2个eureka集群7001/7002
2.再启动2个微服务8001/8002
3.启动OpenFeign启动
4.测试地址：http://localhost/consumer/payment/get/31
5.Feign自带负载均衡配置项（Feign继承了Ribbon的jar包）

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

三、OpenFeign超时控制

1.超时设置，故意设置超时演示出错情况
1.1服务提供方8001故意写暂停程序（ps：如果是集群8002也需添加此代码，不然访问地址找8002服务时显示找不到页面）

package com.atguigu.springcloud.controller;

import com.atguigu.springcloud.entities.CommonResult;
import com.atguigu.springcloud.entities.Payment;
import com.atguigu.springcloud.service.PaymentService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.web.bind.annotation.*;

import javax.annotation.Resource;
import java.util.List;
import java.util.concurrent.TimeUnit;

/**
 * @auther zzyy
 * @create 2020-01-27 21:17
 */
@RestController
@Slf4j
public class PaymentController
{
    @Value("${server.port}")
    private String serverPort;

    @Resource
    private PaymentService paymentService;

    @Resource
    private DiscoveryClient discoveryClient;

    @PostMapping(value = "/payment/create")
    public CommonResult create(@RequestBody Payment payment)
    {
        int result = paymentService.create(payment);
        log.info("*****插入操作返回结果:" + result);

        if(result > 0)
        {
            return new CommonResult(200,"插入成功,返回结果"+result+"\t 服务端口："+serverPort,payment);
        }else{
            return new CommonResult(444,"插入失败",null);
        }
    }

    @GetMapping(value = "/payment/get/{id}")
    public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id)
    {
        Payment payment = paymentService.getPaymentById(id);
        log.info("*****查询结果:{}",payment);
        if (payment != null) {
            return new CommonResult(200,"查询成功"+"\t 服务端口："+serverPort,payment);
        }else{
            return new CommonResult(444,"没有对应记录,查询ID: "+id,null);
        }
    }

    @GetMapping(value = "/payment/discovery")
    public Object discovery()
    {
        List<String> services = discoveryClient.getServices();
        for (String element : services) {
            System.out.println(element);
        }

        List<ServiceInstance> instances = discoveryClient.getInstances("CLOUD-PAYMENT-SERVICE");
        for (ServiceInstance element : instances) {
            System.out.println(element.getServiceId() + "\t" + element.getHost() + "\t" + element.getPort() + "\t"
                    + element.getUri());
        }
        return this.discoveryClient;
    }

    @GetMapping(value = "/payment/lb")
    public String getPaymentLB()
    {
        System.out.println("*****lb from port: "+serverPort);
        return serverPort;
    }

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

}

1.2服务消费方80添加超时方法PaymentFeignService

 
package com.atguigu.springcloud.service;

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

/**
 * @auther zzyy
 * @create 2020-02-03 12:00
 */
@Component
@FeignClient(value = "CLOUD-PAYMENT-SERVICE")
public interface PaymentFeignService
{
    @GetMapping(value = "/payment/get/{id}")
    CommonResult<Payment> getPaymentById(@PathVariable("id") Long id);

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

1.3服务消费方80添加超时方法OrderFeignController

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

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

1.4测试
1.4.1地址：http://localhost/consumer/payment/feign/timeout
1.4.2错误页面
在这里插入图片描述

2.OpenFeign默认等待1秒钟，超过后报错
3.是什么

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

3.1OpenFeign默认支持Ribbon
在这里插入图片描述

4.YML文件里需要开启OpenFeign客户端超时控制

server:
  port: 80

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日志打印功能

1.日志打印功能
2.是什么

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

3.日志级别

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

4.配置日志bean

 
package com.atguigu.springcloud.cfgbeans;

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

/**
 * @auther zzyy
 * @create 2019-11-10 17:00
 */
@Configuration
public class FeignConfig
{
    @Bean
    Logger.Level feignLoggerLevel()
    {
        return Logger.Level.FULL;
    }
}

5.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

6.后台日志查看
在这里插入图片描述

ps:尚硅谷SpringCloud学习笔记
SpringCloud（第一章 零基础理论入门）
SpringCloud（第二章 从2.2.x和H版开始说起）
SpringCloud（第三章 关于Cloud各种组件的停更/升级/替换）
SpringCloud（第四章 服务架构编码构建）
SpringCloud（第五章 Eureka服务注册与发现）
SpringCloud（第六章 Zookeeper服务注册与发现）
SpringCloud（第七章 Consul服务注册与发现）
SpringCloud（第八章 Ribbon负载均衡服务调用）
SpringCloud（第九章 OpenFeign服务接口调用）
SpringCloud（第十章 Hystrix断路器）
SpringCloud（第十一章 Gateway新一代网关）
SpringCloud（第十二章 SpringCloud Config 分布式配置中心）
SpringCloud（第十三章 SpringCloud Bus 消息总线）
SpringCloud（第十四章 SpringCloud Stream 消息驱动）
SpringCloud（第十五章 SpringCloud Sleuth 分布式请求链路跟踪）
SpringCloud（第十六章 SpringCloud Alibaba 入门简介）
SpringCloud（第十七章 SpringCloud Alibaba Nacos服务注册和配置中心）
SpringCloud（第十八章 SpringCloud Alibaba Sentinel实现熔断与限流）
SpringCloud（第十九章 SpringCloud Alibaba Seata处理分布式事务）
SpringCloud（第二十章 SpringCloud之雪花算法）

懒惰的小白521
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringCloud-OpenFeign服务接口调用及代码
06-01
SpringCloud尚硅谷-OpenFeign服务接口调用及代码
Spring和Hibernate整合操作day-04
qq_35206389的博客
03-22 356
Spring提供了对Hibernate整合支持，支持包spring-orm.jar，提供的主要组件如下： 1.LocalSessionFactoryBean 在Spring容器中创建一个SessionFactory对象。 2.HibernateTemplate 类似于JdbcTemplate，封装了session使用过程。 3.OpenSessionInVi...
Spring-Cloud-OpenFeign使用教程
justlpf的专栏
02-22 191
然后我们讲一下@RequestParam，@RequestParam可以用在Post和Get请求中，但是要注意：@RequestParam 的参数只能是基本类型或者Enum，或者List和Map（List和Map里面也只能是基本类型）。@RequestBody的参数可以包括复杂类型。注意：@SpringQueryMap后面的参数只能是普通的POJO，不能是复合类型，否则解析不了。其中@FeignClient中的value是要调用的服务的注册名，即OpenFeignServer在eureka的注册名。
简单使用openFeign调用第三方接口
最新发布
sad555ssss的博客
03-27 1022
注入配置类用于对请求进行加密、添加鉴权参数等处理，在@FeignClient注解的configuration属性进行配置类指定，一个@FeignClient只能指定一个。ps:升级后如果开启多数据源出现循环引用问题，需要在启动类的@SpringBootApplication注解通过exclude属性指定多数据源配置类禁止。2、在启动类开启扫描feignClient修饰的接口的注解EnableFeignClients指定扫描路径。（2）、接口的返回值必须是指定类型的对象，使用map对象会引起类型不匹配异常。
【SpringCloud组件学习笔记系列】（3）OpenFeign组件
阿莨去爬山了
02-12 308
3、SpringCloud Netflix OpenFeign的使用以及讲解 Feign可以把Rest请求进行隐藏，伪装成类似SpringMVC的Controller一样，不用再自己拼接URL，拼接参数等等操作，Feign可以接管这些并自动完成。 3.1、Feign的使用 3.1.1、依赖引入 在consumer的pom文件中引入： <dependency> <groupId>org.springframework.cloud</groupId> &
浅谈SpringCloud-OpenFeign的配置使用和分析
YOURLIU的博客
05-14 467
浅谈SpringCloud-OpenFeign的配置使用和分析 说明 ​ **Feign是声明性的web服务客户端。**它使编写web服务客户端更加容易。要使用Feign，请创建一个接口并对其进行注释。它具有可插入的注释支持，包括Feign注释和JAX-RS注释。Feign还支持可插拔编码器和解码器。Spring Cloud添加了对Spring MVC注释的支持，并支持使用Spring Web中默认使用的同一HttpMessageConverters。Spring Cloud集成了Ribbon和Eurek
SpringCloud - OpenFeign使用
java123456111的博客
06-06 3082
OpenFeign的使用首先肯定得依赖Spring Cloud，作为Alibaba微服务架构，以下依赖必不可少。 2、消费端开启Feign服务调用 在订单服务（dt-order-service）启动器上开启Feign的服务调用，以此来调用库存服务端的接口方法。 @EnableFeignClients ：开启服务调用 在默认情况下，OpenFeign默认的日志是关闭的，在我们开发过程中，需要调试接口，或者看看调用性能，就需要配置OpenFeign的日志，把OpenFeign的调用日志清晰的打印出来，方
SpringCloud——OpenFeign详解
weixin_50616848的博客
05-02 7931
目录 一、OpenFeign介绍 1、概念 2、作用 3、架构图 二、OpenFeign案例 1、案例说明 2、搭建Eureka服务端 （1）创建maven工程 （2）导入依赖 （3）配置application.yml （4）创建主启动类 （5）启动Eureka注册中心 3、搭建服务提供者Provider80 （1）创建maven工程 （2）导入依赖 （3）配置application.yml （4）创建启动类 （5）创建controller ......
SpringCloud全家桶---OpenFeign
自律使我自由
11-16 831
1、SpringCloud全家桶—注册中心Eureka搭建 2、SpringCloud全家桶—注册中心Eureka高可用环境搭建 3、SpringCloud全家桶—客户端负载均衡Ribbon 4、SpringCloud全家桶—OpenFeign OpenFeign OpenFeign是一种声明式、模板化的HTTP请求，相比前面我们使用RestTemplate的方式，OpenFeign能够更加的便捷、优雅的完成微服务之间的HTTP调用。 OpenFeign的使用也非常简单，通过注解的方式即可完成，使调用者感觉
spring-cloud-starter-openfeign使用详解
热门推荐
若鱼的专栏
09-15 1万+
首先还是把demo跑起来： 添加依赖 <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency> 添加注解 @SpringBootApplication @EnableFeignClients//添加这个注解 public c
SpringCloud-feign详解
落雪
05-10 1万+
springcloud-feign学习
SpringCloud OpenFeign 全功能配置详解（一文吃透OpenFeign）
kerwin的博客
08-28 1万+
SpringCloud OpenFeign 全功能配置详解（一文吃透OpenFeign），会对部分OpenFeign源码解析，也会对OpenFeign中的坑做说明
Springcloud基于OpenFeign实现服务调用代码实例
08-24
主要介绍了Springcloud基于OpenFeign实现服务调用代码实例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
springcloud同时整合dubbo与openfeign
05-20
案例代码为springcloud-libaba整合dubbo同时也整合了openfeign，消费方可以通过两种方式调用服务提供方的接口，代码下载后简单修改下数据库链接可以直接运行起来，如果运行时有任何问题可以私信我；
Spring Cloud OpenFeign 远程调用
11-25
Spring Cloud OpenFeign 可以做到 让我们在使用 HTTP 请求远程服务时，就像调用本地方法一样。OpenFeign 和 Dubbo一样是一个RPC远程调用框架，目的是使的我们调用接口和调用本地方法一样简单，开发者无需关心和远程...
SpringCloud 服务负载均衡和调用 Ribbon、OpenFeign的方法
09-07
主要介绍了SpringCloud 服务负载均衡和调用 Ribbon、OpenFeign的方法,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
openfeign的使用
翎墨袅
10-16 670
OpenFeign
SpringCloud组件之Spring-cloud-start-openfegin
LCLYY09的博客
03-16 945
springCloud 组件 fegin
spring-cloud之openfeign学习
weixin_50519232的博客
08-10 901
对spring-cloud的OpenFeign的基础学习
springcloud openfeign 调用别的服务中的方法
05-30
在Spring Cloud中使用OpenFeign调用别的服务中的方法非常容易，只需要按照以下步骤进行操作： 1.添加依赖 首先在pom.xml文件中添加OpenFeign依赖： ```xml <groupId>org.springframework.cloud <artifactId>...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值