注释类型 Query


URL Query参数注解,该注解只能修饰方法的参数,被修饰的参数会被作为一个URL的Query参数添加到请求的URL中的Query部分(即'?'后的那部分)

Query参数为 [参数名1]=[参数值1](&[参数名n]=[参数值n])* 的形式

[参数名] 由该注解的 value 属性表示

[参数值] 由该注解所修饰的参数的值表示

该注解有一下几种模式:

(1) 键值对模式:

          void send(@Query("username") String username, @Query("password") String password);
          
此模式的@Query注解可以修饰一个或多个参数,每个参数仅作为一个键值对。这些键值对最终会被作为一个URL的Query参数添加到请求的URL参数中

(2) 对象模式:

          void send(@Query UserInfo userInfo);
          
此模式的@Query注解可以修饰一个或多个自定义对象,但不能设置名称(value属性)以表明它不是一个键值对。被修饰的参数对象会被拆成一个个字段(这个对象类中所有getter方法对应的字段), 所有这些字段将像键值对一样被作为一个URL的Query参数添加到请求的URL参数中

(3) Map模式:

          void send(@Query Map headerMap);
          
此模式的@Query注解可以修饰一个或多个Map对象,但不能设置名称(value属性)以表明它不是一个键值对。被修饰的参数对象会被拆成一个个键值对(Map中的所有有值的键值对), 所有这些键值对被作为一个URL的Query参数添加到请求的URL参数中

(4) 字符串模式:

          void send(@Query String query);
          
此模式的@Query注解可以修饰一个或多个String类型参数,但不能设置名称(value属性)以表明它不是一个键值对。 被修饰的字符串参数将直接以 [参数值] 的形式添加到URL中的Query参数部分
从以下版本开始:
2020-08-03
作者:
gongjun
  • 可选元素概要

    可选元素
    修饰符和类型
    可选元素
    说明
    默认值
    The filters will do some processing for the query value before sending request.
    URL Query参数的参数名(可省略)[同value]
    int
    排序序号
    URL Query参数的参数名(可省略)[同name]
  • 元素详细资料

    • value

      @AliasFor("name") String value
      URL Query参数的参数名(可省略)[同name]

      如有参数名,将会以 [参数名]=[参数值] 的形式添加到URL中的Query参数部分(即'?'后的那部分)

      如没有参数名,将直接以 [参数值] 的形式添加到URL中的Query参数部分,

      如 @Query String name,且参数name的值为yyy的话,产生的URL便会是 http://xxx.xxx.xxx/xxx?yyy

      返回:
      参数名
      默认值:
      ""
    • name

      @AliasFor("value") String name
      URL Query参数的参数名(可省略)[同value]

      如有参数名,将会以 [参数名]=[参数值] 的形式添加到URL中的Query参数部分(即'?'后的那部分)

      如没有参数名,将直接以 [参数值] 的形式添加到URL中的Query参数部分,

      如 @Query String name,且参数name的值为yyy的话,产生的URL便会是 http://xxx.xxx.xxx/xxx?yyy

      返回:
      参数名
      默认值:
      ""
    • filter

      String filter
      The filters will do some processing for the query value before sending request.
      返回:
      filter names
      默认值:
      ""
    • defaultValue

      String defaultValue
      默认值
      返回:
      默认值
      默认值:
      ""
    • order

      int order
      排序序号
      返回:
      排序序号
      默认值:
      -1