cc.shacocloud.mirage.web.bind.annotation.QueryParam Maven / Gradle / Ivy

Go to download
package cc.shacocloud.mirage.web.bind.annotation;

import cc.shacocloud.mirage.web.bind.support.QueryParamsAndFormAttributesMethodArgumentResolver;
import cc.shacocloud.mirage.web.bind.ValueConstants;
import org.springframework.core.annotation.AliasFor;

import java.lang.annotation.*;

/**
 * 指示方法参数应绑定到HTTP查询参数的注解
 * 
 * 用于请求中的查询参数绑定，例如：{@code /api/user?x1=xx&x2=x2} 中的 {@code x1=xx&x2=x2}
 *
 * @see RequestMapping
 * @see QueryParamsAndFormAttributesMethodArgumentResolver
 */
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface QueryParam {

    /**
     * {@link #name}的别名
     */
    @AliasFor("name")
    String value() default "";

    /**
     * 要绑定到的请求参数的名称
     */
    @AliasFor("value")
    String name() default "";

    /**
     * 参数是否必需。
     */
    boolean required() default true;

    /**
     * 当请求参数未提供或有空值时，用作回退的默认值。
     * 
     * 提供默认值将隐式的设置{@link #required}为{@code false}。
     */
    String defaultValue() default ValueConstants.DEFAULT_NONE;

}