比较之前
在之前,我对参数进行校验的时候,都是通过StringUtills.isblank方法将参数进行是否为空判断,需要不断的使用if对前端传递过来的数值进行判断以及是很麻烦,更不用说rul,email等格式的判断,并且这对于性能以及代码的美观都是很严重的减分项。现在使用了JSR303做参数校验,发现颇为顺手,再次记下笔记以便以后用时回顾
什么是JSR303
JSR-303 是JAVA EE 6 中的一项子规范,叫做Bean Validation,Hibernate Validator 是 Bean Validation 的参考实现 . Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现,除此之外还有一些附加的 constrain
先附上相关规范注解
@NotNull | 任何类型 | 属性不能为null |
@NotEmpty | 集合 | 集合不能为null,且size大于0 |
@NotBlanck | 字符串、字符 | 字符类不能为null,且去掉空格之后长度大于0 |
@AssertTrue | Boolean | 布尔属性必须是true |
@Min | 数字类型 | 限定数字的最小值(整型) |
@Max | 同@Min | 限定数字的最大值(整型) |
@DecimalMin | 同@Min | 限定数字的最小值(字符串,可以是小数) |
@DecimalMax | 同@Min | 限定数字的最大值(字符串,可以是小数) |
@Range | 数字类型 | 限定数字范围(长整型) |
@Length | 字符串 | 限定字符串长度 |
@Size | 集合 | 限定集合大小 |
@Past | 时间、日期 | 必须是一个过去的时间或日期 |
@Future | 时期、时间 | 必须是一个未来的时间或日期 |
字符串 | 必须是一个邮箱格式 | |
@Pattern | 字符串、字符 | 正则匹配字符串 |
org.hibernate.validator.constraints包下的@NotBlanck也可以支持数值类型的
正片开始:
一、引入jar包
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>2.0.1.Final</version>
</dependency>
二、实体类对需要校验的数据进行校验
package com.atguigu.gulimall.product.entity;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import java.io.Serializable;
import lombok.Data;
import org.hibernate.validator.constraints.URL;
import javax.validation.constraints.*;
/**
* 品牌
*
* @author jjs
* @email
* @date 2021-07-26 14:51:27
*/
@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 品牌id
*/
@TableId
private Long brandId;
/**
* 品牌名
*/
@NotBlank(message = "品牌名不能为空") //至少包含一个非空字符
private String name;
/**
* 品牌logo地址
*/
@URL(message = "logo必须是一个合法的url")
@NotBlank(message = "品牌名不能为空")
private String logo;
/**
* 介绍
*/
private String descript;
/**
* 显示状态[0-不显示;1-显示]
*/
private Integer showStatus;
/**
* 检索首字母
*/
@Pattern(regexp = "^[a-zA-Z]$",message = "检索首字母必须是一个字母")
@NotBlank(message = "检索首字母不能为空")
private String firstLetter;
/**
* 排序
*/
@Min(value = 0,message = "sort的最小值是0")
@org.hibernate.validator.constraints.NotBlank(message = "排序不能为空" )//org.hibernate.validator.constraints下的NotBlank可以支持数值类型,javax.validation.constraints下的NotBlank是不支持数值类型的校验的
private Integer sort;
}
其中message是校验不通过的提示语句,有默认值。
三、对前端传递过来的参数进行限制
@RequestMapping("/save")
public R save(@Valid @RequestBody BrandEntity brand,BindingResult result) {
if(result.hasErrors()){
Map m = new HashMap();
result.getFieldErrors().forEach(item->{
//获取到校验不通过错误消息
String message = item.getDefaultMessage();
//获取到校验不通过字段名称
String field= item.getField();
m.put(field,message);
});
return R.error(400,"提交的数据不合法").put("data",m);
}
brandService.save(brand);
return R.ok();
}