Springboot hibernate-validator 6.x校驗

================================

©Copyright 蕃薯耀2021-12-23

https://www.cnblogs.com/fanshuyao/

一、版本資訊及maven依賴

hibernate-validator 7.x版本有問題，暫時以6.2.1.Final為例，6.2.1.Final版本解決了Log4j版本的漏洞

<properties>
        <!-- JDK版本 -->
        <java.version>1.8</java.version
 
>
        <!-- 構建時編碼 -->    
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <!-- 輸出時編碼 -->
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <hutool.version>5.7.16</hutool.version
 
>
        
        <hibernate-validator.version>6.2.1.Final</hibernate-validator.version>
    </properties>

記得引入：spring-boot-starter-validation

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</
 
artifactId>
        </dependency>
        
        <dependency>
            <groupId>org.hibernate.validator</groupId>
            <artifactId>hibernate-validator</artifactId>
        </dependency>
        
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>${hutool.version}</version>
        </dependency>

二、定義實體bean

 
import javax.validation.constraints.Email;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotBlank;
 
import org.hibernate.validator.constraints.Length;
 
public class User {
 
    private Integer id;
    @Min(18)
    @Max(200)
    private Integer age;
    
    @NotBlank(message = "姓名不能為空")
    @Length(min = 2, max = 6, message = "長度必須在{min}和{max}個字元之間")
    private String name;
    
    @NotBlank(message = "電子郵箱不能為空")
    @Email(message = "電子郵箱格式不正確")
    private String email;
    
    
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getEmail() {
        return email;
    }
    public void setEmail(String email) {
        this.email = email;
    }
    @Override
    public String toString() {
        return "User [id=" + id + ", age=" + age + ", name=" + name + ", email=" + email + "]";
    }
    
    
    
}

三、測試Controller

需要在類上面加上註解：@Validated

 
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
 
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
@Validated
public class UserController {
 
    @RequestMapping("/get")
    public User get(@NotNull(message = "id不能為空") Integer id, 
            @NotNull(message = "姓名不能為空") String name) {
        User user = new User();
        user.setName("lisi");
        user.setId(id);
        return user;
    }
    
    
    @RequestMapping("/save")
    public User get(@Valid User user) {
        return user;
    }
    
}

四、hibernate-validator全域性異常處理

 
import java.util.List;
import java.util.Set;
 
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
 
import org.springframework.http.HttpStatus;
import org.springframework.validation.BindException;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
 
@ControllerAdvice
public class GlobalException {
    
    public static final String DELIM = "，";
 
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public String exceptionHandler(HttpServletRequest request, HttpServletResponse response, 
            Exception e) {
        
        
        if(e instanceof ConstraintViolationException) {
            //@RequestParam上引數validate失敗後丟擲的異常
            
            ConstraintViolationException cve = (ConstraintViolationException) e;
 
            Set<ConstraintViolation<?>> violations = cve.getConstraintViolations();
            StringBuffer sb = new StringBuffer("");
            for (ConstraintViolation<?> constraintViolation : violations) {
                sb.append(constraintViolation.getMessage()).append(DELIM);
            }
            if(sb.indexOf(DELIM) > -1) {
                sb.deleteCharAt(sb.length() - 1);
            }
            System.out.println("ConstraintViolationException sb="+sb);
            
            response.setStatus(HttpStatus.BAD_REQUEST.value());
            return sb.toString();
            
        }else if(e instanceof BindException) {
            //@RequestParam上實體物件validate失敗後丟擲的異常
            
            BindException be = (BindException) e;
            System.out.println("be.getMessage()="+be.getMessage());
            
            List<FieldError> fieldErrors = be.getBindingResult().getFieldErrors();
            StringBuffer sb = new StringBuffer("");
            for (FieldError fieldError : fieldErrors) {
                sb.append(fieldError.getDefaultMessage()).append(DELIM);
                //System.out.println("fieldError.getDefaultMessage() =" + fieldError.getDefaultMessage());
            }
            if(sb.indexOf(DELIM) > -1) {
                sb.deleteCharAt(sb.length() - 1);
            }
            System.out.println("BindException sb="+sb);
            response.setStatus(HttpStatus.BAD_REQUEST.value());
            return sb.toString();
            
            
        }else if(e instanceof MethodArgumentNotValidException) {
            //@RequestBody上validate失敗後丟擲的異常
            
            MethodArgumentNotValidException mave = (MethodArgumentNotValidException) e;
            System.out.println("mave.getMessage() = " + mave.getMessage());
            
            List<FieldError> fieldErrors = mave.getBindingResult().getFieldErrors();
            StringBuffer sb = new StringBuffer("");
            for (FieldError fieldError : fieldErrors) {
                sb.append(fieldError.getDefaultMessage()).append(DELIM);
                //System.out.println("fieldError.getDefaultMessage() =" + fieldError.getDefaultMessage());
            }
            if(sb.indexOf(DELIM) > -1) {
                sb.deleteCharAt(sb.length() - 1);
            }
            System.out.println("MethodArgumentNotValidException sb="+sb);
            response.setStatus(HttpStatus.BAD_REQUEST.value());
            return sb.toString();
        }
        
        return "系統異常";
    }
}

五、hibernate-validator快速校驗

hibernate-validator預設會全部校驗後再返回所有錯誤結果，為了讓hibernate-validator檢查到第一個錯誤馬上返回結果，需要配置快速校驗

 
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;
 
import org.hibernate.validator.HibernateValidator;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.validation.beanvalidation.MethodValidationPostProcessor;
 
@Configuration
public class ValidatorConfiguration {
 
    /**
     * 快速返回校驗器
     * @return
     */
    @Bean
    @ConditionalOnMissingBean(value = Validator.class)
    public Validator validator() {
        
        //hibernate-validator 6.x沒問題，7.x有問題
        ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
                .configure()
                .failFast(true)
                //.addProperty("hibernate.validator.fail_fast", "true")
                .buildValidatorFactory();
        
        return validatorFactory.getValidator();
    }
    
    
    /**
     * 設定快速校驗，返回方法校驗處理器
     * @return
     */
    @Bean
    @ConditionalOnMissingBean(value = MethodValidationPostProcessor.class)
    public MethodValidationPostProcessor methodValidationPostProcessor() {
        MethodValidationPostProcessor postProcessor = new MethodValidationPostProcessor();
        postProcessor.setValidator(validator());
        return postProcessor;
    }
    
}

（時間寶貴，分享不易，捐贈回饋，^_^）

================================

©Copyright 蕃薯耀2021-12-23

https://www.cnblogs.com/fanshuyao/