cn.jiangzeyin.common.validator.ValidatorItem Maven / Gradle / Ivy

Go to download
package cn.jiangzeyin.common.validator;

import java.lang.annotation.*;

/**
 * 验证规则
 *
 * @author jiangzeyin
 * @date 2018/8/21
 */
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ValidatorItem {
    /**
     * 规则
     *
     * @return ValidatorRule
     */
    ValidatorRule value() default ValidatorRule.NOT_EMPTY;

    /**
     * 还原html 转义字符
     * 一般用户字符串长度验证统一性
     *
     * @return 默认不还原
     */
    boolean unescape() default false;

    /**
     * 响应码
     *
     * @return 默认400
     */
    int code() default 400;

    /**
     * 错误信息
     *
     * @return msg
     */
    String msg() default "输入参数不正确";

    /**
     * 数字类型的范围
     * 配置错误将不判断
     * 
     * 范围写反也将不判断
     * 

     * 逻辑判断符 是 > 或者 <
     * 

     * 当 ValidatorRule 为 CUSTOMIZE 时此参数无效
     * 

     * 1 则为长度必须为1
     * 

     * 1.2:2  double类型的范围，值为1.2~2
     *
     * 
     * 1.2:2.5[1] double类型的范围，值为1.2~2.5 且小数点只能有一位
     *
     * @return 具体的规则
     * @see cn.jiangzeyin.common.validator.ValidatorRule#DECIMAL
     * @see cn.jiangzeyin.common.validator.ValidatorRule#NUMBERS
     * @see cn.jiangzeyin.common.validator.ValidatorRule#POSITIVE_INTEGER
     * @see cn.jiangzeyin.common.validator.ValidatorRule#NON_ZERO_INTEGERS
     * @see cn.jiangzeyin.common.validator.ValidatorRule#NOT_EMPTY
     * @see cn.jiangzeyin.common.validator.ValidatorRule#NOT_BLANK
     * @see cn.jiangzeyin.common.validator.ValidatorRule#GENERAL
     */
    String range() default "";
}