SpringCloud中FeignClient自定义配置

 更新时间:2025年08月15日 11:19:05   作者:一乐小哥  
使用FeignClient时需了解其默认配置机制,通过注入Decoder、Encoder等Bean实现自定义配置,下面就来介绍一下如何使用,感兴趣的可以了解一下

前言

最近公司新老项目对接过程中使用feginClient进行调用时遇到了很多问题,在此做些简短的总结记录

一、Feign的配置原理

当我们配置一个feignClient的时候,通常的写法是这样的

@FeignClient("xxxClient")
public interface xxxClient{
}

当我们做这个实际上就是生成一个默认的FeignClient, 其配置在org.springframework.cloud.openfeign 包下的FeignClientsConfiguration

@Configuration
public class FeignClientsConfiguration {
	@Autowired
	private ObjectFactory<HttpMessageConverters> messageConverters;
	@Autowired(required = false)
	private List<AnnotatedParameterProcessor> parameterProcessors = new ArrayList<>();
	@Autowired(required = false)
	private List<FeignFormatterRegistrar> feignFormatterRegistrars = new ArrayList<>();
	@Autowired(required = false)
	private Logger logger;
	@Bean
	@ConditionalOnMissingBean
	public Decoder feignDecoder() {
		return new OptionalDecoder(new ResponseEntityDecoder(new SpringDecoder(this.messageConverters)));
	}
	@Bean
	@ConditionalOnMissingBean
	public Encoder feignEncoder() {
		return new SpringEncoder(this.messageConverters);
	}
	@Bean
	@ConditionalOnMissingBean
	public Contract feignContract(ConversionService feignConversionService) {
		return new SpringMvcContract(this.parameterProcessors, feignConversionService);
	}
	@Bean
	public FormattingConversionService feignConversionService() {
		FormattingConversionService conversionService = new DefaultFormattingConversionService();
		for (FeignFormatterRegistrar feignFormatterRegistrar : feignFormatterRegistrars) {
			feignFormatterRegistrar.registerFormatters(conversionService);
		}
		return conversionService;
	}

	@Configuration
	@ConditionalOnClass({ HystrixCommand.class, HystrixFeign.class })
	protected static class HystrixFeignConfiguration {
		@Bean
		@Scope("prototype")
		@ConditionalOnMissingBean
		@ConditionalOnProperty(name = "feign.hystrix.enabled")
		public Feign.Builder feignHystrixBuilder() {
			return HystrixFeign.builder();
		}
	}
	@Bean
	@ConditionalOnMissingBean
	public Retryer feignRetryer() {
		return Retryer.NEVER_RETRY;
	}
	@Bean
	@Scope("prototype")
	@ConditionalOnMissingBean
	public Feign.Builder feignBuilder(Retryer retryer) {
		return Feign.builder().retryer(retryer);
	}
	@Bean
	@ConditionalOnMissingBean(FeignLoggerFactory.class)
	public FeignLoggerFactory feignLoggerFactory() {
		return new DefaultFeignLoggerFactory(logger);
	}
}

可以看到这上面所有注入的bean都有一个注解@ConditionalOnMissingBean,也就没有自定义则触发创建Bean

这一段Bean的注入在FeignClientFactoryBean中的这段代码, 当服务启动时触发

protected Feign.Builder feign(FeignContext context) {
		FeignLoggerFactory loggerFactory = get(context, FeignLoggerFactory.class);
		Logger logger = loggerFactory.create(type);

		// @formatter:off 从spring上下文中获取对应的Bean
		Feign.Builder builder = get(context, Feign.Builder.class)
				// required values
				.logger(logger)
				.encoder(get(context, Encoder.class))
				.decoder(get(context, Decoder.class))
				.contract(get(context, Contract.class));
		// @formatter:on

		configureFeign(context, builder);

		return builder;
	}

二、自定义配置

这就意味着如果我们需要自定义FeignClient的相关配置可以直接注入其中一个bean就可以了

类似于

@Configuration
public class FeignClientsConfiguration {

    @Bean
    public Decoder feignDecoder() {
        return new ResultDecoder();
    }

    @Bean
    public Encoder feignEncoder() {
        return new ParamEncoder();
    }

    @Bean
    public Contract feignContract() {
        return new DefaultContract();
    }
}

如上所示, 我分别注入了Decoder、Encoder、Contract, 而其他几项依然还是feign默认值.

三、专有配置

那么如果我想为一个client单独加一些配置又应该如何做呢?

点开@FeignClient可以看到里面有一项configuration

/**
	 * A custom <code>@Configuration</code> for the feign client. Can contain override
	 * <code>@Bean</code> definition for the pieces that make up the client, for instance
	 * {@link feign.codec.Decoder}, {@link feign.codec.Encoder}, {@link feign.Contract}.
	 *
	 * @see FeignClientsConfiguration for the defaults
	 */
	Class<?>[] configuration() default {};

所以我们可以写一个如下的configuration

public class SelfFeignClientsConfiguration {
    @Bean
    @ConditionalOnMissingBean(name = "SelfFeignDecoder")
    public Decoder SelfFeignDecoder() {
        return new JacksonDecoder();
    }
}

再在feignClient上引入

@FeignClient(name = "xxxClient", configuration = SelfFeignClientsConfiguration.class)
public interface xxxClient{
}

如此即可完成对xxxClient更细粒度的配置.

到此这篇关于SpringCloud中FeignClient自定义配置的文章就介绍到这了,更多相关SpringCloud FeignClient配置内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Spring Security如何优雅的增加OAuth2协议授权模式

    Spring Security如何优雅的增加OAuth2协议授权模式

    这篇文章主要介绍了Spring Security如何优雅的增加OAuth2协议授权模式,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-09-09
  • java -jar设置添加启动参数实现方法

    java -jar设置添加启动参数实现方法

    这篇文章主要介绍了java -jar设置添加启动参数实现方法,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-02-02
  • 关于jdk9、jdk10、jdk11、jdk12、jdk13新特性说明

    关于jdk9、jdk10、jdk11、jdk12、jdk13新特性说明

    这篇文章主要介绍了关于jdk9、jdk10、jdk11、jdk12、jdk13新特性说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-05-05
  • Java8 ArrayList之forEach的使用

    Java8 ArrayList之forEach的使用

    这篇文章主要介绍了Java8 ArrayList之forEach的使用,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • SpringBoot彩色日志配置方式

    SpringBoot彩色日志配置方式

    这篇文章主要介绍了SpringBoot彩色日志配置方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-04-04
  • JDK8安装与配置实践超详细指南

    JDK8安装与配置实践超详细指南

    本文详细介绍了在Windows 64位系统上安装和配置JDK8的步骤,包括JDK8下载、环境变量设置及安装验证,同时提供了JDK8新特性如Lambda表达式、StreamAPI等的概览,旨在帮助Java开发者有效利用JDK8新特性进行开发,需要的朋友可以参考下
    2024-10-10
  • Java实现注册邮箱激活账户实例代码

    Java实现注册邮箱激活账户实例代码

    本篇文章主要介绍了Java实现邮箱激活账户实例代码,这里整理了详细的代码,具有一定的参考价值,有需要的小伙伴可以参考下。
    2017-07-07
  • Springboot单体架构http请求转换https请求来支持微信小程序调用接口

    Springboot单体架构http请求转换https请求来支持微信小程序调用接口

    这篇文章主要介绍了Springboot单体架构http请求转换https请求来支持微信小程序调用接口,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-11-11
  • 解决Intellij IDEA覆盖tomcat配置的问题

    解决Intellij IDEA覆盖tomcat配置的问题

    分析并解决Intellij IDEA覆盖tomcat配置的问题/解决修改server.xml无效的问题,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友一起看看吧
    2021-02-02
  • Java递归遍历树形结构的实现代码

    Java递归遍历树形结构的实现代码

    这篇文章主要介绍了Java递归遍历树形结构的相关资料,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2016-03-03

最新评论