SpringCloud学习笔记之OpenFeign进行服务调用

目录
  • 前言
  • 1、OpenFeign
    • 1.1、OpenFeign概述
    • 1.2、OpenFeign的使用步骤
    • 1.3、超时控制
      • 1.3.1、是什么?
      • 1.3.2、修改代码设置超时错误
      • 1.3.3、进行超时配置
    • 1.4、日志打印
      • 1.4.1、是什么?
      • 1.4.2、日志级别
      • 1.4.3、如何开启日志打印
  • 总结

前言

Feign是一个声明式的Web服务客户端,是面向接口编程的。也就是说使用Feign,只需要创建一个接口并使用注解方式配置它,就可以完成对微服务提供方的接口绑定。

在使用RestTemplate时,每次调用服务都需要指定服务的具体路径,当在多个地方同时使用时要写多次,显得代码冗余也难以维护,而openfeign就可以避免这种操作。

1、OpenFeign

1.1、OpenFeign概述

1. 是什么?

Feign是一个声明式的web服务客户端,让编写web服务客户端变得非常容易,只需创建一个接口并在接口上添加注解即可。

源码地址

2. 能干嘛?

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

3. Feign和OpenFeign的区别

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

1.2、OpenFeign的使用步骤

1. 建Module

Module的名称为cloud-consumer-feign-order80。

2. 改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>cloud02</artifactId>
        <groupId>com.xiao</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-consumer-feign-order80</artifactId>

    <!--openfeign-->
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>com.xiao</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>1.0-SNAPSHOT</version>
        </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.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. 改YML

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

4. 主启动

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

@SpringBootApplication
@EnableFeignClients 		//开启OpenFeign
public class OrderFeignMain80 {
    public static void main(String[] args) {
        SpringApplication.run(OrderFeignMain80.class,args);
    }
}

@EnableFeignClients开启OpenFeign

5. PaymentFeignService接口

import com.xiao.cloud.entities.CommonResult;
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")  // 使用OpenFeign
public interface PaymentFeignService {

    @GetMapping("/payment/get/{id}")
    public CommonResult getPaymentById(@PathVariable("id") Long id);
}

@FeignClient(value = "CLOUD-PAYMENT-SERVICE")使用OpenFeign。

6. Controller类

import com.xiao.cloud.entities.CommonResult;
import com.xiao.cloud.entities.Payment;
import com.xiao.cloud.service.PaymentFeignService;
import lombok.extern.slf4j.Slf4j;
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.RestController;

@RestController
@Slf4j
public class PaymentFeignController {

    @Autowired
    private PaymentFeignService paymentFeignService;

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

7. 测试结果

当我们多次点击刷新时,端口在8001和8002之间依次变化。

8. 小总结

1.3、超时控制

1.3.1、是什么?

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

在yml文件中开启配置。

1.3.2、修改代码设置超时错误

1. 修改支付模块8001的Controller

添加以下代码

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

2. 修改订单模块的PaymentFeignService

添加以下代码

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

3. 修改订单模块的OrderFeignController

添加以下代码

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

4. 测试结果

直接对支付模块8001的暴露的服务接口进行调用,测验通过

如果通过订单模块进行调用,那么就会报超时错误

1.3.3、进行超时配置

在订单模块的YML文件中添加以下代码

ribbon:
  ReadTimeout:  8000
  ConnectTimeout: 8000

1. 测试结果

自测通过

1.4、日志打印

1.4.1、是什么?

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

1.4.2、日志级别

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

1.4.3、如何开启日志打印

1. 编写日志配置类

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

@Configuration
public class FeignConfig {

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

2. 在YML文件中进行相关配置

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

ribbon:
  ReadTimeout:  8000
  ConnectTimeout: 8000

logging:
  level:
    com.atguigu.springcloud.service.PaymentFeignService: debug

3. 测试结果

4. 包结构图示

总结

到此这篇关于SpringCloud学习笔记之OpenFeign进行服务调用的文章就介绍到这了,更多相关SpringCloud OpenFeign服务调用内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

时间: 2022-01-11

Springcloud基于OpenFeign实现服务调用代码实例

1.依赖 <!--引入open feign依赖--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency> </dependencies> 2.启动注解 @SpringBootApplication @Enabl

详解SpringCloud-OpenFeign组件的使用

思考: 使用RestTemplate+ribbon已经可以完成服务间的调用,为什么还要使用feign? String restTemplateForObject = restTemplate.getForObject("http://服务名/url?参数" + name, String.class); 存在问题: 1.每次调用服务都需要写这些代码,存在大量的代码冗余 2.服务地址如果修改,维护成本增高 3.使用时不够灵活 说明 https://cloud.spring.io/sprin

Spring Cloud 系列之服务调用 OpenFeign的实现

1.1 简介 1.1.1 概述   Feign 旨在使编写 Java Http 客户端变得更容易.在使用 Ribbon + RestTemplate 时,利用 RestTemplate 对 http 请求的封装处理,形成了一套模版化的调用方法.但是在实际开发中,由于对服务依赖的调用可能不止一处,往往一个接口会被多处调用,所以通常都会针对每个微服务自行封装一些客户端类来包装这些依赖服务的调用.所以,Feign 在 Ribbon 基础上做了进一步封装,由他来帮助我们定义和实现依赖服务接口的定义.在

spring cloud openfeign 源码实例解析

一.读取注解信息 入口 import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.openfeign.EnableFeignClients; @SpringBootApplication @EnableFeignClients public class

SpringCloud OpenFeign Post请求400错误解决方案

在微服务开发中SpringCloud全家桶集成了OpenFeign用于服务调用,SpringCloud的OpenFeign使用SpringMVCContract来解析OpenFeign的接口定义. 但是SpringMVCContract的Post接口解析实现有个巨坑,就是如果使用的是@RequestParam传参的Post请求,参数是直接挂在URL上的. 问题发现与分析 最近线上服务器突然经常性出现CPU高负载的预警,经过排查发现日志出来了大量的OpenFeign跨服务调用出现400的错误(HT

SpringMVC表单提交参数400错误解决方案

SpringMVC下,提交表单报400错: description The request sent by the client was syntactically incorrect. 根据网上的总结,可能是因为如下几个问题引起的 1.参数指定问题 如果Controller中定义了参数,而表单内却没有定义该字段 @SuppressWarnings("deprecation") @RequestMapping("/hello.do") public String h

Linux服务器nginx访问日志里出现大量http 400错误的请求分析

服务器中的错误记录类似于这种: 124.65.133.242 – – [27/Oct/2014:14:30:51 +0800] "-" 400 0 "-" "-" 124.65.133.242 – – [27/Oct/2014:14:31:45 +0800] "-" 400 0 "-" "-" 124.65.133.242 – – [27/Oct/2014:14:31:45 +0800]

SQL Server 2005 DTS导入平面数据出现错误解决方案

SQL Server 2005 DTS导入平面数据源时,总是被截断,无法执行的错误解决方案 1 典型的错误信息如下: 消息 * 错误 0xc02020a1: 数据流任务: 数据转换失败.列"列 2"的数据转换返回状态值 4 和状态文本"文本被截断,或者一个或多个字符在目标代码页中没有匹配项.". (SQL Server 导入和导出向导) * 错误 0xc020902a: 数据流任务: "输出列"列 2"(18)"由于发生截断而

Jquery uploadify 多余的Get请求(404错误)的解决方法

在使用jquery uploadify时如果不设置button_image_url参数,就会出现一些多余的get请求,甚至报404的错误,这是该插件的一个bug,官方给出的解决方案如下: 找到如下代码: this.settings.upload_url = SWFUpload.completeURL(this.settings.upload_url); this.settings.button_image_url = SWFUpload.completeURL(this.settings.but

解决SpringMVC使用@RequestBody注解报400错误的问题

一般使用@RequestBody接收的时候报400都是传入的json字符串和对应封装的对象不对应造成的 首先要注意 封装的对象中的字段类型有没有Date类型或者int等类型的,如果有的话,在set方法中统一将传入的参数要调整为String类型 在set方法中进行参数的转换 比如有一个Date类型的字段 private Date startTime; public Date getStartTime() { return startTime; } public void setStartTime(

如何解决:正常安装php后,出现http 400错误

在远程安装php时,php的自动安装包有时会出错,php.ini并不在windows目录中,因此会出现 http 400错误,这种情况下,可以查找硬盘,找到php.ini,将它复制到windows目录中,就会正常.

2016最新CocoaPods安装和错误解决方案

CocoaPods是什么? CocoaPods是一个负责管理iOS项目中第三方开源库的工具.CocoaPods的项目源码在Github上管理.该项目开始于2011年8月12日,在这两年多的时间里,它持续保持活跃更新.开发iOS项目不可避免地要使用第三方开源库,CocoaPods的出现使得我们可以节省设置和更新第三方开源库的时间,在iOS开发中经常会用到第三方库如AFNetworking,ASIHttpRequest等,在使用第三方库时,你除了要导数源码外,但是,集成这些依赖库需要我们手动去配置,

Android模拟器安装APP出现INSTALL_FAILED_NO_MATCHING_ABIS错误解决方案

 Android模拟器安装APP出现INSTALL_FAILED_NO_MATCHING_ABIS错误解决方案 当我们想在电脑的Android模拟器中安装APP的时候,会报INSTALL_FAILED_NO_MATCHING_ABIS错误[如图1],导致APP无法在模拟器中运行.下面给出我的解决方案,希望能对你有所帮助! Android模拟器下安装APP报INSTALL_FAILED_NO_MATCHING_ABIS错误解决方案 [图1]adb install 命令安装APP 原因分析: 由于安

在LayUI图片上传中,解决由跨域问题引起的请求接口错误的方法

在LayUI图片上传中,解决由跨域问题引起的请求接口错误的方法 在ssm框架整合中,使用layui作为前端页面,拖拽图片上传,填写接口后,后台能够成功接收到数据,但由于页面资源和后台访问地址的不一致(即使域名一致但端口不一致)引起跨域问题,导致接收资源后在前端无法接收到后台返回的数据. 前台页面: <html> <head> <meta charset="UTF-8"> <title>校园网络打印</title> <li