@Validated基础使用

绝地灬酷狼 2023-01-09 12:52 125阅读 0赞

*  ### 添加依赖 ###

<dependency>
                <groupId>javax.validation</groupId>
                <artifactId>validation-api</artifactId>
                <version>1.1.0.Final</version>
            </dependency>
            
            <dependency>
                <groupId>org.hibernate</groupId>
                <artifactId>hibernate-validator</artifactId>
                <version>5.2.0.Final</version>
            </dependency>

*  ###  注解功能说明 ###
 *  ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTU0NjA0_size_16_color_FFFFFF_t_70][]
 *  ### 实体类 ###

public class Book {
        private long id;
    
        /**
         * 书名
         */
        @NotEmpty(message = "书名不能为空")
        private String bookName;
        /**
         * ISBN号
         */
        @NotNull(message = "ISBN号不能为空")
        private String bookIsbn;
        /**
         * 单价
         */
        @DecimalMin(value = "0.1",message = "单价最低为0.1")
        private double price; // getter setter .......  
    }

*  ### Controller层 ###

在需要校验的实体对象添加@Validated注解

@RequestMapping(value = "/book", method = RequestMethod.POST)
        public void addBook(@RequestBody @Validated Book book) {
            
        }

*  ###   添加RestController统一异常处理handler ###

import lombok.extern.slf4j.Slf4j;
    import org.springframework.http.converter.HttpMessageConversionException;
    import org.springframework.validation.BindingResult;
    import org.springframework.validation.FieldError;
    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 java.util.List;
    
    /**
     * 校验统一处理异常
     * 如果校验不通过，就在异常中处理，统一输出格式
     **/
    @Slf4j
    @RestControllerAdvice
    public class RequestValidateExceptionHandle {
    
        /**
         * 校验错误拦截处理
         *
         * @param exception 错误信息集合
         * @return 错误信息
         */
        @ExceptionHandler(MethodArgumentNotValidException.class)
        public Message validationBodyException(MethodArgumentNotValidException exception) {
            BindingResult result = exception.getBindingResult();
            String message = "";
            if (result.hasErrors()) {
                List<ObjectError> errors = result.getAllErrors();
                if (errors != null) {
                    errors.forEach(p -> {
                        FieldError fieldError = (FieldError) p;
                        log.error("Data check failure : object{" + fieldError.getObjectName() + "},field{" + fieldError.getField() +
                                "},errorMessage{" + fieldError.getDefaultMessage() + "}");
    
                    });
                    if (errors.size() > 0) {
                        FieldError fieldError = (FieldError) errors.get(0);
                        message = fieldError.getDefaultMessage();
                    }
                }
            }
            return Message.fail("".equals(message) ? "请填写正确信息" : message);
        }
    
        /**
         * 参数类型转换错误
         *
         * @param exception 错误
         * @return 错误信息
         */
        @ExceptionHandler(HttpMessageConversionException.class)
        public Message parameterTypeException(HttpMessageConversionException exception) {
            log.error(exception.getCause().getLocalizedMessage());
            return Message.fail("类型转换错误");
    
        }
    
    }

参考文档：

[https://www.cnblogs.com/lovechengyu/p/13094198.html][https_www.cnblogs.com_lovechengyu_p_13094198.html]

[https://www.cnblogs.com/softidea/p/9712571.html][https_www.cnblogs.com_softidea_p_9712571.html]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTU0NjA0_size_16_color_FFFFFF_t_70]: /images/20221119/9ba15c661c314e23b4849d9f23898d9f.png
[https_www.cnblogs.com_lovechengyu_p_13094198.html]: https://www.cnblogs.com/lovechengyu/p/13094198.html
[https_www.cnblogs.com_softidea_p_9712571.html]: https://www.cnblogs.com/softidea/p/9712571.html