@FeignClient 是 Spring Cloud Feign 提供的一个注解,用于声明一个 REST 客户端接口。这个注解的主要作用是告诉 Spring 框架在启动时创建一个实现了该接口的 Feign 客户端实例,并将其注册为 Spring 管理的 Bean。以下是该注解的各个属性及其功能:
- name / value属性:
- 类型: String
- 默认值: “”
- 描述: 服务的名称,可以带有协议前缀。必填。如,@FeignClient(name = “myService”),这里的 “myService” 就是我们要调用的目标服务的名称,Feign 会依据它去服务注册中心查找对应的服务实例信息。
- contextId属性:
- 类型: String
- 默认值: “”
- 描述: 用作 Bean 名称,但不会作为服务ID使用,如@FeignClient(contextId = “myContextId”),“myContextId” 就是我们给这个Bean 起的一个特定名称。
- qualifier属性:
- 类型: String
- 默认值: “”
- 描述: 用来指定 Feign 客户端的@Qualifier值。举个例子,@FeignClient(qualifier = “myQualifier”),“myQualifier” 就是我们为这个 Feign 客户端设置的@Qualifier值啦,在一些需要通过@Qualifier来区分不同 Bean 的场景下就会用到它。
- url属性:
- 类型: String
- 默认值: “”
- 描述: 绝对URL或可解析的主机名(协议可选)。如@FeignClient(url = “http://cus.com”),这样 Feign 就会直接把请求发送到这个指定的地址啦,而不会再去服务注册中心查找服务实例信息。
- decode404属性:
- 类型: boolean
- 默认值: false
- 描述: 是否解码 404 错误而不是抛出 FeignException。如@FeignClient(decode404 = true),那么当遇到 404 错误时,Feign 就会尝试去解码这个错误,而不是像默认情况那样直接抛出异常给调用者。
- configuration属性:
- 类型: Class<?>[]
- 默认值: { }
- 描述: 自定义配置类,可以覆盖默认的 Feign 配置,例如 Decoder, Encoder, Contract 等。如@FeignClient(configuration = MyFeignConfig.class),“MyFeignConfig” 就是我们自己写的配置类,通过它就能按照我们的需求灵活调整 Feign 客户端的行为。
- fallback属性:
- 类型: Class<?>
- 默认值: void.class
- 描述: 指定的 Feign 客户端接口的容错类,必须实现该接口并是一个有效的 Spring Bean。如@FeignClient(fallback = MyFallback.class),当目标服务出现故障(比如不可用、超时等)时,Feign 就会调用 “MyFallback” 这个容错类中的对应方法来返回一个预设的结果,而不是直接抛出异常给调用者,这样就能保证系统的部分功能依然能够正常运行啦,大大提高了系统的容错。
- fallbackFactory属性:
- 类型: Class<?>
- 默认值: void.class
- 描述: 指定的 Feign 客户端接口的容错工厂,必须生成实现该接口的实例,并是一个有效的 Spring Bean。如@FeignClient(fallbackFactory = MyFallbackFactory.class),当目标服务出现故障时,“MyFallbackFactory” 这个容错工厂类就会被用来创建合适的容错对象并处理请求,而且通过这个工厂类还能在容错逻辑中获取到导致服务降级的原因(比如异常信息等),以便进行更精细的处理
- path属性:
- 类型: String
- 默认值: “”
- 描述: 所有方法级别映射的路径前缀,可以与 @RibbonClient 一起使用。@FeignClient(path = “/customer-api”),这样在后续通过这个 Feign 客户端接口调用方法时,请求路径就会自动加上这个前缀。
- primary属性:
- 类型: boolean
- 默认值: true
- 描述: 是否将 Feign 代理标记为主 Bean。如@FeignClient(primary = false),那么这个 Feign 代理就不会被当作主 Bean 来处理,在一些需要区分不同优先级的 Bean 的场景下会用到这个属性。