JSR303后端校验详解

曾经终败给现在 2023-02-14 02:46 18阅读 0赞

### JSR303后端校验 ###

*  什么是JSR303？
 *  导入jar包
 *  校验规则
 *  在属性上添加注解
 *  添加@Valid注解

# 什么是JSR303？ #

--------------------

[JSR 303 - Bean Validation][]提供了一种后端数据校验支持，如果一键f12修改前端代码成功绕过前端校验，那么就会存入非法数据，所以后端校验十分重要。应该前端+后端+数据库的校验约束都不能少，全面保障数据规范安全。

# 导入jar包 #

--------------------

在pom.xml引入依赖，不了解Maven可以[点这里][Link 1]。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1MDM0NzA4_size_16_color_FFFFFF_t_70]

<dependency>
          <groupId>org.hibernate</groupId>
          <artifactId>hibernate-validator</artifactId>
          <version>5.1.0.Final</version>
        </dependency>
    
        <dependency>
           <groupId>javax.el</groupId>
           <artifactId>javax.el-api</artifactId>
           <version>3.0.0</version>
        </dependency>

# 校验规则 #

--------------------

<table> 
 <thead> 
  <tr> 
   <th>Constraint</th> 
   <th>详细信息</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Null</td> 
   <td>被注释的元素必须为 null</td> 
  </tr> 
  <tr> 
   <td>@NotNull</td> 
   <td>被注释的元素必须不为 null</td> 
  </tr> 
  <tr> 
   <td>@AssertTrue</td> 
   <td>被注释的元素必须为 true</td> 
  </tr> 
  <tr> 
   <td>@AssertFalse</td> 
   <td>被注释的元素必须为 false</td> 
  </tr> 
  <tr> 
   <td>@Min(value)</td> 
   <td>被注释的元素必须是一个数字，其值必须大于等于指定的最小值</td> 
  </tr> 
  <tr> 
   <td>@Max(value)</td> 
   <td>被注释的元素必须是一个数字，其值必须小于等于指定的最大值</td> 
  </tr> 
  <tr> 
   <td>@DecimalMin(value)</td> 
   <td>被注释的元素必须是一个数字，其值必须大于等于指定的最小值</td> 
  </tr> 
  <tr> 
   <td>@DecimalMax(value)</td> 
   <td>被注释的元素必须是一个数字，其值必须小于等于指定的最大值</td> 
  </tr> 
  <tr> 
   <td>@Size(max, min)</td> 
   <td>被注释的元素的大小必须在指定的范围内</td> 
  </tr> 
  <tr> 
   <td>@Digits (integer, fraction)</td> 
   <td>被注释的元素必须是一个数字，其值必须在可接受的范围内</td> 
  </tr> 
  <tr> 
   <td>@Past</td> 
   <td>被注释的元素必须是一个过去的日期</td> 
  </tr> 
  <tr> 
   <td>@Future</td> 
   <td>被注释的元素必须是一个将来的日期</td> 
  </tr> 
  <tr> 
   <td>@Pattern(value)</td> 
   <td>被注释的元素必须符合指定的正则表达式</td> 
  </tr> 
  <tr> 
   <td>@Email</td> 
   <td>被注释的元素必须是电子邮箱地址</td> 
  </tr> 
  <tr> 
   <td>@Length</td> 
   <td>被注释的字符串的大小必须在指定的范围内</td> 
  </tr> 
  <tr> 
   <td>@NotEmpty</td> 
   <td>被注释的字符串的必须非空</td> 
  </tr> 
  <tr> 
   <td>@Range</td> 
   <td>被注释的元素必须在合适的范围内</td> 
  </tr> 
 </tbody> 
</table>

上面是官网给出的所有校验规则，其中@Pattern是比较常用的，可以自定义规则。

# 在属性上添加注解 #

--------------------

在JavaaBean的属性上加上注解，其中message设置错误信息，可以不写使用默认。

public class User { 
    	@NotNull(message="×:账号不能为空")
        private Integer uid;
    
    	@NotNull
    	@Length(min=6,max=20,message="×:密码长度须为6-20")
        private String password;
        
        @Pattern(regexp="(^[a-zA-Z0-9_-]{3,16}$)|(^[\u2E80-\u9FFF]{2,5})"
        		,message="×:用户名为2-5中文或3-16英文数字组合")
        private String name;
    
        //@Pattern(regexp="^([a-zA-Z0-9_\\.-]+)@([\\da-z\\.-]+)\\.([a-z\\.]{2,6})$"
        // ,message="×:邮箱格式错误")
        @Email
        private String email;
    	
    	@Past
    	private Date birthday;

# 添加@Valid注解 #

--------------------

在Controller方法的参数上加上@Valid注解，出错后的错误信息会放在 BindingResult 的对象参数中。

@PostMapping("/user")
    	@ResponseBody
    	public Msg saveUser(@Valid User user,BindingResult result){ 
    		if (result.hasErrors()){ 
    	            Map<String,Object> map = new HashMap<>();
    	            //校验失败，应该返回失败，在模态框中显示校验失败的错误信息
    	            List<FieldError> errors = result.getFieldErrors();
    	            for (FieldError fieldError:errors){ 
    	                System.out.println("错误的字段名："+fieldError.getField());
    	                System.out.println("错误信息："+fieldError.getDefaultMessage());
    	                map.put(fieldError.getField(),fieldError.getDefaultMessage());
    	            }
    	            return Msg.fail().add("errorFields",map);
    	        }else { 
    	        	userService.saveUser(user);
    	    		return Msg.success();
    	        }
    	}

> **原创不易，请勿转载**（本不富裕的访问量雪上加霜 ）  
> 博主首页：[https://blog.csdn.net/qq\_45034708][https_blog.csdn.net_qq_45034708]  
> *如果文章对你有帮助，记得关注点赞收藏❤*

[JSR 303 - Bean Validation]: https://www.ibm.com/developerworks/cn/java/j-lo-jsr303/index.html
[Link 1]: https://blog.csdn.net/qq_45034708/article/details/106172089
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1MDM0NzA4_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200531183858425.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQ1MDM0NzA4,size_16,color_FFFFFF,t_70
[https_blog.csdn.net_qq_45034708]: https://blog.csdn.net/qq_45034708