Java校验注解-jsr303

jsr

简介

jsr是Java Specification Requests的缩写,意思是Java 规范提案

jsr 303

JSR-303 是JAVA EE 6 中的一项子规范,叫做Bean Validation,Hibernate Validator 是 Bean Validation 的参考实现 . Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint(约束) 的实现,除此之外还有一些附加的 constraint(约束)。

注解

参考版本2.0.1.Final

注解 说明
AssertFalse 被注释的元素必须为 false
AssertTrue 被注释的元素必须为 True
DecimalMax 被注释的元素必须是一个数字,其值必须小于等于指定的最大值
DecimalMin 被注释的元素必须是一个数字,其值必须大于等于指定的最小值
Digits 其值必须在可接受的范围内。integer = 1 , fraction = 2 (整数最大长度为1,小数最大长度为2)
Future 被注释的元素必须是一个将来的日期
Past 被注释的元素必须是一个过去的日期
Max 被注释的元素必须是一个数字,其值必须小于等于指定的最大值
Min 被注释的元素必须是一个数字,其值必须大于等于指定的最小值
NotNull 被注释的元素必须为 notnull
NUll 被注释的元素必须为 null
Pattern 被注释的元素必须符合指定的正则表达式
Size 被注释的元素的大小必须在指定的范围内
Email 校验是否是邮箱
NotEmpty 验证对象不为空
NotBlank must contain at least one non-whitespace character

  • @NotEmpty、@Size
  <ul>
  <li>{@code CharSequence} (length of character sequence is evaluated)</li>
  <li>{@code Collection} (collection size is evaluated)</li>
  <li>{@code Map} (map size is evaluated)</li>
  <li>Array (array length is evaluated)</li>
  </ul>
  • @Decimal、@Digits
  <ul>
      <li>{@code BigDecimal}</li>
      <li>{@code BigInteger}</li>
      <li>{@code CharSequence}</li>(必须是数字)
      <li>{@code byte}, {@code short}, {@code int}, {@code long}, and their respective
      wrappers</li>
  </ul>

hibernate 自增校验注解 参考版本6.0.17.Final

注解 说明
EAN 检测欧洲物品编码(European Article Number)
Length 验证字符串长度范围[min,max
ParameterScriptAssert 验证参数级别脚本 jsr223
Range 数值范围 eg:1<id<10
SafeHtml 被约束的元素必须是一个HTML
ScriptAssert 验证类级别脚本,可以对有关联的值进行校验 jsr223
URL 校验string是url

...
注意

  • 使用ScriptAssertParameterScriptAssert记得引入对应的脚本引擎。比如js脚本引擎可以引入tomcat-embed-el
  • @Range
Apply on numeric values or string representation of the numeric value
例子:
good  1 or "1"
bad : "a"

自定义校验

有时候在特定的业务场景中需要特殊的校验。比如你希望实现以下校验功能。
bean中所有的字段都为空时校验不通过。

步骤

  • 声明自定义注解
@Target({TYPE })
@Retention(RUNTIME)
@Documented
// 1. Marks an annotation as being a Bean Validation constraint
// 2. validatedBy = 具体校验类
@Constraint(validatedBy = { NotAllNullValidator.class})
public @interface NotAllNull {
    // 校验不通过的时候打印的信息
    String message() default "属性值不能全部为null";
    // 校验组,用于分组校验
    Class<?>[] groups() default { };
    //
    Class<? extends Payload>[] payload() default { };
}

  • 实现具体校验类
public class NotAllNullValidator implements ConstraintValidator<NotAllNull, Object> {
    private NotAllNull notAllNull;

    @Override
    public void initialize(NotAllNull constraintAnnotation) {
        notAllNull = constraintAnnotation;
    }

    /**
     * @param value   被注解的对象
     * @param context
     * @return true 校验通过   false 校验失败
     */
    @Override
    public boolean isValid(Object value, ConstraintValidatorContext context) {

        return notAllNull(value);
    }
    private boolean notAllNull(Object value) {
        Field[] allFileds = value.getClass().getDeclaredFields();
        for (Field field : allFileds) {
            try {
                if (field.get(value) != null) {
                    return true;
                }
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }
        }
        return false;
    }
}

springmvc 实现校验

直接使用@Valid进行标注
这是入参

public static class Params {
        @NotNull(message = "id不能为空")
        private Integer id;

        public Integer getId() {
            return id;
        }

        public void setId(Integer id) {
            this.id = id;
        }
    }

前端访问接口

  @RequestMapping("/test")
    public void test(@Valid Params params) {
        System.out.println(params.getId());
    }

dubbo 实现校验

在提供者上添加validation="true"属性。

<dubbo:service ref="orderReadService"
                   interface="com.order.service.OrderReadService"
                   protocol="dubbo" version="${dubbo_trade_provider_version}"
                   timeout="60000" retries="0" 
                   //只需要增加这个属性
                   validation="true">
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 195,980评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,422评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,130评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,553评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,408评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,326评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,720评论 3 386
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,373评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,678评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,722评论 2 312
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,486评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,335评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,738评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,009评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,283评论 1 251
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,692评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,893评论 2 335

推荐阅读更多精彩内容