springMvc如何优雅实现校验

1 篇文章 0 订阅

1、如果使用需要JSR303 ,就要导入hibernate-validator依赖

    <dependency>
      <groupId>org.hibernate</groupId>
      <artifactId>hibernate-validator</artifactId>
      <version>5.0.2.Final</version>
    </dependency>

2、校验框架介绍(第二点内容摘自
https://blog.csdn.net/cao_2000/article/details/85322050).)
JSR303 是一套JavaBean参数校验的标准,它定义了很多常用的校验注解,我们可以直接将这些注解加在我们JavaBean的属性上面,就可以在需要校验的时候进行校验了。注解如下:
参考配置
@Null 限制只能为null
@NotNull 限制必须不为null
@AssertFalse 限制必须为false
@AssertTrue 限制必须为true
@DecimalMax(value) 限制必须为一个不大于指定值的数字
@DecimalMin(value) 限制必须为一个不小于指定值的数字
@Digits(integer,fraction) 限制必须为一个小数,且整数部分的位数不能超过integer,小数部分的位数不能超过fraction
@Future 限制必须是一个将来的日期
@Max(value) 限制必须为一个不大于指定值的数字
@Min(value) 限制必须为一个不小于指定值的数字
@Past 限制必须是一个过去的日期
@Pattern(value) 限制必须符合指定的正则表达式
@Size(max,min) 限制字符长度必须在min到max之间
@Past 验证注解的元素值(日期类型)比当前时间早
@NotEmpty 验证注解的元素值不为null且不为空(字符串长度不为0、集合大小不为0)
@NotBlank 验证注解的元素值不为空(不为null、去除首位空格后长度为0),不同于@NotEmpty,@NotBlank只应用于字符串且在比较时会去除字符串的空格
@Email 验证注解的元素值是Email,也可以通过正则表达式和flag指定自定义的email格式
3、在我们使用springMvc提供得接口实现功能时,所提供的参数难免会进行参数的合法性校验,比如非空校验,最原始的办法就是手动校验,比如下面的代码:

    @Test
    public void sync() {
        String name = "张三";
        String password = "";

        if (StringUtils.isBlank(name)){
            System.out.println("用户名不能为空!");
        }

        if (StringUtils.isBlank(password)){
            System.out.println("密码不能为空!");
        }
    }

4、如果一个两个参数还好,如果参数很多比如几十个,那么就要判断几十次,代码量剧增,可读性也不好。看上去很不美观,那么如何实现优雅得校验呢?
SpringMVC为我们提供了Valid,通过Valid很方便的进行数据的合法性校验,请看代码:
实体类:

@Data
public class Test {
    @NotBlank(message = "用户名不能为空")
    private String name;
    @NotBlank(message = "密码不能为空")
    private String password;
}

Controller层

    @GetMapping("/test")
    public ResponseResult test(@Valid Test test){
       return new ResponseResult(666,"成功");
    }

现在我们使用postman进行测试,当我们什么参数都不传
在这里插入图片描述

查看控制台输出结果
在这里插入图片描述
出现以上控制台得输出,就算成功了,显然,前台并没有返回对应message,如果我们需要将此校验消息返回该如何实现呢?
只需将前面得代码加上BindingResult,我们就能从中获取消息

@GetMapping("/test")
    public ResponseResult test(@Valid Test test, BindingResult result){
        if (result.hasFieldErrors()){
            return new ResponseResult(false,444,result.getFieldError().getDefaultMessage());
        }
       return new ResponseResult(false,666,"成功");
    }

接下来我们再来看下postman返回值
在这里插入图片描述
5、但是如果很多地方都要用到这个校验,不是每个方法都要写这样一个代码嘛?显示也是比较麻烦,难以维护得,所以我们可以将此返回放进全局异常中,代码如下:
(注意:需要在参数前加上@RequestBody注解)

    @PostMapping("/test")
    public ResponseResult test(@Valid @RequestBody Test test){
       return new ResponseResult(false,666,"成功");
    }

全局异常代码

/**
     * jsr303校验
     * @param e
     * @return
     */
    @ExceptionHandler({MethodArgumentNotValidException.class})
    public ResponseResult getMethodArgumentNotValidException(MethodArgumentNotValidException e){
             log.error(e.getBindingResult().getFieldError().getDefaultMessage());
             return new ResponseResult(false,1115,e.getBindingResult().getFieldError().getDefaultMessage());
    }

接下来再来看postman返回值
在这里插入图片描述
在这里插入图片描述
这样就减少了很多代码得书写

6、很多时候,根据项目的拓展验证注解不够用,那怎么办,解决的办法就是自定义验证注解,如想了解自定义注解,欢迎观看我的另一篇博客
https://blog.csdn.net/lh_mnbj/article/details/107973376
以上只是个人见解,如有问题,欢迎指正!!!

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值