com.github.lianjiatech.retrofit.spring.boot.annotation

注释类型 RetrofitClient

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

作者:

陈添明

可选元素概要

可选元素

限定符和类型	可选元素和说明
String	baseUrl 绝对URL（协议是必需的）。
Class<? extends retrofit2.CallAdapter.Factory>[]	callAdapterFactories 适用于当前接口的调用适配器工厂，优先级比全局调用适配器工厂更高。
int	callTimeoutMs Sets the default timeout for complete calls.
int	connectTimeoutMs Sets the default connect timeout for new connections.
Class<? extends retrofit2.Converter.Factory>[]	converterFactories 适用于当前接口的转换器工厂，优先级比全局转换器工厂更高。
boolean	enableLog 针对当前接口是否启用日志打印 Whether to enable log printing for the current interface
Class<? extends ErrorDecoder>	errorDecoder 当前接口采用的错误解码器，当请求发生异常或者收到无效响应结果的时候，将HTTP相关信息解码到异常中，无效响应由业务自己判断。
Class<?>	fallback Fallback class for the specified retrofit client interface.
Class<?>	fallbackFactory Define a fallback factory for the specified Feign client interface.
boolean	followRedirects Configure this client to follow redirects.
boolean	followSslRedirects Configure this client to allow protocol redirects from HTTPS to HTTP and from HTTP to HTTPS.
LogLevel	logLevel 日志打印级别，支持的日志级别参见LogLevel 如果为NULL，则取全局日志打印级别 Log printing level, see LogLevel for supported log levels
LogStrategy	logStrategy 日志打印策略，支持的日志打印策略参见LogStrategy 如果为NULL，则取全局日志打印策略 Log printing strategy, see LogStrategy for supported log printing strategies
String	path Path prefix to be used by all method-level mappings.
int	pingIntervalMs Sets the interval between HTTP/2 and web socket pings initiated by this client.
String	poolName connection pool name
int	readTimeoutMs Sets the default read timeout for new connections.
boolean	retryOnConnectionFailure Configure this client to retry or not when a connectivity problem is encountered.
String	serviceId The name of the service.
boolean	validateEagerly When calling Retrofit.create(Class) on the resulting Retrofit instance, eagerly validate the configuration of all methods in the supplied interface.
int	writeTimeoutMs Sets the default write timeout for new connections.

元素详细资料

baseUrl

public abstract String baseUrl

绝对URL（协议是必需的）。 可以指定为属性键，例如：$ {propertyKey}。 如果baseUrl没有配置，则必须配置serviceId以及，path可选配置。 An absolute URL (the protocol is necessary). Can be specified as property key, eg: ${propertyKey}. If baseUrl is not configured, you must configure serviceId and path optional configuration.

返回:

baseUrl

默认值:

""

serviceId

public abstract String serviceId

The name of the service. Can be specified as property key, eg: ${propertyKey}.

默认值:

""

path

public abstract String path

Path prefix to be used by all method-level mappings.

默认值:

""

converterFactories

public abstract Class<? extends retrofit2.Converter.Factory>[] converterFactories

适用于当前接口的转换器工厂，优先级比全局转换器工厂更高。转换器实例优先从Spring容器获取，如果没有获取到，则反射创建。 Converter factory for the current interface, higher priority than global converter factory. The converter instance is first obtained from the Spring container. If it is not obtained, it is created by reflection.

默认值:

{}

callAdapterFactories

public abstract Class<? extends retrofit2.CallAdapter.Factory>[] callAdapterFactories

适用于当前接口的调用适配器工厂，优先级比全局调用适配器工厂更高。转换器实例优先从Spring容器获取，如果没有获取到，则反射创建。 callAdapter factory for the current interface, higher priority than global callAdapter factory. The converter instance is first obtained from the Spring container. If it is not obtained, it is created by reflection.

默认值:

{}

fallback

public abstract Class<?> fallback

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

默认值:

void.class

fallbackFactory

public abstract 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 RetrofitClient.The fallback factory must be a valid spring bean. bean.

默认值:

void.class

enableLog

public abstract boolean enableLog

针对当前接口是否启用日志打印 Whether to enable log printing for the current interface

返回:

enableLog

默认值:

true

logLevel

public abstract LogLevel logLevel

日志打印级别，支持的日志级别参见LogLevel 如果为NULL，则取全局日志打印级别 Log printing level, see LogLevel for supported log levels

返回:

logLevel

默认值:

com.github.lianjiatech.retrofit.spring.boot.interceptor.LogLevel.NULL

logStrategy

public abstract LogStrategy logStrategy

日志打印策略，支持的日志打印策略参见LogStrategy 如果为NULL，则取全局日志打印策略 Log printing strategy, see LogStrategy for supported log printing strategies

返回:

logStrategy

默认值:

com.github.lianjiatech.retrofit.spring.boot.interceptor.LogStrategy.NULL

validateEagerly

public abstract boolean validateEagerly

When calling Retrofit.create(Class) on the resulting Retrofit instance, eagerly validate the configuration of all methods in the supplied interface.

返回:

validateEagerly

默认值:

false

errorDecoder

public abstract Class<? extends ErrorDecoder> errorDecoder

当前接口采用的错误解码器，当请求发生异常或者收到无效响应结果的时候，将HTTP相关信息解码到异常中，无效响应由业务自己判断。 一般情况下，每个服务对应的无效响应各不相同，可以自定义对应的ErrorDecoder，然后配置在这里。

The error decoder used in the current interface will decode HTTP related information into the exception when an exception occurs in the request or an invalid response result is received. The invalid response is determined by the business itself. In general, the invalid response corresponding to each service is different, you can customize the corresponding ErrorDecoder, and then configure it here.

返回:

ErrorDecoder

默认值:

com.github.lianjiatech.retrofit.spring.boot.core.DefaultErrorDecoder.class

poolName

public abstract String poolName

connection pool name

返回:

connection pool name

默认值:

"default"

connectTimeoutMs

public abstract int connectTimeoutMs

Sets the default connect timeout for new connections. A value of 0 means no timeout, otherwise values must be between 1 and Integer.MAX_VALUE when converted to milliseconds. If it is configured as -1, the global default configuration is used.

返回:

connectTimeoutMs

默认值:

-1

readTimeoutMs

public abstract int readTimeoutMs

Sets the default read timeout for new connections. A value of 0 means no timeout, otherwise values must be between 1 and Integer.MAX_VALUE when converted to milliseconds. If it is configured as -1, the global default configuration is used.

返回:

readTimeoutMs

默认值:

-1

writeTimeoutMs

public abstract int writeTimeoutMs

Sets the default write timeout for new connections. A value of 0 means no timeout, otherwise values must be between 1 and Integer.MAX_VALUE when converted to milliseconds. If it is configured as -1, the global default configuration is used.

返回:

writeTimeoutMs

默认值:

-1

callTimeoutMs

public abstract int callTimeoutMs

Sets the default timeout for complete calls. A value of 0 means no timeout, otherwise values must be between 1 and Integer.MAX_VALUE when converted to milliseconds.

返回:

callTimeout

默认值:

-1

pingIntervalMs

public abstract int pingIntervalMs

Sets the interval between HTTP/2 and web socket pings initiated by this client. Use this to automatically send ping frames until either the connection fails or it is closed. This keeps the connection alive and may detect connectivity failures.

返回:

pingInterval

默认值:

0

followSslRedirects

public abstract boolean followSslRedirects

Configure this client to allow protocol redirects from HTTPS to HTTP and from HTTP to HTTPS. Redirects are still first restricted by followRedirects. Defaults to true.

返回:

followSslRedirects

默认值:

true

followRedirects

public abstract boolean followRedirects

Configure this client to follow redirects. If unset, redirects will be followed.

返回:

followRedirects

默认值:

true

retryOnConnectionFailure

public abstract boolean retryOnConnectionFailure

Configure this client to retry or not when a connectivity problem is encountered. By default, this client silently recovers from the following problems:

返回:

retryOnConnectionFailure

默认值:

true