博客
关于我
springboot后端数据校验JSR303规范详解
阅读量:720 次
发布时间:2019-03-21

本文共 2662 字,大约阅读时间需要 8 分钟。

后端数据校验JSR303规范详解

本文内容说明:

  • JSR303是由JSR303定义的一组校验规范
  • Hibernate Validator为JSR303提供了一系列标准化校验注解
  • 支持自定义校验规则,主要通过正则表达式实现
  • 可以通过校验结果获取数据校验的详细信息
  • 获取Hibernate Validator的官方文档资源
  • 其他文章可参考编写JSR303分组校验和自定义注解校验相关内容
  • 提醒:前端校验是基础,后端校验是必需,建议结合全局异常捕获来实现数据安全校验。本文将先从基础校验和统一异常处理说起,其他文章可参考分组校验和自定义注解校验的内容。


    一:基础校验

    1、给bean添加注解

    需要注意:- 使用@NotEmpty时,对于非空对象(如字符串、集合等)的校验- 对于Integer类型,建议使用@NotNull,而不是@NotEmpty- 定义自定义校验规则时,可以通过@Pattern注解使用正则表达式- 不同的校验类型有不同的默认提示信息

    代码示例:

    // 示例1:@NotBlankpublic class UserDTO {    @NotBlank(message = "用户名不能为空")     private String username;}// 示例2:自定义正则校验public class BrandEntity {    @Pattern(regexp = "/^[a-zA-Z]$", message = "必须是a-z或A-Z字母")     private String firstLetter;}

    2、在Controller开启校验

    使用Hibernate Validator的校验注解需要在Controller方法上标注@Valid,同时将注解应用到需要校验的对象上

    public R save(@Valid @RequestBody BrandEntity brand) {    // 处理校验结果}

    3、接收校验结果

    通过BindingResult接收校验结果,可以获取校验失败时的具体错误信息

    public R save(@Valid @RequestBody BrandEntity brand, BindingResult result) {    if (result.hasErrors()) {        // 提取校验结果        Map errorMap = new HashMap<>();        result.getFieldErrors().forEach(item -> {            errorMap.put(item.getField(), item.getDefaultMessage());        });        return R.error(400, "数据校验失败").put("data", errorMap);    } else {        brandService.save(brand);        return R.ok();    }}

    4、常用校验注解

    校验类型 注解示例 默认提示信息 使用场景
    @NotBlank @NotBlank(message = "用户名不能为空") 字段内容不能为空(去除空格后的内容也为空) 适用于字符串类型字段
    @NotNull @NotNull(message = "ID不能为空") 字段不为空 适用于所有非空对象(如Integer、String等)
    @Size @Size(min=5, max=10, message = "长度必须在5-10之间") 字段长度在min和max之间 适用于数组、集合、字符串等类型
    @Future @Future(message = "日期必须在未来") 日期必须在当前时间之后 适用于DateCalendar对象
    @Pattern @Pattern(regexp = "^\\d{3}-\\d{4}-\\d{4}$", message = "格式错误") 是否符合正则表达式 定义自定义格式规则

    5、自定义校验规则

    可通过@Pattern注解定义自定义正则表达式,实现对字段格式的更精细控制

    示例:

    ```java@Pattern(regexp = "^\\d{3}-\\d{4}-\\d{4}$", message = "文件格式不正确")private String fileFormat;```

    6、校验默认提示信息

    默认提示信息分为英文和中文版本,英文提示信息来源于Hibernate Validator的默认提示,中文提示信息需单独配置

    图片1:Hibernate Validator提示信息配置

    7、异常处理

    推荐在Controller层配置全局异常处理类,统一处理MethodArgumentNotValidException异常

    ```javapackage com.guli.common.exception;public enum BizCodeEnum { VALID_EXCEPTION(400, "参数校验失败"), UNKNOW_EXCEPTION(500, "系统未知错误");
    private int code;private String msg;BizCodeEnum(int code, String msg) {    this.code = code;    this.msg = msg;}public int getCode() {    return code;}public String getMsg() {    return msg;}

    }

    图片2:全局异常捕获配置

    8、配置依赖关系

    确保在Spring Boot项目中配备了Hibernate Validator相关依赖

    ```xml
    org.springframework.boot
    spring-boot-starter-validation

    总结

    JSR303规范为后端校验提供了统一的标准,Hibernate Validator是实现JSR303校验的最佳选择。推荐在Controller层开启校验,结合BindingResult接收校验结果,并通过全局异常捕获统一处理校验失败的情况。

    转载地址:http://lprrz.baihongyu.com/

    你可能感兴趣的文章
    MySQL-架构篇
    查看>>
    MySQL-索引的分类(聚簇索引、二级索引、联合索引)
    查看>>
    Mysql-触发器及创建触发器失败原因
    查看>>
    MySQL-连接
    查看>>
    mysql-递归查询(二)
    查看>>
    MySQL5.1安装
    查看>>
    mysql5.5和5.6版本间的坑
    查看>>
    mysql5.5最简安装教程
    查看>>
    mysql5.6 TIME,DATETIME,TIMESTAMP
    查看>>
    mysql5.6.21重置数据库的root密码
    查看>>
    Mysql5.6主从复制-基于binlog
    查看>>
    MySQL5.6忘记root密码(win平台)
    查看>>
    MySQL5.6的Linux安装shell脚本之二进制安装(一)
    查看>>
    MySQL5.6的zip包安装教程
    查看>>
    mysql5.7 for windows_MySQL 5.7 for Windows 解压缩版配置安装
    查看>>
    Webpack 基本环境搭建
    查看>>
    mysql5.7 安装版 表不能输入汉字解决方案
    查看>>
    MySQL5.7.18主从复制搭建(一主一从)
    查看>>
    MySQL5.7.19-win64安装启动
    查看>>
    mysql5.7.19安装图解_mysql5.7.19 winx64解压缩版安装配置教程
    查看>>