【微服务】- SpringCloud整合OpenFeign及OpenFeign简单使用_普通网友的博客-程序员宝宝

技术标签: java  后端  

文章目录

简介

位置:https://cloud.spring.io/spring-cloud-openfeign/2.2.x/reference/html/

Feign是一个声明式WebService客户端。 使用Feign能让编写Web Service客户端更加简单。

它的使用方法是定义一个服务接口然后在上面添加注解。Feign也支 持可拔插式的编码器和解码器。Spring Cloud对Feign进行了封装使其支持了Spring MVC标准注解和HttpMessageConverters。Feign可以与Eureka和Ribbon组合使用以支持负载均衡。

图片

概述

feign是一个声明式web服务客户端,让编写web客户服务端变得非常简单。只需要创建一个接口并在接口添加注解即可。

Feign的作用

Feign旨在使编写Java Http客户端变得更容易。

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

Feign集成了Ribbon

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

Feign和OpenFeign的区别

图片

SpringCloud集成OpenFeign

1.先准备测试用到的服务集群和Eureka集群

图片

Eureka是服务注册中心就不多说。8081和8082服务是两个功能相同的项目,是一个服务集群,因为OpenFeign代替了Ribbon + RestTemplate的工作,故说明OpenFeign带有Ribbon的依赖可以实现负载均衡。服务集群的功能很简单,就是从数据库中根据id进行查询。

2.新建OpenFeign项目(空maven项目)

cloud-consumer-feign-order80

3.添加依赖

<dependencies>
    <dependency>
        <groupId>wf.springcloud</groupId>
        <artifactId>cloud-api-commons</artifactId>
        <version>1.0-SNAPSHOT</version>
        <scope>compile</scope>
    </dependency>
    <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.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    <!--   引入eureka客户端     -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>
    <!--  open feign      -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>
</dependencies>

4.添加配置文件(application.yml)

server:
  port: 80

eureka:
  client:
    register-with-eureka: false   #是否将自己注册到注册中心,集群必须设置为true配合ribbon
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka, http://eureka7002.com:7002/eureka

5.写主启动类

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

注意@EnableFeignClients注解不能少,这表明在该服务中使用了OpenFeign。

6.写service层

上面说过OpenFeign代替了Ribbon + RestTemplate的工作,即它还要承担RestTemplate,而在OpenFeign中的代替方案就是建一个,接口并使用注解的方式来配置它。类似于SpringBoot项目中Dao层的工作。从其他地方查询数据。不过此处项目小故用service来代替。

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

接口中的方法其实就是要调用服务的controller层的类接口的形式。下面是服务层的controller

@RestController
@Slf4j
public class PaymentController {
    @Resource
    private PaymentService paymentService;
    @Value("${server.port}")
    private String serverport;
    @GetMapping(value = "/payment/get/{id}")
    public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id){
        Payment result = paymentService.getPaymentById(id);
        log.info("查询结果:" + result);
        if (result != null){
            return new CommonResult<Payment>(200,"查询成功! port:" + serverport,result);
        }else {
            return new CommonResult<Payment>(444,"查询失败!",null);
        }
    }
}

此处就表明了OpenFeign中的一个特性支持SpringMVC的注解。
要注意的是服务层@GetMapping(value = “/payment/get/{id}”)是controller中url的全拼,此处没在PaymentController类上没加类似@RequestMapping(value = “/xx”)。故conroller中的@GetMapping(value = “/payment/get/{id}”)与service中的相同。

如果在类中加相关mapping如

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

那么在service中的@GetMapping的值就是/a/b。而不是直接和方法上@GetMapping相同的/b。
如果写成/b回报

feign.FeignException$NotFound: status 404 reading PaymentFeignService#getPay

错误找不到相关方法。

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

就像普通项目中调用service就可完成需要的功能。

8.测试结果

访问http://localhost/consumer/payment/get/5

图片

图片

可以看到负载均衡起作用了。

9.总结

图片

OpenFeign的超时控制

OpenFeign默认调用的服务超时时间为1s,如果超过会报错

下面是演示:

1.在8081和8082中添加一个超时的方法

@GetMapping(value = "/payment/feign/timeout")
public String paymentFeignTimeout(){
    try {
        Thread.sleep(3000);
    } catch (InterruptedException e) {
        e.printStackTrace();
    }
    return serverport;
}

2.在Feign的服务中添加相关方法

在service的接口中添加

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

在controller中添加

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

此时启动项目服务,访问http://localhost/consumer/payment/feign/timeout会出现

This application has no explicit mapping for /error, so you are seeing this as a fallback.
Fri Apr 10 22:52:28 CST 2020
There was an unexpected error (type=Internal Server Error, status=500).
Read timed out executing GET http://CLOUD-PAYMENT-SERVICE/payment/feign/timeout
feign.RetryableException: Read timed out executing GET http://CLOUD-PAYMENT-SERVICE/payment/feign/timeout
	at feign.FeignException.errorExecuting(FeignException.java:213)
	at feign.SynchronousMethodHandler.executeAndDecode(SynchronousMethodHandler.java:115)
...

超时错误。想要对Feign的超时进行控制只需要在yml文件添加相关配置即可

对feign的超时控制

在application.yml添加

server:
  port: 80

eureka:
  client:
    register-with-eureka: false   #是否将自己注册到注册中心,集群必须设置为true配合ribbon
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka, http://eureka7002.com:7002/eureka
#设置feign客户端超时时间(openFeign默认支持ribbon)
ribbon:
  #指的是建立连接所用的时间,适用于网络状况iE常的情况下两端连接所用的时间
  ReadTimeout: 5000
  #指的是建立连接后从服务器读取到可用资源所用的时间
  ConnectTimeout: 5000

启动项目会发现,超时错误消失。程序可以正常访问。

OpenFeign的日志打印功能

是什么

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

2.OpenFeign的日志级别

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

3.如何启用日志打印功能

1.添加配置类

import feign.Logger;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
 * @Description TODO
 * @Author gyhdx
 * @Date 2020/4/10 23:05
 */
@Configuration
public class FeignConfig {
    @Bean
    Logger.Level feignLoggerLevel(){
        return Logger.Level.FULL;
    }
}

注意此处的Logger要使用feign中的。
2.在yml文件中添加相关配置

logging:
  level:
    # feign日志以什么级别监控哪个接口
    wf.springcloud.service.PaymentFeignService: debug

注意添加成功后都是蓝颜色的除了debug
图片

3.访问PaymentFeignService接口中存在的方法

图片

配置成功

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/m0_67391401/article/details/123828977

智能推荐

VRAM_plcsy的博客-程序员宝宝

Video Random Access Memory:显存,显卡上的随机存取存储器.是一种双端口内存,它允许在同一时间被所有硬件(包括中央处理器、显示芯片等)访问。它比EDO DRAM快20%左右.但它的价格也是比较高的.它适用于高色深、高分辨率的显频设备。使用VRAM的显示芯片有S3、968、S3 ViRGE/VX等。

GetPixel() 获取鼠标点击处颜色_Enginepedia的博客-程序员宝宝_getpixel类获取color对象

<br /><br />最近在做一个项目,项目中用到如何实时绘制曲线,同时要求鼠标点击处要判断该点是否在曲线上,在网上搜了些相关的资料,在这里非常感谢那些有心人!最后找到了一个方法,具体实现见下,希望对大家有些帮助:<br />void CGetPixelColorView::OnDraw(CDC* pDC)<br />{<br />     CGetPixelColorDoc* pDoc = GetDocument();<br />     ASSERT_VALID(pDoc);<br />     //

CSDN的Markdown编辑器如何添加空格_xiaotao_1的博客-程序员宝宝_markdown在线编辑器空格怎么打

把输入法切换到全角模式下(一般的中文输入法都是按 shift + space),然后输入两个空格就行了。这篇博客的空格就是这样打出来的。

输入圆的半径输出圆的面积和周长python_那用c语言编写一个程序从键盘输入圆的半径计算该圆的周长面积。并输出C语言编写一程序,输入一个圆的..._weixin_39757122的博客-程序员宝宝

那用c语言编写一个程序从键盘输入圆的半径计算该圆的周长面积。并输出 C语言编写一程序,输入一个圆的www.zhiqu.org 时间: 2020-12-07#includevoid main(){float r; //半径printf("请输入圆的半径: ");scanf("%f",&amp;r);printf("圆的周长是: %f",(2*3.14*r));//求出圆周长pri...

c语言计算机二级考试内容,2018年全国计算机二级C语言考试考什么内容_小七不要胖的博客-程序员宝宝

  根据《全国计算机等级考试二级c语言程序设计考试大纲(2018年版)》得知,全国计算机二级c语言考试内容主要包括:C 语言程序的结构、数据类型及其运算、基本语句等12个内容。考试形式为上机考试,考试时长120分钟,满分100分。具体内容如下:  考试内容  一、C 语言程序的结构  1. 程序的构成,main 函数和其他函数。  2. 头文件,数据说明,函数的开始和结束标志以及程序中的注释。  ...

QT每日一练day25:触发绘画事件_笑鸿的学习笔记的博客-程序员宝宝

运行结果(GIF动图):widget.cpp附代码:xiaowen_QT_day25.proQT += core guigreaterThan(QT_MAJOR_VERSION, 4): QT += widgetsCONFIG += c++11# The following define makes your compiler emit warnings if you use# any Qt feature that has been marked deprecated

随便推点

Css min-width max-width 使用方法_Hotice888的博客-程序员宝宝_min-width max-width

CSS宽度属性为单词width,宽度width包含了两个重要的属性:最大宽度属性max-width和最小宽度属性min-width。最大宽度属性(max-width)用来定义宽度显示的最大值,当拖动浏览器边框使其显示范围大于最大宽度的时候,元素显示最大宽度值定义的宽度。在最大宽度属性值中,可以使用三种属性值,分别为auto值、长度值和百分比值;最小宽度属性(min-width)用来定义宽度显...

android解析jpeg图像的过程_晓鱼弋弋的博客-程序员宝宝_android jpg解析head

JPEG图像的解析过程。解析JPEG的maker,EXIF是其中的一个maker。之后对exif进行解析。

2019多校第二场:I Love Palindrome String (回文树)_GoldenFingers的博客-程序员宝宝_i love counting题解

题目链接:http://acm.hdu.edu.cn/showproblem.php?pid=6599解题心得:其实看到这个回文串计数问题就该想到回文树,用回文树得到每一个相同种类回文串的数量,在hashhashhash或者manachmanachmanach判断一下是否前一半也是回文串就行了。比赛的时候这么多人都会回文树也tql吧,都是些什么神仙啊,气馁。#include &lt...

openGL学习笔记二十五: 纹理循环滚动--纹理矩阵高效实现_哲学的天空的博客-程序员宝宝_纹理 循环方式

  纹理循环滚动在cpu上进行计算效率并不高,可以通过纹理矩阵把这个过程搬到GPU中执行。纹理矩阵 :  采用纹理矩阵 改变纹理滚动 缩放 平移效果。,在opengl pc版中有,在opengles 中没有。代码如下://顶点数据struct Vertex { float x, y, z; float u, v;};//纹理IDGLuint _texture;float ...

vue中使用自己定义的js,并注册为全局的_ColourfulTiger的博客-程序员宝宝

在使用vue的时候少不了要写自己的js,但是自己的js怎样才能被定义为全局的,供众多的文件使用呢?方法如下:第一种情况:在main.js中引入,并在其中使用。1、写好自己的js文件,并放置在src文件下用一个目录api来封装。2、在main.js文件中引入这个js的路径,然后在将其设置成一个单独的变量,用的时候通过变量来调用。import { x1,x2,x3}  from  'j...

C++模板编程实现二维数组_疯狂-的-蜗牛的博客-程序员宝宝_c++ 模板二维数组

数组在C语言里面经常使用,有一个缺陷就是必须在定义的时候就指定大小,一旦申请后这片区域就不能动态的扩展。但是很多情况下我们并不知道大小是多少,于是就需要动态分配内存来存储。这里仅仅是一个小例,希望可以起到抛砖引玉的作用。为什么使用模板?使用模板的通用性很强,数组可能是int类型,也可能是bool类型……,使用模板就避免了为每一种类型去量身定制一套相同的功能。我想,这也是C++模板的初衷吧。

推荐文章

热门文章

相关标签