SpringCloud-Feign组件小坑

本文详细介绍了在使用SpringCloud-Feign组件时可能遇到的小坑,包括@PathVariable的value属性必要性,配置类的位置与作用,@FeignClient注解的name和url属性,以及如何处理类级别的@RequestMapping注解。此外,还讨论了如何开启Hystrix监控并暴露hystrix.stream端点。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

SpringCloud-Feign组件小坑

  1. FeignClient接口如使用@PathVariable ,必须指定value属性
    代码示例:
@FeignClient("login-server")
public interface UserFeignClient {
    @GetMapping(value = "/getInfo/{id}")
    public User getInfo(@PathVariable("id") Long id);
}

在一些早期版本中, @PathVariable(“id”) 中的 “id” ,也就是value属性,必须指定,不能省略。

  1. Java代码自定义Feign Client的注意点与坑
    代码示例:
@FeignClient(name = "login-server", configuration = UserFeignConfig.class)
public interface UserFeignClient {
  @GetMapping("/users/{id}")
  User findById(@PathVariable("id") Long id);
}

/**

  • 该Feign Client的配置类,注意:

    1. 该类可以独立出去;
    1. 该类上也可添加@Configuration声明是一个配置类;
  • 配置类上也可添加@Configuration注解,声明这是一个配置类;

  • 但此时千万别将该放置在主应用程序上下文@ComponentScan所扫描的包中,

  • 否则,该配置将会被所有Feign Client共享,无法实现细粒度配置!

  • 个人建议:像我一样,不加@Configuration注解
    *
    */

    class UserFeignConfig {
    @Bean
    public Logger.Level logger() {
    return Logger.Level.FULL;
     }
    }
    

    配置类上也可添加@Configuraiton 注解,声明这是一个配置类;但此时千万别将该放置在主应用程序上下文@ComponentScan 所扫描的包中,否则,该配置将会被所有Feign Client共享(相当于变成了通用配置,其实本质还是Spring父子上下文扫描包重叠导致的问题),无法实现细粒度配置!

个人建议:像我一样,不加@Configuration注解,省得进坑,直接再。

最佳实践:尽量用配置属性自定义Feign的配置!!

  1. @FeignClient 注解属性
    @FeignClient(name = “login-server”)
    在早期的Spring Cloud版本中,无需提供name属性,从Brixton版开始,@FeignClient必须提供name属性,否则应用将无法正常启动!

name属性:可以用value属性代替,因为name别名就是value(下面有@FeignClient注解源码)

url属性:若生产者项目没有配置context-path,消费者写Feign时可不加url属性

/**
	 * @return The service id with optional protocol prefix. Synonym for {@link #value()
	 * value}.
	 */
	@AliasFor("value")
	String name() default "";

另外,name、url等属性支持占位符。例如:

@FeignClient(name = “ f e i g n . n a m e " , u r l = " {feign.name}", url = " feign.name",url="{feign.url}”)

  1. 类级别的@RequestMapping会被Spring MVC加载

    @RequestMapping("/users")
    @FeignClient(name = "microservice-user")
    public class TestFeignClient {
     // ...
    }
    

    类上的@RequestMapping 注解也会被Spring MVC加载。该问题现已经被解决,早期的版本有两种解决方案:

方案1:不在类上加@RequestMapping 注解;

方案2:添加如下代码:

@Configuration
@ConditionalOnClass({ Feign.class })
public class FeignMappingDefaultConfiguration {
@Bean
public WebMvcRegistrations feignWebRegistrations() {
return new WebMvcRegistrationsAdapter() {
@Override
public RequestMappingHandlerMapping getRequestMappingHandlerMapping() {
return new FeignFilterRequestMappingHandlerMapping();
}
};
}

private static class FeignFilterRequestMappingHandlerMapping extends RequestMappingHandlerMapping {
    @Override
    protected boolean isHandler(Class<?> beanType) {
        return super.isHandler(beanType) && !beanType.isInterface();
   }

}
}

  1. 如需产生Hystrix Stream监控信息,需要做一些额外操作
    Feign本身已经整合了Hystrix,可直接使用@FeignClient(value = “login-server”, fallback = XXX.class) 来指定fallback类,fallback类继承@FeignClient所标注的接口即可。

但是假设如需使用Hystrix Stream进行监控,默认情况下,访问http://IP:PORT/actuator/hystrix.stream 是会返回404,这是因为Feign虽然整合了Hystrix,但并没有整合Hystrix的监控。如何添加监控支持呢?需要以下几步:

第一步:添加依赖,示例:

org.springframework.cloud spring-cloud-starter-hystrix 第二步:在启动类上添加@EnableCircuitBreaker 注解,示例:

@SpringBootApplication
@EnableFeignClients
@EnableDiscoveryClient
@EnableCircuitBreaker
public class MovieFeignHystrixApplication {
public static void main(String[] args) {
SpringApplication.run(MovieFeignHystrixApplication.class, args);
}
}
第三步:在application.yml中添加如下内容,暴露hystrix.stream端点:

management:
endpoints:
web:
exposure:
include: ‘hystrix.stream’
这样,访问任意Feign Client接口的API后,再访问http://IP:PORT/actuator/hystrix.stream ,就会展示一大堆Hystrix监控数据了。

===============================================

个人github:https://github.com/zhangqian0710?tab=repositories

个人csdn:https://mp.youkuaiyun.com/mdeditor/96853700#

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值