springMVC优雅的校验参数（@Valid和@Validated）
很痛苦遇到⼤量的参数进⾏校验，在业务中还要抛出异常或者不断的返回异常时的校验信息，在代码中相当冗长, 充满了if-else这种校验代码，今天我们就来学习spring的javax.validation 注解式参数校验.
为什么要⽤validator
1. javax.validation的⼀系列注解可以帮我们完成参数校验，免去繁琐的串⾏校验
不然我们的代码就像下⾯这样:
//  localhost:8080/api/user/save/serial
/**
* ⾛串⾏校验
*
* @param userVO
* @return
*/
@PostMapping("/save/serial")
public Object save(@RequestBody UserVO userVO){
String mobile = Mobile();
//⼿动逐个参数校验~ 写法
if(StringUtils.isBlank(mobile)){
return RspDTO.paramFail("mobile:⼿机号码不能为空");
}else if(!Pattern.matches("^[1][3,4,5,6,7,8,9][0-9]{9}$", mobile)){
return RspDTO.paramFail("mobile:⼿机号码格式不对");
}
//抛出⾃定义异常等~写法
if(StringUtils.Username())){
throw new BizException(Constant.PARAM_FAIL_CODE,"⽤户名不能为空");
}
// ⽐如写⼀个map返回
if(StringUtils.Sex())){
Map<String, Object> result =new HashMap<>(5);
result.put("code", Constant.PARAM_FAIL_CODE);
result.put("msg","性别不能为空");
return result;
}
//.........各种写法 ...
userService.save(userVO);
return RspDTO.success();
}
这被⼤佬看见,⼀定说，都9102了还这么写，然后被劝退了……
2.什么是javax.validation
JSR303 是⼀套JavaBean参数校验的标准，它定义了很多常⽤的校验注解，我们可以直接将这些注解加在我们JavaBean的属性上⾯(⾯向注解编程的时代)，就可以在需要校验的时候进⾏校验了，在SpringBoot中已经包含在starter-web中，再其他项⽬中可以引⽤依赖，并⾃⾏调整版本:
<!--jsr 303-->
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>1.1.0.Final</version>
</dependency>
<!-- hibernate validator-->
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>5.2.0.Final</version>
</dependency>
3.注解说明
@NotNull：不能为null，但可以为empty(""," "," ")
@NotEmpty：不能为null，⽽且长度必须⼤于0(" "," ")
springmvc常用标签
@NotBlank：只能作⽤在String上，不能为null，⽽且调⽤trim()后，长度必须⼤于0("test")即：必须有实际字符验证注解验证的数据类型说明@AssertFalse Boolean,boolean验证注解的元素值是false @AssertTrue Boolean,boolean验证注解的元素值是true @NotNull任意类型验证注解的元素值不是null @Null任意类型验证注解的元素值是null
@Min(value=值)BigDecimal，BigInteger, byte,short, int, long，
等任何Number或CharSequence（存储的是数字）
⼦类型
验证注解的元素值⼤于等于@Min指定的value值
@Max（value=值）和@Min要求⼀样验证注解的元素值⼩于等于@Max指定的value值
@DecimalMin(value=
值)
和@Min要求⼀样验证注解的元素值⼤于等于@ DecimalMin指定的value值
@DecimalMax(value=
值)
和@Min要求⼀样验证注解的元素值⼩于等于@ DecimalMax指定的value值
@Digits(integer=整数
位数, fraction=⼩数位
数)
和@Min要求⼀样验证注解的元素值的整数位数和⼩数位数上限@Size(min=下限，验证注解的元素值的在min和max（包含）指定区间之内，如字符长度、
max=上限)字符串、Collection、Map、数组等集合⼤⼩
@Past java.util.Date,java.util.Calendar;Joda Time类库的
⽇期类型
验证注解的元素值（⽇期类型）⽐当前时间早
@Future与@Past要求⼀样验证注解的元素值（⽇期类型）⽐当前时间晚
@NotBlank CharSequence⼦类型验证注解的元素值不为空（不为null、去除⾸位空格后长度为0），不同于@NotEmpty，@NotBlank只应⽤于字符串且在⽐较时会去除字符串的⾸
位空格
@Length(min=下限,
max=上限)
CharSequence⼦类型验证注解的元素值长度在min和max区间内
@NotEmpty CharSequence⼦类型、Collection、Map、数组验证注解的元素值不为null且不为空（字符串长度不为0、集合⼤⼩不为
0）
@Range(min=最⼩值, max=最⼤值)BigDecimal,BigInteger,CharSequence, byte,
short, int, long等原⼦类型和包装类型
验证注解的元素值在最⼩值和最⼤值之间
@Email(regexp=正则
表达式,flag=标志的模
式)CharSequence⼦类型（如String）
验证注解的元素值是Email，也可以通过regexp和flag指定⾃定义的email
格式
@Pattern(regexp=正
则表达式,flag=标志的
模式)
String，任何CharSequence的⼦类型验证注解的元素值与指定的正则表达式匹配
@Valid任何⾮原⼦类型指定递归验证关联的对象如⽤户对象中有个地址对象属性，如果想在验证⽤户对象时⼀起验证地址对象的话，在地址对象上加@Valid注解即可级联
验证
验证注解验证的数据类型说明
此处只列出Hibernate Validator提供的⼤部分验证约束注解，请参考hibernate validator官⽅⽂档了解其他验证约束注解和进⾏⾃定义的验证约束注解定义。
实战演练
话不多说，直接⾛实践路线，同样使⽤的是SpringBoot的快速框架
详细代码见:
1. @Validated 声明要检查的参数
这⾥我们在控制器层进⾏注解声明
/**
* ⾛参数校验注解
*
* @param userDTO
* @return
*/
@PostMapping("/save/valid")
public RspDTO save(@RequestBody@Validated UserDTO userDTO){
userService.save(userDTO);
return RspDTO.success();
}
2. 对参数的字段进⾏注解标注
import lombok.Data;
import org.straints.Length;
import straints.*;
import java.io.Serializable;
import java.util.Date;
/**
* @author LiJing
* @ClassName: UserDTO
* @Description: ⽤户传输对象
* @date 2019/7/30 13:55
*/
@Data
public class UserDTO implements Serializable {
private static final long serialVersionUID =1L;
/*** ⽤户ID*/
@NotNull(message ="⽤户id不能为空")
private Long userId;
/** ⽤户名*/
@NotBlank(message ="⽤户名不能为空")
@Length(max =20, message ="⽤户名不能超过20个字符")
@Pattern(regexp ="^[\\u4E00-\\u9FA5A-Za-z0-9\\*]*$", message ="⽤户昵称限制：最多20字符，包含⽂字、字母和数字")
private String username;
/** ⼿机号*/
@NotBlank(message ="⼿机号不能为空")
@Pattern(regexp ="^[1][3,4,5,6,7,8,9][0-9]{9}$", message ="⼿机号格式有误")
private String mobile;
/**性别*/
private String sex;
/** 邮箱*/
@NotBlank(message ="联系邮箱不能为空")
@Email(message ="邮箱格式不对")
private String email;
/** 密码*/
private String password;
/*** 创建时间 */
@Future(message ="时间必须是将来时间")
private Date createTime;
}
3. 在全局校验中增加校验异常
MethodArgumentNotValidException是springBoot中进⾏绑定参数校验时的异常，需要在springBoot中处理，其他需要处理ConstraintViolationException异常进⾏处理.
为了优雅⼀点，我们将参数异常，业务异常，统⼀做了⼀个全局异常，将控制层的异常包装到我们⾃定义的异常中.
为了优雅⼀点，我们还做了⼀个统⼀的结构体，将请求的code，和msg,data⼀起统⼀封装到结构体中，增加了代码的复⽤性. import com.bot.dto.RspDTO;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.dao.DuplicateKeyException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.NoHandlerFoundException;
import javax.validation.ConstraintViolationException;
import javax.validation.ValidationException;
/**
* @author LiJing
* @ClassName: GlobalExceptionHandler
* @Description: 全局异常处理器
* @date 2019/7/30 13:57
*/
@RestControllerAdvice
public class GlobalExceptionHandler {
private Logger logger = Logger(getClass());
private static int DUPLICATE_KEY_CODE =1001;
private static int PARAM_FAIL_CODE =1002;
private static int VALIDATION_CODE =1003;
/**
* 处理⾃定义异常
*/
@ExceptionHandler(BizException.class)
public RspDTO handleRRException(BizException e){
<(e.getMessage(), e);
return new Code(), e.getMessage());
}
/**
* ⽅法参数校验
*/
@ExceptionHandler(MethodArgumentNotValidException.class)
public RspDTO handleMethodArgumentNotValidException(MethodArgumentNotValidException e){
<(e.getMessage(), e);
return new RspDTO(PARAM_FAIL_CODE, e.getBindingResult().getFieldError().getDefaultMessage()); }
/**
* ValidationException
*/
@ExceptionHandler(ValidationException.class)
public RspDTO handleValidationException(ValidationException e){
<(e.getMessage(), e);
return new RspDTO(VALIDATION_CODE, e.getCause().getMessage());
}
/**
* ConstraintViolationException
*/
@ExceptionHandler(ConstraintViolationException.class)
public RspDTO handleConstraintViolationException(ConstraintViolationException e){
<(e.getMessage(), e);
return new RspDTO(PARAM_FAIL_CODE, e.getMessage());
}
@ExceptionHandler(NoHandlerFoundException.class)
public RspDTO handlerNoFoundException(Exception e){
<(e.getMessage(), e);
return new RspDTO(404,"路径不存在，请检查路径是否正确");
}
@ExceptionHandler(DuplicateKeyException.class)
public RspDTO handleDuplicateKeyException(DuplicateKeyException e){
<(e.getMessage(), e);
return new RspDTO(DUPLICATE_KEY_CODE,"数据重复，请检查后提交");

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。