程序包 com.dtflys.forest.annotation

注释类型 BaseRequest

@Documented @BaseLifeCycle(BaseRequestLifeCycle.class) @Retention(RUNTIME) @Target({TYPE,ANNOTATION_TYPE}) public @interface BaseRequest
接口级别请求配置信息注解

The annotation must be on an interface. It allows you to make some configurations shared for all the requests in this interface.

该注解必须绑定在某一个接口类上。在该注解中配置的参数信息将会被次注解绑定的接口中所有方法的请求所共享， 它可以覆盖全局级别的请求配置信息，但不能覆盖方法级别的请求参数信息

从以下版本开始:
2018-03-30 16:59
作者:
gongjun[jun.gong@thebeastshop.com]
另请参阅:

  • 元素详细资料

    • baseURL

      String baseURL
      接口级别基础 URL

      请求的最终 url = baseUrl + request Url. 如果 request Url 是 http:// 或 https:// 等协议形式开头的就会忽略 baseUrl

      返回:
      接口级别基础 URL
      另请参阅:
      默认值:
      ""

    • contentType

      String contentType
      接口级别 Content Type

      在请求的 Content-Type 头或 contentType 属性没有设置， 且此属性不为空字符串的情况下， 此属性作为默认值填到请求的 Content-Type 头中

      返回:
      接口级别 Content Type
      另请参阅:
      默认值:
      ""

    • contentEncoding

      String contentEncoding
      接口级别 Content Encoding

      在请求的 Content-Encoding 头或 contentEncoding 属性没有设置， 且此属性不为空字符串的情况下， 此属性作为默认值填到请求的 Content-Encoding 头中

      返回:
      接口级别 Content Encoding
      另请参阅:
      默认值:
      ""

    • userAgent

      String userAgent
      接口级别 User Agent

      在请求的 User-Agent 头或 userAgent 属性没有设置， 且此属性不为空字符串的情况下， 此属性作为默认值填到请求的 User-Agent 头中

      返回:
      接口级别 User Agent
      另请参阅:
      默认值:
      ""

    • charset

      String charset
      接口级别请求字符集

      在请求的 charset 属性没有设置， 且此属性不为空字符串的情况下， 此属性作为默认值填到请求的 charset 头中

      返回:
      接口级别请求字符集
      另请参阅:
      默认值:
      ""

    • headers

      String[] headers
      接口级别请求头列表

      发送请求时，会将此属性中所有请起头信息合并到请求中， 但请求里的头列表中和此属性的请求头中同名的头信息不做合并

      返回:
      接口级别请求头列表
      另请参阅:
      默认值:
      {}

    • interceptor

      Class<? extends Interceptor>[] interceptor
      接口级别拦截器表

      发送请求时，会将此属性中所有拦截器合并到请求中， 但请求里的拦截器列表中和此属性的拦截器表中相同的拦截器不做合并

      返回:
      接口级别拦截器表
      另请参阅:
      默认值:
      {}

    • timeout

      int timeout
      已过时。
      请使用 connectTimeout() 和 readTimeout()
      接口级别超时时间 (单位为毫秒)

      在请求的 timeout 属性没有设置， 且此属性大于-1情况下， 此属性作为默认值填到请求的 timeout 属性中

      返回:
      接口级别超时时间
      另请参阅:
      默认值:
      -1

    • connectTimeout

      int connectTimeout
      请求连接超时时间, 单位为毫秒
      返回:
      请求连接超时时间
      默认值:
      -1

    • readTimeout

      int readTimeout
      请求读取超时时间, 单位为毫秒
      返回:
      读取超时时间
      默认值:
      -1

    • sslProtocol

      String sslProtocol
      接口级别 SSL 协议

      在请求的 sslProtocol 属性没有设置， 且此属性不为空字符串的情况下， 此属性作为默认值填到请求的 sslProtocol 属性中

      返回:
      接口级别 SSL 协议
      另请参阅:
      默认值:
      ""

    • retryer

      Class<?> retryer
      接口级别重试器

      在请求的 retryer 属性没有设置， 且此属性不为 Object.class 此属性作为默认值填到请求的 retryer 属性中

      返回:
      接口级别重试器
      另请参阅:
      默认值:
      java.lang.Object.class

    • retryCount

      @Deprecated int retryCount
      已过时。
      接口级别最大重试次数

      在请求的 retryCount 属性没有设置， 且此属性大于 -1 此属性作为默认值填到请求的 retryCount 属性中

      返回:
      接口级别最大重试次数
      另请参阅:
      默认值:
      -1

    • maxRetryInterval

      long maxRetryInterval
      接口级别最大重试间隔时间

      在请求的 maxRetryInterval 属性没有设置， 且此属性大于 -1 此属性作为默认值填到请求的 maxRetryInterval 属性中

      返回:
      接口级别最大重试间隔时间
      另请参阅:
      默认值:
      -1L

    • keyStore

      String keyStore
      接口级别 KeyStore Id

      在请求的 keyStore 属性没有设置， 且此属性不为空字符串 此属性作为默认值填到请求的 keyStore 属性中

      返回:
      KeyStore Id
      另请参阅:
      默认值:
      ""