SpringCloud调用组件Feign

简介: 本文深入探讨微服务Spring体系中的Feign组件。Feign是一个声明式Web服务客户端,支持注解、编码器/解码器,与Spring MVC注解兼容,并集成Eureka、负载均衡等功能。文章详细介绍了SpringCloud整合Feign的步骤,包括依赖引入、客户端启用、接口创建及调用示例。同时,还涵盖了Feign的核心配置,如超时设置、拦截器实现(Basic认证与自定义)和日志级别调整。最后,总结了`@FeignClient`常用属性,帮助开发者更好地理解和使用Feign进行微服务间通信。

前言

本系列带着大家深入微服务 Spring体系的各个框架的底层原理。上一篇文章介绍了SpringBoot自动装配原理,本节将带着大家熟悉下SpringCloud体系的调用组件Feign


Feign是什么

  • Feign是一个声明式 Web 服务客户端。它使编写 Web 服务客户端更容易
  • 它具有可插入的注解支持,包括 Feign 注解和 JAX-RS 注解
  • Feign 还支持可插拔的编码器和解码器
  • 对 Spring MVC 注解的支持,并支持使用HttpMessageConvertersSpring Web 中默认使用的注解
  • Spring Cloud 集成了 Eureka、Spring Cloud CircuitBreaker 以及 Spring Cloud LoadBalancer,使用 Feign 时提供负载均衡的 http 客户端

SpringCloud整合Feign

加入pom依赖

xml

代码解读

复制代码

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

启用Feign客户端

java

代码解读

复制代码

@SpringBootApplication
@EnableFeignClients
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

创建一个 Spring Cloud LoadBalancer client

java

代码解读

复制代码

@FeignClient("demo")
public interface DemoFeignClient {
    @RequestMapping(method = RequestMethod.GET, value = "/getDemo")
    DemoDTO getDemo();
}

rpc调用client

java

代码解读

复制代码

@RestController
@RequestMapping("/remote")
public class RemoteService {

    @Autowired
    DemoFeignClient demoFeignClient;

    @RequestMapping(value = "/getRemoteDemo")
    public DemoDTO   getRemoteDemo() {
        DemoDTO  result = demoFeignClient.getDemo();
        return result;
    }
}

Feign 核心配置

超时配置

相关配置解释:

connectTimeout :建立连接所用的超时时间

readTimeout :从连接建立时开始,并在返回响应的时间

1)针对feign配置

yaml

代码解读

复制代码

feign:
    client:
        config:
            feignName:
                connectTimeout: 5000
                readTimeout: 5000

2)通用配置

yaml

代码解读

复制代码

feign:
    client:
        config:
            default:
                connectTimeout: 5000
                readTimeout: 5000

拦截器配置

可以使用feign的拦截器功能实现接口的验证、鉴权功能

1)Basic认证

java

代码解读

复制代码

@Configuration
public class DemoFeignConfiguration {
    @Bean
    public BasicAuthRequestInterceptor basicAuthRequestInterceptor() {
        return new BasicAuthRequestInterceptor("user", "password");
    }
}

2)自定义拦截器实现 需要实现接口RequestInterceptor

java

代码解读

复制代码

public interface RequestInterceptor {

  /**
   * Called for every request. Add data using methods on the supplied {@link RequestTemplate}.
   */
  void apply(RequestTemplate template);
}

2.1)请求头放上TOKEN认证信息

java

代码解读

复制代码

public class UserInfoRequestInterceptor implements RequestInterceptor {

    public void apply(RequestTemplate template) {
        template.header("USER-INFO", "TOKEN");
    }
}

2.2)将配置添加到feign

yaml

代码解读

复制代码

feign:
    client:
        config:
            feignName:
                connectTimeout: 5000
                readTimeout: 5000
                requestInterceptors:
                    - com.example.UserInfoRequestInterceptor

日志配置

Feign使用过程中需要打印日志可以实现Fegin的Logger功能,可以打印http的调用链路用于功能调试。

1)Logger.Level 级别:

  • NONE,无日志记录(默认)
  • BASIC, 只记录请求方法和 URL 以及响应状态码和执行时间。
  • HEADERS,记录基本信息以及请求和响应标头
  • FULL, 记录请求和响应的标头、正文和元数据

2)配置 2.1) yaml配置

yaml

代码解读

复制代码

logging:
  level:
    com.example.feign.DemoFeign: debug

2.2) Config配置

java

代码解读

复制代码

@Configuration
public class FeignConfiguration {
    @Bean
    Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL;
    }
}

@FeignClient 常用属性

  • name:指定FeignClient的名称
  • url:指定@FeignClient调用的地址,可用于线上调试
  • configuration: Feign配置类
  • fallback: 请求错误回调的处理类
  • path: 指定FeignClient的统一前缀


转载来源:https://juejin.cn/post/7082989163053580295

相关文章
|
2月前
|
负载均衡 Java Nacos
Spring Cloud五大组件
Spring Cloud五大组件
|
6月前
|
监控 负载均衡 Java
5 大 SpringCloud 核心组件详解,8 张图彻底弄懂
本文图文详解 Spring Cloud 的五大核心组件,帮助深入理解和掌握微服务架构。关注【mikechen的互联网架构】,10年+BAT架构经验倾囊相授。
5 大 SpringCloud 核心组件详解,8 张图彻底弄懂
|
6月前
|
负载均衡 算法 Java
除了 Ribbon,Spring Cloud 中还有哪些负载均衡组件?
这些负载均衡组件各有特点,在不同的场景和需求下,可以根据项目的具体情况选择合适的负载均衡组件来实现高效、稳定的服务调用。
442 5
|
7月前
|
JSON Java 数据格式
【微服务】SpringCloud之Feign远程调用
本文介绍了使用Feign作为HTTP客户端替代RestTemplate进行远程调用的优势及具体使用方法。Feign通过声明式接口简化了HTTP请求的发送,提高了代码的可读性和维护性。文章详细描述了Feign的搭建步骤,包括引入依赖、添加注解、编写FeignClient接口和调用代码,并提供了自定义配置的示例,如修改日志级别等。
319 1
|
8月前
|
负载均衡 Java Nacos
SpringCloud基础2——Nacos配置、Feign、Gateway
nacos配置管理、Feign远程调用、Gateway服务网关
SpringCloud基础2——Nacos配置、Feign、Gateway
|
8月前
|
前端开发 API 微服务
SpringCloud微服务之间使用Feign调用不通情况举例
SpringCloud微服务之间使用Feign调用不通情况举例
920 2
|
9月前
|
负载均衡 监控 Java
SpringCloud常见面试题(一):SpringCloud 5大组件,服务注册和发现,nacos与eureka区别,服务雪崩、服务熔断、服务降级,微服务监控
SpringCloud常见面试题(一):SpringCloud 5大组件,服务注册和发现,nacos与eureka区别,服务雪崩、服务熔断、服务降级,微服务监控
16507 6
SpringCloud常见面试题(一):SpringCloud 5大组件,服务注册和发现,nacos与eureka区别,服务雪崩、服务熔断、服务降级,微服务监控
|
8月前
|
Java API 开发者
【已解决】Spring Cloud Feign 上传文件,提示:the request was rejected because no multipart boundary was found的问题
【已解决】Spring Cloud Feign 上传文件,提示:the request was rejected because no multipart boundary was found的问题
1197 0
|
10月前
|
监控 Java 应用服务中间件
SpringCloud面试之流量控制组件Sentinel详解
SpringCloud面试之流量控制组件Sentinel详解
441 0
|
11月前
|
负载均衡 前端开发 Java
OpenFeign:Spring Cloud声明式服务调用组件
该文本是关于OpenFeign在Spring Cloud中的使用的问答总结。涉及的问题包括:OpenFeign是什么,Feign与OpenFeign的区别,如何使用OpenFeign进行远程服务调用,OpenFeign的超时控制以及日志增强。OpenFeign被描述为Spring官方的声明式服务调用和负载均衡组件,它支持使用注解进行接口定义和服务调用,如@FeignClient和@EnableFeignClients。OpenFeign与Feign的主要区别在于OpenFeign支持Spring MVC注解。超时控制通过Ribbon进行设置,默认超时时间为1秒。
106 1