springboot使用hibernate-validator校验请求参数

版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/u010180738/article/details/81613126

作为Web后台开发人员，对于api接口进行参数校验是非常必要的操作。可以说不进行参数校验是不负责任的开发。对参数校验才能使接口更加安全健壮。每个业务接口都有大量的参数需要校验。如果将这些参数放置到业务中使用if,else之类的判断则会显得代码不简洁。多了很多不必要的参数校验代码。验证代码繁琐，重复劳动。
在开发中使用hibernate-validator框架进行参数校验能非常友好的解决代码繁琐，重复劳动。Hibernate Validator 是 Bean Validation 的参考实现 . Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现，除此之外还有一些附加的 constraint。如果想了解更多有关 Hibernate Validator 的信息，请查看 http://www.hibernate.org/subprojects/validator.html

package com.xfl.boot.common.config;

import org.hibernate.validator.HibernateValidator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.validation.beanvalidation.MethodValidationPostProcessor;

import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.ValidatorFactory;

/**
 * Created by XFL
 * time on 2018/8/12 21:51
 * description:
 */
@Configuration
public class ValidatorConfiguration {
    @Bean
    public Validator validator() {
        ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
                .configure()
                //failFast：true  快速失败返回模式(只要有一个验证失败，则返回)    false 普通模式(会校验完所有的属性，然后返回所有的验证失败信息)
                .addProperty("hibernate.validator.fail_fast", "true")
                .buildValidatorFactory();
        Validator validator = validatorFactory.getValidator();
        return validator;
    }

    @Bean
    public MethodValidationPostProcessor methodValidationPostProcessor() {
        MethodValidationPostProcessor postProcessor = new MethodValidationPostProcessor();
        //设置validator模式为快速失败返回
        postProcessor.setValidator(validator());
        return postProcessor;
    }
}

  @RequestMapping(value = "validation", method = RequestMethod.POST)
    public UserVo testValidation(@RequestBody @Valid UserVo userVo) {
        return userVo;
    }
    //Controller上需要增加注解@Validated
    @RequestMapping(value = "val", method = RequestMethod.GET)
    public UserVo testVal(@RequestParam("phone")
                          @Pattern(regexp = "^((13[0-9])|(15[^4])|(18[0-9])|(17[0-8])|(147)|(166)|(199)|(198))\\\\d{8}$", message = "手机号码不正确")
                                  String phone) {
        return new UserVo();
    }

将参数校验失败异常进行转换

package com.xfl.boot.common.exception;

import com.xfl.boot.entity.ResponseData;
import org.springframework.validation.ObjectError;
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;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletResponse;
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import java.util.List;

/**
 * Created by XFL
 * time on 2017/6/20 21:53
 * description:统一异常处理
 */
@ControllerAdvice(annotations = RestController.class)
public class GlobalExceptionHandler {
    @ExceptionHandler(Exception.class)
    //在返回自定义相应类的情况下必须有，这是@ControllerAdvice注解的规定
    @ResponseBody
    public ResponseData<Object> exceptionHandler(Exception e, HttpServletResponse response) {
        System.out.println(e);
        ResponseData<Object> responseData = new ResponseData<Object>();
        //参数校验未通过异常 @RequestBody参数校验失败
        if (e instanceof MethodArgumentNotValidException) {
            MethodArgumentNotValidException exception = (MethodArgumentNotValidException) e;
            List<ObjectError> errors = exception.getBindingResult().getAllErrors();
            StringBuffer sb = new StringBuffer();
            for (ObjectError error : errors) {
                String message = error.getDefaultMessage();
                sb.append(message).append(";");
            }
            responseData.setMsg(sb.toString());
        } else if (e instanceof ConstraintViolationException) {
            //@RequestParam 参数校验失败
            ConstraintViolationException exception = (ConstraintViolationException) e;
            StringBuffer sb = new StringBuffer();
            for (ConstraintViolation constraint : exception.getConstraintViolations()) {
                sb.append(constraint.getInvalidValue()).append("值不正确，").append(constraint.getMessage()).append("；");
            }
            responseData.setMsg(sb.toString());
        } else {
            //其他异常
            responseData.setMsg(e.getMessage());
        }
        responseData.setCode(9999);

        return responseData;
    }
}

手动对指定bean进行参数校验

/**
     * 使用hibernate的注解来进行验证
     */
    private static Validator validator = Validation
            .byProvider(HibernateValidator.class).configure().failFast(false).buildValidatorFactory().getValidator();

    /**
     * 功能描述: <br>
     * 〈注解验证参数〉
     *
     * @param obj
     */
    public static <T> void validate(T obj) {
        Set<ConstraintViolation<T>> constraintViolations = validator.validate(obj);
        if (constraintViolations != null && constraintViolations.size() > 0) {
            StringBuffer sb = new StringBuffer();
            for (ConstraintViolation constraint : constraintViolations) {
                sb.append(constraint.getInvalidValue()).append("值不正确，").append(constraint.getMessage()).append("；");
            }
            System.out.println(sb.toString());
//            throw new AppExpection(1001,sb.toString());
        }
    }

    public static void main(String[] args) {
        UserVo userVo = new UserVo();
        userVo.setName("5");
        userVo.setPhone("1235655");
        validate(userVo);
    }

以下是对hibernate-validator中部分注解进行描述：

@AssertTrue 用于boolean字段，该字段只能为true
@AssertFalse 该字段的值只能为false
@CreditCardNumber 对信用卡号进行一个大致的验证
@DecimalMax 只能小于或等于该值
@DecimalMin 只能大于或等于该值
@Digits(integer=,fraction=) 检查是否是一种数字的整数、分数,小数位数的数字
@Email 检查是否是一个有效的email地址
@Future 检查该字段的日期是否是属于将来的日期
@Length(min=,max=) 检查所属的字段的长度是否在min和max之间,只能用于字符串
@Max 该字段的值只能小于或等于该值
@Min 该字段的值只能大于或等于该值
@NotNull 不能为null
@NotBlank 不能为空，检查时会将空格忽略
@NotEmpty 不能为空，这里的空是指空字符串
@Null 检查该字段为空
@Past 检查该字段的日期是在过去
@Pattern(regex=,flag=) 被注释的元素必须符合指定的正则表达式
@Range(min=,max=,message=) 被注释的元素必须在合适的范围内
@Size(min=, max=) 检查该字段的size是否在min和max之间，可以是字符串、数组、集合、Map等
@URL(protocol=,host,port) 检查是否是一个有效的URL，如果提供了protocol，host等，则该URL还需满足提供的条件
@Valid 该注解主要用于字段为一个包含其他对象的集合或map或数组的字段，或该字段直接为一个其他对象的引用，这样在检查当前对象的同时也会检查该字段所引用的对象

参考文章：
https://www.cnblogs.com/mr-yang-localhost/p/7812038.html#_label3_1