Spring Boot接口-对请求参数进行校验-Validation
0、前提：
后端对前端传过来的参数需要进行校验，如果在controller中直接校验，则需要用大量的if else做判断各个属性的正确性，所以需要统一的校验。于是我们使用Validation进行参数校验。
1、引入pom依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
2、参数实体中使用
在实体中添加如下注解即可：
package com.dyaqi.logback.domain;
import lombok.Builder;
import lombok.Data;
import org.hibernate.validator.constraints.Length;
import org.hibernate.validator.constraints.Range;
import javax.validation.constraints.Max;
import javax.validation.constraints.NotEmpty;
import java.io.Serializable;
/**
* @author: dongyq
* @date: 2022/7/2 10:12
* @since:
* @功能描述:
*/
@Data
@Builder
public class User implements Serializable {
private static final long serialVersionUID = 1L;
@NotEmpty(message = "userId不能是空的")
private String userId;
@Length(min = 1, max = 10, message = "nick name should be 1-10")
private String nickName;
@Range(min = 0, max = 1, message = "sex should be 0-1")
private int sex;
@Max(value = 100, message = "Please input valid age")
private int age;
}
3、Controller中获取参数绑定结果
需要在方法参数处，添加@Valid或者@Validate注解（两者区别后续讲解）
3.1、JavaBean校验
@PostMapping("add")
public ResponseResult<User> addUser(@Validated @RequestBody User user) {
log.info(user.toString());
return ResponseResult.success(user);
}
注：需要在 controller 接口层的参数中使用 @Validated 标注。
3.2、简单参数校验
@GetMapping("get")
public ResponseResult<String> getUser(@NotNull(message = "用户编码不可以为空！") String userId) {
log.info(userId);
return ResponseResult.success(userId);
}
注：需要在 controller 控制器类中使用 @Validated 标注。
4、统一异常处理
通过@ControllerAdvice进行统一异常处理。
package com.dyaqi.logback.exception;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.propertyeditors.CustomDateEditor;
import org.springframework.http.HttpStatus;
import org.springframework.validation.BindException;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.InitBinder;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import javax.validation.ConstraintViolationException;
import javax.validation.ValidationException;
import java.text.SimpleDateFormat;
import java.util.Date;
/**
* @author: dongyq
* @date: 2022/7/2 10:12
* @since:
* @功能描述:
*/
@Slf4j
@RestControllerAdvice
public class ExceptionConfig {
@InitBinder
public void handleInitBinder(WebDataBinder dataBinder){
dataBinder.registerCustomEditor(Date.class,
new CustomDateEditor(new SimpleDateFormat("yyyy-MM-dd"), false));
}
@ResponseStatus(code = HttpStatus.BAD_REQUEST)
@ExceptionHandler(value = {BindException.class, ValidationException.class, MethodArgumentNotValidException.class})
public ExceptionData handleParameterVerificationException(Exception e) {
ExceptionData.ExceptionDataBuilder exceptionDataBuilder = ExceptionData.builder();
log.error("Exception: ", e);
if (e instanceof BindException) {
BindingResult bindingResult = ((MethodArgumentNotValidException) e).getBindingResult();
bindingResult.getAllErrors()
.forEach(a -> exceptionDataBuilder.error(((FieldError) a).getField() + ": " + a.getDefaultMessage()));
} else if (e instanceof ConstraintViolationException) {
if (e.getMessage() != null) {
exceptionDataBuilder.error(e.getMessage());
}
} else {
exceptionDataBuilder.error("invalid parameter");
}
return exceptionDataBuilder.build();
}
}
校验不通过，返回参数
package com.dyaqi.logback.exception;
import lombok.Builder;
import lombok.Data;
import lombok.Singular;
import java.util.List;
@Data
@Builder
public class ExceptionData {
@Singular
private final List<Object> errors;
}
5、Validation分组校验
上面的例子中，其实存在一个问题，User既可以作为add的参数（id为空），又可以作为update的参数（id不能为空），这时候怎么办呢？分组校验登场。
@Data
@Builder
public class User implements Serializable {
private static final long serialVersionUID = 1L;
@NotEmpty(message = "could not be empty") // 这里定为空，对于add时是不合适的
private String userId;
}
这时候可以使用Validation分组。
5.1、先定义分组（无需实现接口）
public interface AddValidationGroup {
}
public interface EditValidationGroup {
}
5.2、在User的userId字段添加分组
在该组内，此注解生效
package com.dyaqi.logback.domain;
import com.dyaqi.logback.validationconfig.AddValidationGroup;
import com.dyaqi.logback.validationconfig.EditValidationGroup;
import lombok.Builder;
import lombok.Data;
import org.hibernate.validator.constraints.Length;
import org.hibernate.validator.constraints.Range;
import javax.validation.constraints.Max;
import javax.validation.constraints.NotEmpty;
import java.io.Serializable;
/**
* @author: dongyq
* @date: 2022/7/2 10:12
* @since:
* @功能描述:
*/
@Data
@Builder
public class User implements Serializable {
private static final long serialVersionUID = 1L;
@NotEmpty(message = "userId不能是空的", groups = EditValidationGroup.class)
private String userId;
@Length(min = 1, max = 10, message = "nick name should be 1-10", groups = {EditValidationGroup.class, AddValidationGroup.class})
private String nickName;
@Range(min = 0, max = 1, message = "sex should be 0-1", groups = {EditValidationGroup.class, AddValidationGroup.class})
private int sex;
@Max(value = 100, message = "Please input valid age", groups = {EditValidationGroup.class, AddValidationGroup.class})
private int age;
}
5.3、controller中的接口使用校验时使用分组
@PostMapping("add")
public ResponseResult<User> add(@Validated(AddValidationGroup.class) @RequestBody User user) {
log.info(user.toString());
return ResponseResult.success(user);
}
@PostMapping("edit")
public ResponseResult<User> edit(@Validated(EditValidationGroup.class) @RequestBody User user) {
log.info(user.toString());
return ResponseResult.success(user);
}
6、@valid 和 @validated的区别
在检验Controller的入参是否符合规范时，使用@Validated或者@Valid在基本验证功能上没有太多区别。但是在分组、注解地方、嵌套验证等功能上两个有所不同：
- 分组
@Validated：提供了一个分组功能，可以在入参验证时，根据不同的分组采用不同的验证机制，这个网上也有资料，不详述。
@Valid：作为一个标准规范，还没有分组的功能。
- 注解地方
@Validated：可以用在类型、方法和方法参数上。但是不能用在成员属性（字段）上
@Valid：可以用在方法、构造函数、方法参数和成员属性（字段）上
- 嵌套类型
比如本文例子中有个address是user的一个嵌套属性, 只能用@Valid
@Data
@Builder
public class User implements Serializable {
private static final long serialVersionUID = 1L;
@Valid // 这里只能用@Valid
private Address address;
}
7、常用的注解：
标准只提供规范不提供实现，规定一些校验规范即校验注解，如@Null，@Not Null，@Pattern等.
@AssertFalse 被注释的元素只能为false
@AssertTrue 被注释的元素只能为true
@DecimalMax 被注释的元素必须小于或等于{value}
@DecimalMin 被注释的元素必须大于或等于{value}
@Digits 被注释的元素数字的值超出了允许范围(只允许在{integer}位整数和{fraction}位小数范围内)
@Email 被注释的元素不是一个合法的电子邮件地址
@Future 被注释的元素需要是一个将来的时间
@FutureOrPresent 被注释的元素需要是一个将来或现在的时间
@Max 被注释的元素最大不能超过{value}
@Min 被注释的元素最小不能小于{value}
@Negative 被注释的元素必须是负数
@NegativeOrZero 被注释的元素必须是负数或零
@NotBlank 被注释的元素不能为空
@NotEmpty 被注释的元素不能为空
@NotNull 被注释的元素不能为null
@Null 被注释的元素必须为null
@Past 被注释的元素需要是一个过去的时间
@PastOrPresent 被注释的元素需要是一个过去或现在的时间
@Pattern 被注释的元素需要匹配正则表达式"{regexp}"
@Positive 被注释的元素必须是正数
@PositiveOrZero 被注释的元素必须是正数或零
@Size 被注释的元素个数必须在{min}和{max}之间
hibernate validation是对这个规范的实现，并增加了一些其他校验注解，如@Email，@Length，@Range等
@CreditCardNumber 被注释的元素不合法的信用卡号码
@Currency 被注释的元素不合法的货币 (必须是{value}其中之一)
@EAN 被注释的元素不合法的{type}条形码
@Email 被注释的元素不是一个合法的电子邮件地址 (已过期)
@Length 被注释的元素长度需要在{min}和{max}之间
@CodePointLength 被注释的元素长度需要在{min}和{max}之间
@LuhnCheck 被注释的元素${validatedValue}的校验码不合法, Luhn模10校验和不匹配
@Mod10Check 被注释的元素${validatedValue}的校验码不合法, 模10校验和不匹配
@Mod11Check 被注释的元素${validatedValue}的校验码不合法, 模11校验和不匹配
@ModCheck 被注释的元素${validatedValue}的校验码不合法, ${modType}校验和不匹配 (已过期)
@NotBlank 被注释的元素不能为空 (已过期)
@NotEmpty 被注释的元素不能为空 (已过期)
@ParametersScriptAssert 被注释的元素执行脚本表达式"{script}"没有返回期望结果
@Range 被注释的元素需要在{min}和{max}之间
@SafeHtml 被注释的元素可能有不安全的HTML内容
@ScriptAssert 被注释的元素执行脚本表达式"{script}"没有返回期望结果
@URL 被注释的元素需要是一个合法的URL
@DurationMax 被注释的元素必须小于${inclusive == true ? '或等于' : ''}${days == 0 ? '' : days += '天'}${hours == 0 ? '' : hours += '小时'}${minutes == 0 ? '' : minutes += '分钟'}${seconds == 0 ? '' : seconds += '秒'}${millis == 0 ? '' : millis += '毫秒'}${nanos == 0 ? '' : nanos += '纳秒'}
@DurationMin 被注释的元素必须大于${inclusive == true ? '或等于' : ''}${days == 0 ? '' : days += '天'}${hours == 0 ? '' : hours += '小时'}${minutes == 0 ? '' : minutes += '分钟'}${seconds == 0 ? '' : seconds += '秒'}${millis == 0 ? '' : millis += '毫秒'}${nanos == 0 ? '' : nanos += '纳秒'}
8、自定义校验器
8.1、定义注解
package com.dyaqi.logback.validation.custom;
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* @author: dongyq
* @date: 2022/7/2 10:12
* @since:
* @功能描述:
*/
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {TelephoneNumberValidator.class}) // 指定校验器
public @interface TelephoneNumber {
String message() default "Invalid telephone number";
Class<?>[] groups() default { };
Class<? extends Payload>[] payload() default { };
}
8.2、定于校验器
package com.dyaqi.logback.validation.custom;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.regex.Pattern;
/**
* @author: dongyq
* @date: 2022/7/3 11:06
* @since:
* @功能描述: 电话号码验证器
*/
public class TelephoneNumberValidator implements ConstraintValidator<TelephoneNumber, String> {
private static final String REGEX_TEL = "0\\d{2,3}[-]?\\d{7,8}|0\\d{2,3}\\s?\\d{7,8}|13[0-9]\\d{8}|15[1089]\\d{8}";
@Override
public boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext) {
try {
return Pattern.matches(REGEX_TEL, s);
} catch (Exception e) {
return false;
}
}
}
8.3、使用
@TelephoneNumber(message = "invalid telephone number", groups = {EditValidationGroup.class, AddValidationGroup.class}) // 这里
private String telephone;
