Validation校验参数-API、自定义、手动校验

依赖

        <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-validation</artifactId></dependency>

约束性注解

注解作用
@Null 被注释的元素_值必须为 null
@NotNull 被注释的元素_值必须不为 null
@Pattern(regex=) 被注释的元素字符串_必须符合指定的正则表达式
@Size(max=, min=) 集合元素数量必须在min和max范围内
@AssertTrue 被注释的元素必须为 true
@AssertFalse 被注释的元素必须为 false
@Min(value) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@Max(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@Range(min,max) 数字必须在min和max范围内
@DecimalMin(value) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@DecimalMax(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@Digits (integer, fraction) 被注释的元素必须是一个数字，其值必须在可接受的范围内
@Past 被注释的元素必须是一个过去的日期
@Future 被注释的元素必须是一个将来的日期
@Email 字符串必须是Email地址
@SafeHtml 字符串必须是安全的html
@URL 字符串必须是合法的URL
@CreditCardNumber(ignoreNonDigitCharacters=) 字符串必须是信用卡号,按照美国的标准验证
@Size(max,min) 限制字符长度必须在min到max之间

@Validated与@Valid的简单对比说明

@Valid注解与@Validated注解功能大部分类似；两者的不同主要在于:@Valid属于javax下的，而@Validated属于spring下；@Valid支持嵌套校验、而@Validated不支持，@Validated支持分组，而@Valid不支持

Demo


import lombok.Data;
import lombok.ToString;import javax.validation.constraints.Min;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;@Data
@ToString
public class DevEquipment {@NotBlank(message = "aa")@Min(value = 6, message = "aa")private String a;@NotBlank(message = "bb")@Size(min = 6,message = "bb")private String b;@NotBlank(message = "cc")@Pattern(regexp = "1|2|3", message = "cc")private String c;@Email(message="非法邮件地址")private String email;}

校验

自动校验

Controller添加@Valid或者@Validated都可以

@RestController
@RequestMapping("/")
public class UserController {@RequestMapping("testValidation")public String testValidation(@Valid @RequestBody DevEquipment devEquipment) {return "success";}
}

手动校验

 private String validateDevEquipment(DevEquipment devEquipment) {//先进行参数校验StringBuilder returnSb = new StringBuilder();Set<ConstraintViolation<DevEquipment>> validateResult = Validation.buildDefaultValidatorFactory().getValidator().validate(devEquipment, Default.class);if (validateResult.size() > 0) {Iterator<ConstraintViolation<DevEquipment>> it = validateResult.iterator();while (it.hasNext()) {ConstraintViolation<DevEquipment> cv = it.next();returnSb.append(cv.getPropertyPath() + "：" + cv.getMessage()).append(";");}}return returnSb.toString();}

全局异常拦截

/*** 参数合法性校验异常* @param exception* @return*/
@ResponseBody
@ExceptionHandler(MethodArgumentNotValidException.class)
public String validationBodyException(MethodArgumentNotValidException exception){StringBuffer buffer = new StringBuffer();BindingResult result  = exception.getBindingResult();if (result.hasErrors()) {List<ObjectError> errors = result.getAllErrors();errors.forEach(p ->{FieldError fieldError = (FieldError) p;log.error("Data check failure : object{"+fieldError.getObjectName()+"},field{"+fieldError.getField()+"},errorMessage{"+fieldError.getDefaultMessage()+"}");buffer.append(fieldError.getDefaultMessage()).append(",");});}BaseResponse response = new BaseResponse(BusinessCodeEnum.INVALID_PARAM);response.setRespMsg(buffer.toString().substring(0, buffer.toString().length()-1));return JSONObject.toJSONString(response);
}

自定义异常

日期格式

import org.apache.commons.lang3.StringUtils;import javax.validation.*;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import java.text.SimpleDateFormat;import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;/*** @author 67546*/
@Documented
@Constraint(validatedBy = {DateValid.DateValidator.class})
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
@ReportAsSingleViolation
public @interface DateValid {String message() default "日期格式不正确";Class<?>[] groups() default {};Class<? extends Payload>[] payload() default {};/*** 有效的日期格式*/String[] format() default {};@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER})@Retention(RUNTIME)@Documented@interface List {DateValid[] value();}class DateValidator implements ConstraintValidator<DateValid, String> {private String[] formats;@Overridepublic void initialize(DateValid constraintAnnotation) {formats = constraintAnnotation.format();}@Overridepublic boolean isValid(String value, ConstraintValidatorContext context) {if(StringUtils.isBlank(value)){return true;}if (formats.length == 0) {return true;}for (String string : formats) {try {SimpleDateFormat formatter = new SimpleDateFormat(string);formatter.parse(value);} catch (Exception e) {return false;}}return true;}}
}

查库的

import cn.hutool.extra.spring.SpringUtil;
import com.zjhcsoft.mapper.UseUnitMapper;
import org.apache.commons.lang3.StringUtils;import javax.validation.*;
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 Ybb* @Classname UseUnitCodeVScope* @Description TODO* @Date 2022/2/8 15:49* @Created by Ybb*/@Documented
@Constraint(validatedBy = {UseUnitCodeScope.UseUnitCodeValidator.class})
@Target({TYPE, ANNOTATION_TYPE, FIELD})
@Retention(RUNTIME)
@ReportAsSingleViolation
public @interface UseUnitCodeScope {String message() default "{xx}";Class<?>[] groups() default {};Class<? extends Payload>[] payload() default {};class UseUnitCodeValidator implements ConstraintValidator<UseUnitCodeScope, String> {private UseUnitMapper useUnitMapper;@Overridepublic void initialize(UseUnitCodeScope constraintAnnotation) {this.useUnitMapper = SpringUtil.getBean("useUnitMapper");}@Overridepublic boolean isValid(String value, ConstraintValidatorContext context) {if(StringUtils.isBlank(value)){return false;}int count = useUnitMapper.queryUseUnitCode(value);if (count > 0) {return true;}return false;}}
}