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 Boot Web 静态文件缓存处理的方法

    Spring Boot Web 静态文件缓存处理的方法

    本篇文章主要介绍了Spring Boot Web 静态文件缓存处理的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-02-02
  • Spring JPA联表查询之注解属性详解

    Spring JPA联表查询之注解属性详解

    这篇文章主要为大家介绍了Spring JPA联表查询之注解属性示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-04-04
  • SpringBoot 集成 Jasypt 对数据库加密以及踩坑的记录分享

    SpringBoot 集成 Jasypt 对数据库加密以及踩坑的记录分享

    这篇文章主要介绍了SpringBoot 集成 Jasypt 对数据库加密以及踩坑,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-08-08
  • Java对象不使用时赋值null的意义详解

    Java对象不使用时赋值null的意义详解

    这篇文章主要介绍了java对象不再使用时赋值null的意义,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-03-03
  • Java Spring @Autowired的这些骚操作,你都知道吗

    Java Spring @Autowired的这些骚操作,你都知道吗

    这篇文章主要介绍了彻底搞明白Spring中的自动装配和Autowired注解的使用,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2021-09-09
  • Java中finally和return的关系实例解析

    Java中finally和return的关系实例解析

    这篇文章主要介绍了Java中finally和return的关系实例解析,总结了二者的关系,然后分享了相关代码示例,小编觉得还是挺不错的,具有一定借鉴价值,需要的朋友可以参考下
    2018-02-02
  • redis setIfAbsent和setnx的区别与使用说明

    redis setIfAbsent和setnx的区别与使用说明

    这篇文章主要介绍了redis setIfAbsent和setnx的区别与使用,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • springboot调用支付宝第三方接口(沙箱环境)

    springboot调用支付宝第三方接口(沙箱环境)

    这篇文章主要介绍了springboot+调用支付宝第三方接口(沙箱环境),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-10-10
  • Linux中配置Java环境变量实现过程

    Linux中配置Java环境变量实现过程

    文章介绍了在Linux系统上安装Java 1.8的步骤:下载、传输、解压至/opt目录,配置环境变量(当前用户或全局),使用update-alternatives设置默认版本,并通过命令验证安装是否成功
    2025-07-07
  • 了解Maven的<relativePath/>标签用法

    了解Maven的<relativePath/>标签用法

    这篇文章主要介绍了了解Maven的<relativePath/>标签用法,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-04-04

最新评论