SpringBoot进行参数校验的方法详解

< dependency >

   < groupId >org.springframework.boot</ groupId >

   < artifactId >spring-boot-starter-validation</ artifactId >

</ dependency >

package com.didiplus.modules.sys.domain;

import io.swagger.annotations.ApiModel;

import io.swagger.annotations.ApiModelProperty;

import lombok.Data;

import javax.validation.constraints.Email;

import javax.validation.constraints.NotBlank;

import javax.validation.constraints.NotEmpty;

/**

  * Author: didiplus

  * Email: 972479352@qq.com

  * CreateTime: 2022/4/25

  * Desc: 字典类型领域模型

  */

@Data

@ApiModel (value = "字典类型" )

public class SysDictType {

     @ApiModelProperty ( "ID" )

     private String id;

     @NotBlank (message = "字典名称必填项" )

     @ApiModelProperty (value = "字典名称" ,example = "用户ID" )

     private String typeName;

     @NotBlank (message = "字典编码不能为空" )

     @ApiModelProperty (value = "字典编码" )

     private String typeCode;

     @Email (message = "请填写正确的邮箱地址" )

     @ApiModelProperty (value = "字典编码" )

     private String email;

     @ApiModelProperty (value = "字典描述" )

     private String description;

     @NotBlank (message = "字典状态不能为空" )

     @ApiModelProperty (value = "字典状态" )

     private String enable;

}

package com.didiplus.modules.sys.controller;

import com.didiplus.modules.sys.domain.SysDictType;

import io.swagger.annotations.Api;

import io.swagger.annotations.ApiOperation;

import io.swagger.v3.oas.annotations.parameters.RequestBody;

import org.springframework.validation.annotation.Validated;

import org.springframework.web.bind.annotation.PostMapping;

import org.springframework.web.bind.annotation.PutMapping;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

/**

  * Author: didiplus

  * Email: 972479352@qq.com

  * CreateTime: 2022/4/25

  * Desc: 数据字典控制器

  */

@RestController

@Api (tags = "数据字典" )

@RequestMapping ( "/api/sys/dictType" )

public class SysDictTypeController {

     @ApiOperation ( "字典添加" )

     @PostMapping ( "/add" )

     public SysDictType add( @Validated @RequestBody SysDictType sysDictType) {

         return   sysDictType;

     }

     @ApiOperation ( "字典修改" )

     @PutMapping ( "/edit" )

     public SysDictType edit( @Validated @RequestBody SysDictType sysDictType) {

         return   sysDictType;

     }

}

package com.didiplus.common.web.response.Handler;

import com.didiplus.common.web.response.Result;

import org.springframework.http.HttpStatus;

import org.springframework.http.ResponseEntity;

import org.springframework.validation.BindException;

import org.springframework.validation.ObjectError;

import org.springframework.web.bind.MethodArgumentNotValidException;

import org.springframework.web.bind.annotation.ExceptionHandler;

import org.springframework.web.bind.annotation.RestControllerAdvice;

import javax.validation.ConstraintViolation;

import javax.validation.ConstraintViolationException;

import javax.validation.ValidationException;

import java.util.stream.Collectors;

/**

  * Author: didiplus

  * Email: 972479352@qq.com

  * CreateTime: 2022/4/24

  * Desc:  默认全局异常处理。

  */

@RestControllerAdvice

public class RestExceptionHandler {

     /**

      * 默认全局异常处理。

      * @param e the e

      * @return ResultData

      */

     @ExceptionHandler (value = {BindException. class , ValidationException. class , MethodArgumentNotValidException. class })

     public ResponseEntity<Result<String>> handleValidatedException(Exception e) {

             Result<String>  result = null ;

             if (e instanceof   MethodArgumentNotValidException) {

                 MethodArgumentNotValidException ex =(MethodArgumentNotValidException)  e;

                 result = Result.failure(HttpStatus.BAD_REQUEST.value(),

                                 ex.getBindingResult().getAllErrors().stream()

                                         .map(ObjectError::getDefaultMessage)

                                         .collect(Collectors.joining( ";" ))

                                 );

             } else   if (e instanceof ConstraintViolationException){

                 ConstraintViolationException ex = (ConstraintViolationException) e;

                 result = Result.failure(HttpStatus.BAD_REQUEST.value(),

                                         ex.getConstraintViolations().stream()

                                                 .map(ConstraintViolation::getMessage)

                                                 .collect(Collectors.joining( ";" ))

                                         );

             } else   if (e instanceof BindException) {

                 BindException  ex = (BindException ) e;

                 result = Result.failure(HttpStatus.BAD_REQUEST.value(),

                                         ex.getAllErrors().stream()

                                                 .map(ObjectError::getDefaultMessage)

                                                 .collect(Collectors.joining( ";" ))

                                         );

             }

             return new ResponseEntity<>(result,HttpStatus.BAD_REQUEST);

     }

}

package com.didiplus.common.annotation;

import javax.validation.Constraint;

import javax.validation.Payload;

import java.lang.annotation.Documented;

import java.lang.annotation.Repeatable;

import java.lang.annotation.Retention;

import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;

import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**

  * Author: didiplus

  * Email: 972479352@qq.com

  * CreateTime: 2022/4/26

  * Desc:

  */

@Target ({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})

@Retention (RUNTIME)

@Repeatable (EnumString.List. class )

@Documented

@Constraint (validatedBy = EnumStringValidator. class ) //标明由哪个类执行校验逻辑

public @interface EnumString {

     String message() default "value not in enum values." ;

     Class<?>[] groups() default {};

     Class<? extends Payload>[] palyload() default {};

     /**

      * @return date must in this value array

      */

     String[] value();

     /**

      * Defines several {@link EnumString} annotations on the same element.

      *

      * @see EnumString

      */

     @Target ({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})

     @Retention (RUNTIME)

     @Documented

     @interface List {

         EnumString[] value();

     }

}

package com.didiplus.common.annotation;

import javax.validation.ConstraintValidator;

import javax.validation.ConstraintValidatorContext;

import java.util.Arrays;

import java.util.List;

/**

  * Author: didiplus

  * Email: 972479352@qq.com

  * CreateTime: 2022/4/26

  * Desc:

  */

public class EnumStringValidator implements ConstraintValidator<EnumString,String> {

     private List<String> enumStringList;

     @Override

     public void initialize(EnumString constraintAnnotation) {

         enumStringList = Arrays.asList(constraintAnnotation.value());

     }

     @Override

     public boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext) {

         if (value == null ) {

             return true ;

         }

         return enumStringList.contains(value);

     }

}

@ApiModelProperty (value = "性别" )

@EnumString (value = { "F" , "M" }, message= "性别只允许为F或M" )

private String sex;

package com.didiplus.common.base;

import javax.validation.groups.Default;

/**

  * Author: didiplus

  * Email: 972479352@qq.com

  * CreateTime: 2022/4/26

  * Desc:

  */

public interface ValidGroup extends Default {

     interface Crud extends ValidGroup{

         interface Create extends Crud{

         }

         interface Update extends Crud{

         }

         interface Query extends Crud{

         }

         interface Delete extends Crud{

         }

     }

}

@Null (groups = ValidGroup.Crud.Create. class )

@NotNull (groups = ValidGroup.Crud.Update. class ,message = "字典ID不能为空" )

@ApiModelProperty ( "ID" )

private String id;