程序包 com.dtflys.forest.annotation

注释类型 PatchRequest

@Documented @MethodLifeCycle(PatchRequestLifeCycle.class) @Retention(RUNTIME) @Target({METHOD,ANNOTATION_TYPE}) public @interface PatchRequest
Patch请求信息定义注解，该注解只能修饰方法，被修饰的方法会自动被动态代理。当调用被修饰的方法时就会执行Forest动态的代理的代码， 也就会自动执行组装请求、发送请求、接受请求响应信息等任务。
从以下版本开始:
1.4.0
作者:
gongjun[dt_flys@hotmail.com]

  • 元素详细资料

    • value

      @AliasFor("url") String value
      目标请求URL [同url属性]
      返回:
      URL字符串
      默认值:
      ""

    • url

      @AliasFor("value") String url
      目标请求URL [同value属性]
      返回:
      URL字符串
      默认值:
      ""

    • dataType

      String dataType
      type of response data:

      text json xml binary auto

      default value is "auto"

      返回:
      type of response data
      默认值:
      "auto"

    • async

      boolean async
      whether can use async http request or not
      返回:
      true: async, false: sync
      默认值:
      false

    • timeout

      int timeout
      已过时。
      请使用 connectTimeout() 和 readTimeout()
      请求超时时间, 单位为毫秒
      返回:
      请求超时时间
      默认值:
      -1

    • connectTimeout

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

    • readTimeout

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

    • sslProtocol

      String sslProtocol
      SSL protocol
      返回:
      SSL protocol
      默认值:
      ""

    • retryer

      Class retryer
      Class of retryer
      返回:
      Class of retryer
      默认值:
      java.lang.Object.class

    • retryCount

      @Deprecated int retryCount
      已过时。
      Max count to retry
      返回:
      Max count to retry
      默认值:
      -1

    • maxRetryInterval

      long maxRetryInterval
      Max count to retry
      返回:
      Max count to retry
      默认值:
      -1L

    • contentType

      String contentType
      Content Type of request
      返回:
      Content Type
      默认值:
      ""

    • contentEncoding

      String contentEncoding
      Content Encoding of request
      返回:
      Content Encoding
      默认值:
      ""

    • userAgent

      String userAgent
      User Agent of request
      返回:
      User Agent
      默认值:
      ""

    • charset

      String charset
      Charset, Default is UTF-8
      返回:
      Charset
      默认值:
      ""

    • responseEncoding

      String responseEncoding
      Response Encoding

      响应内容的字符编码[UTF-8, GBK...]

      优先根据该字段来确认字符编码格式,再根据如下顺序来获取

      • 1. 从ContentType中获取
      • 2. 从响应头中的 Content-Encoding 获取
      • 3. 根据响应内容智能识别
      返回:
      Response Encoding
      默认值:
      ""

    • headers

      String[] headers
      request headers:
      use the key-value format: key: value 
               headers = "Content-Type: application/json"
      multiple headers 
               headers = {
            "Content-Type: application/json",
            "Accept: text/plain"
         }
      variables and parameters 
               headers = {"Accept: ${value}"}
      返回:
      headers
      默认值:
      {}

    • interceptor

      Class<? extends Interceptor>[] interceptor
      拦截器类列表
      返回:
      拦截器类列表
      默认值:
      {}

    • data

      String[] data
      请求数据
      返回:
      请求数据
      默认值:
      {}

    • progressStep

      long progressStep
      上传/下载进度步长
      返回:
      上传/下载进度步长
      默认值:
      -1L

    • encoder

      Class<?> encoder
      请求序列化器
      返回:
      请求序列化器
      默认值:
      java.lang.Object.class

    • decoder

      Class<?> decoder
      请求反序列化器
      返回:
      请求反序列化器
      默认值:
      java.lang.Object.class

    • keyStore

      String keyStore
      KeyStore Id
      返回:
      KeyStore Id
      默认值:
      ""

    • logEnabled

      @Deprecated boolean logEnabled
      已过时。
      是否打印请求日志
      返回:
      true: 打印, false: 不打印
      默认值:
      false