超详细讲解SpringBoot参数校验实例

public String addUser(User user) {

      if (user == null || user.getId() == null || user.getAccount() == null || user.getPassword() == null || user.getEmail() == null ) {

          return "对象或者对象字段不能为空" ;

      }

      if (StringUtils.isEmpty(user.getAccount()) || StringUtils.isEmpty(user.getPassword()) || StringUtils.isEmpty(user.getEmail())) {

          return "不能输入空字符串" ;

      }

      if (user.getAccount().length() < 6 || user.getAccount().length() > 11 ) {

          return "账号长度必须是6-11个字符" ;

      }

      if (user.getPassword().length() < 6 || user.getPassword().length() > 16 ) {

          return "密码长度必须是6-16个字符" ;

      }

      if (!Pattern.matches( "^[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$" , user.getEmail())) {

          return "邮箱格式不正确" ;

      }

      // 参数校验完毕后这里就写上业务逻辑

      return "success" ;

  }

< dependency >

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

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

</ dependency >

@Data

public class User {

     @NotNull (message = "用户id不能为空" )

     private Long id;

     @NotNull (message = "用户账号不能为空" )

     @Size (min = 6 , max = 11 , message = "账号长度必须是6-11个字符" )

     private String account;

     @NotNull (message = "用户密码不能为空" )

     @Size (min = 6 , max = 11 , message = "密码长度必须是6-16个字符" )

     private String password;

     @NotNull (message = "用户邮箱不能为空" )

     @Email (message = "邮箱格式不正确" )

     private String email;

}

@RestController

public class UserController {

     @PostMapping ( "/addUser" )

     public void addUser( @RequestBody @Valid User user) {

         //业务

     }

}

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 java.util.stream.Collectors;

/**

  * 全局异常处理

  *

  * @author master

  */

@RestControllerAdvice

public class ExceptionConfig {

     /**

      * 参数为实体类

      * @param e

      * @return

      */

     @ExceptionHandler (value = MethodArgumentNotValidException. class )

     public String handleValidException(MethodArgumentNotValidException e) {

         // 从异常对象中拿到ObjectError对象

         ObjectError objectError = e.getBindingResult().getAllErrors().get( 0 );

         // 然后提取错误提示信息进行返回

         return objectError.getDefaultMessage();

     }

     /**

      * 参数为单个参数或多个参数

      * @param e

      * @return

      */

     @ExceptionHandler (value = ConstraintViolationException. class )

     public String handleConstraintViolationException(ConstraintViolationException e) {

         // 从异常对象中拿到ObjectError对象

         return e.getConstraintViolations()

                 .stream()

                 .map(ConstraintViolation::getMessage)

                 .collect(Collectors.toList()).get( 0 );

     }

}

import org.springframework.validation.annotation.Validated;

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

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

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

import javax.validation.constraints.NotNull;

@RestController

@Validated

public class TestController {

     @GetMapping ( "/test" )

     public void test( @NotNull (message = "id不能为空" ) Integer id) {

     }

}

import lombok.Data;

import javax.validation.constraints.Email;

import javax.validation.constraints.NotNull;

import javax.validation.constraints.Size;

@Data

public class User {

     public interface Insert{

     }

     public interface Update{

     }

     @NotNull (message = "用户id不能为空" ,groups = Update. class )

     @Null (message = "用户id必须为空" ,groups = Integer. class )

     private Long id;

     private String account;

     private String password;

     private String email;

}

@PostMapping ( "/add" )

public void add( @RequestBody @Validated (User.Insert. class ) User user) {

}

import com.example.demo.provider.CustomSequenceProvider;

import lombok.Data;

import org.hibernate.validator.group.GroupSequenceProvider;

import javax.validation.constraints.NotEmpty;

import javax.validation.constraints.Pattern;

@Data

@GroupSequenceProvider (value = CustomSequenceProvider. class )

public class CustomGroup {

     /**

      * 类型

      */

     @Pattern (regexp = "[A|B]" , message = "类型不必须为 A|B" )

     private String type;

     /**

      * 参数A

      */

     @NotEmpty (message = "参数A不能为空" , groups = {WhenTypeIsA. class })

     private String paramA;

     /**

      * 参数B

      */

     @NotEmpty (message = "参数B不能为空" , groups = {WhenTypeIsB. class })

     private String paramB;

     /**

      * 分组A

      */

     public interface WhenTypeIsA {

     }

     /**

      * 分组B

      */

     public interface WhenTypeIsB {

     }

}

import com.example.demo.controller.CustomGroup;

import org.hibernate.validator.spi.group.DefaultGroupSequenceProvider;

import java.util.ArrayList;

import java.util.List;

public class CustomSequenceProvider implements DefaultGroupSequenceProvider<CustomGroup> {

     @Override

     public List<Class<?>> getValidationGroups(CustomGroup form) {

         List<Class<?>> defaultGroupSequence = new ArrayList<>();

         defaultGroupSequence.add(CustomGroup. class );

         if (form != null && "A" .equals(form.getType())) {

             defaultGroupSequence.add(CustomGroup.WhenTypeIsA. class );

         }

         if (form != null && "B" .equals(form.getType())) {

             defaultGroupSequence.add(CustomGroup.WhenTypeIsB. class );

         }

         return defaultGroupSequence;

     }

}

@PostMapping ( "/add" )

public void add( @RequestBody @Validated CustomGroup user) {

}

@Target ({ElementType.FIELD})

@Retention (RetentionPolicy.RUNTIME)

@Constraint (validatedBy = PhoneValidator. class )

public @interface Phone {

     String message() default "手机号码格式有误" ;

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

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

}

import javax.validation.ConstraintValidator;

import javax.validation.ConstraintValidatorContext;

import java.util.regex.Pattern;

/**

  * @author master

  */

public class PhoneValidator implements ConstraintValidator<Phone, Object> {

     @Override

     public boolean isValid(Object telephone, ConstraintValidatorContext constraintValidatorContext) {

         String pattern = "^1[3|4|5|6|7|8|9]\\d{9}$" ;

         return Pattern.matches(pattern, telephone.toString());

     }

}

@Data

public class TestAA {

     @NotEmpty (message = "id不能为空" )

     private String id;

     @NotNull

     @Valid

     private Job job;

     @Data

     public class Job {

         @NotEmpty (message = "content不能为空" )

         private String content;

     }

}

import org.hibernate.validator.HibernateValidator;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import javax.validation.Validation;

import javax.validation.Validator;

import javax.validation.ValidatorFactory;

@Configuration

public class FailFastConfig {

     @Bean

     public Validator validator() {

         ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator. class )

                 .configure()

                 // 快速失败模式

                 .failFast( true )

                 .buildValidatorFactory();

         return validatorFactory.getValidator();

     }

}