org.springframework.cloud.openfeign

注释类型 FeignClient

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
public @interface FeignClient

Annotation for interfaces declaring that a REST client with that interface should be created (e.g. for autowiring into another component). If ribbon is available it will be used to load balance the backend requests, and the load balancer can be configured using a @RibbonClient with the same name (i.e. value) as the feign client.

可选元素概要

可选元素

限定符和类型	可选元素和说明
java.lang.Class<?>[]	configuration A custom configuration class for the feign client.
java.lang.String	contextId This will be used as the bean name instead of name if present, but will not be used as a service id.
boolean	decode404
java.lang.Class<?>	fallback Fallback class for the specified Feign client interface.
java.lang.Class<?>	fallbackFactory Define a fallback factory for the specified Feign client interface.
java.lang.String	name
java.lang.String	path
boolean	primary
java.lang.String	qualifier
java.lang.String	serviceId 已过时。 use name instead
java.lang.String	url
java.lang.String	value The name of the service with optional protocol prefix.

元素详细资料

value

@AliasFor(value="name")
public abstract java.lang.String value

The name of the service with optional protocol prefix. Synonym for name. A name must be specified for all clients, whether or not a url is provided. Can be specified as property key, eg: ${propertyKey}.

返回:

the name of the service with optional protocol prefix

默认值:

""

serviceId

@Deprecated
public abstract java.lang.String serviceId

已过时。 use name instead

The service id with optional protocol prefix. Synonym for value.

返回:

the service id with optional protocol prefix

默认值:

""

contextId

public abstract java.lang.String contextId

This will be used as the bean name instead of name if present, but will not be used as a service id.

返回:

bean name instead of name if present

默认值:

""

name

@AliasFor(value="value")
public abstract java.lang.String name

返回:

The service id with optional protocol prefix. Synonym for value.

默认值:

""

qualifier

public abstract java.lang.String qualifier

返回:

the @Qualifier value for the feign client.

默认值:

""

url

public abstract java.lang.String url

返回:

an absolute URL or resolvable hostname (the protocol is optional).

默认值:

""

decode404

public abstract boolean decode404

返回:

whether 404s should be decoded instead of throwing FeignExceptions

默认值:

false

configuration

public abstract java.lang.Class<?>[] configuration

A custom configuration class for the feign client. Can contain override @Bean definition for the pieces that make up the client, for instance Decoder, Encoder, Contract.

返回:

list of configurations for feign client

默认值:

{}

fallback

public abstract java.lang.Class<?> fallback

Fallback class for the specified Feign client interface. The fallback class must implement the interface annotated by this annotation and be a valid spring bean.

返回:

fallback class for the specified Feign client interface

默认值:

void.class

fallbackFactory

public abstract java.lang.Class<?> fallbackFactory

Define a fallback factory for the specified Feign client interface. The fallback factory must produce instances of fallback classes that implement the interface annotated by FeignClient. The fallback factory must be a valid spring bean.

返回:

fallback factory for the specified Feign client interface

默认值:

void.class

path

public abstract java.lang.String path

返回:

path prefix to be used by all method-level mappings. Can be used with or without @RibbonClient.

默认值:

""

primary

public abstract boolean primary

返回:

whether to mark the feign proxy as a primary bean. Defaults to true.

默认值:

true