SpringBoot整合FluentValidator校验框架,以及简单使用和简单工具类的编写

1.FluentValidator介绍

FluentValidator是百度的一个开源验证插件，我习惯这样叫它，简单的说，它就是为了校验数据简单并且复用而存在的。

通过这个插件，你可以对接收到的数据进行你所需要的校验，并且返回对应的错误信息，同时它还提供一些比较不错的显示错误的功能。

其实我主要使用它的原因在于，它的复用性高和代码简洁。

2.整合FluentValidator

具体的细节官方文档已经写的非常好了,我们这里只提供简单的集成和使用,以便于你快速入门使用.
>>>>官方文档<<<<

  2.1 jar包整合

<!--fluent-validator 集成 spring 需要添加的依赖-->
	<dependency>
		<groupId>com.baidu.unbiz</groupId>
		<artifactId>fluent-validator-spring</artifactId>
		<version>1.0.9</version>
	</dependency>

  2.2 添加配置类

fluent-validate 与 spring 结合使用 annotation 方式进行参数校验，需要借助于 spring 的 AOP， fluent-validate 提供了处理类 FluentValidateInterceptor， 但是 fluent-validate 提供的默认验证回调类 DefaultValidateCallback对校验失败的情况并没有处理，所以需要自行实现一个

/**
 * 自定义异常回调类
 * @author: wangxu
 * @date: 2020/3/26 13:58
 *
 *fluent-validate 与 spring 结合使用 annotation 方式进行参数校验，需要借助于 spring 的 AOP，
 *fluent-validate 提供了处理类 FluentValidateInterceptor，
 *但是 fluent-validate 提供的默认验证回调类 DefaultValidateCallback
 *对校验失败的情况并没有处理，所以需要自行实现一个
 */
public class HussarValidateCallBack extends DefaultValidateCallback implements ValidateCallback {
    @Override
    public void onSuccess(ValidatorElementList validatorElementList) {
        super.onSuccess(validatorElementList);
    }

    @Override
    public void onFail(ValidatorElementList validatorElementList, List<ValidationError> errors) {
        throw new RuntimeException(errors.get(0).getErrorMsg());
    }

    @Override
    public void onUncaughtException(Validator validator, Exception e, Object target) {
        throw new RuntimeException(e);
    }
}

  2.3 注册ValidateCallback

@Configuration
public class FluentValidatorConfig {
    @Bean
    public FluentValidateInterceptor fluentValidateInterceptor(){
        FluentValidateInterceptor fluentValidateInterceptor = new FluentValidateInterceptor();
        fluentValidateInterceptor.setCallback(validateCallback());
        return fluentValidateInterceptor;
    }
    @Bean
    public ValidateCallback validateCallback(){
        return new HussarValidateCallBack();
    }
    //使用BeanNameAutoProxyCreator来创建代理
    @Bean
    public BeanNameAutoProxyCreator beanNameAutoProxyCreator(){
        BeanNameAutoProxyCreator proxyCreator = new BeanNameAutoProxyCreator();
        //设置要创建代理的那些Bean的名字
        proxyCreator.setBeanNames("*Controller");
        //设置拦截链名字(这些拦截器是有先后顺序的)
        proxyCreator.setInterceptorNames("fluentValidateInterceptor");
        return proxyCreator;

    }
}

  2.4 校验错误拦截处理

@RestControllerAdvice注解说明.

/**
 * @author: wangxu
 * @date: 2020/3/26 15:15
 */
//这个注解是Spring3.0以后的一个Controller的增强,他会作用在一起使用requestMapping的方法上,
//并且被 @ExceptionHandler、@InitBinder、@ModelAttribute 注解的方法，都会作用在 被 @RequestMapping 注解的方法上。(Spring里面的方法增强)
//目前的理解类似于使用了Spring里的通知,理解还不深刻(请自行百度)
@RestControllerAdvice
@Slf4j
public class RestExceptionHandler {
    /**
     * 校验错误拦截处理
     * 使用@RequestBody接收入参时,校验失败抛MethodArgumentNotValidException 异常
     */
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public BaseResult handler(MethodArgumentNotValidException e) {
        log.error("MethodArgumentNotValidException handler", e);
        BindingResult bindingResult = e.getBindingResult();
        if (bindingResult.hasFieldErrors()) {
            return BaseResult.failResultCreate(bindingResult.getFieldError().getDefaultMessage());
        }
        return BaseResult.failResultCreate("parameter is not valid");
    }

    /**
     * 校验错误拦截处理
     * 使用 @RequestBody 接收入参时，数据类型转换失败抛 HttpMessageConversionException 异常
     */
    @ExceptionHandler(value = HttpMessageConversionException.class)
    public BaseResult handler(HttpMessageConversionException e) {
        log.error("HttpMessageConversionException handler", e);
        return BaseResult.failResultCreate(e.getMessage());
    }

    /**
     * 全局异常处理
     */
    @ExceptionHandler(value = Exception.class)
    public BaseResult handler(Exception e) {
        log.error("exception handler", e);
        return BaseResult.failResultCreate(e.getMessage());
    }
}

  2.5 添加校验类

/**
 * @author: wangxu
 * @date: 2020/3/27 13:56
 */
public class IsNotBlank extends ValidatorHandler<String> implements Validator<String> {
    @Override
    public boolean validate(ValidatorContext context, String s) {
        if(StringUtils.isEmpty(s)){
            context.addError(ValidationError.create("值不能为空")
                    .setErrorCode(-1)
                    .setField("名字")
                    .setInvalidValue("2X"));
            return false;
        }
        return true;
    }
}

  2.6 测试运行

/**
 * @author: wangxu
 * @date: 2020/3/18 15:16
 */
@RestController
@RequestMapping(value = "/sys")
@Slf4j
@Api(value = "用户接口", description = "用户管理")
public class SysLoginUserController {
    @Resource
    SysLoginUserService sysLoginUserService;


    @ApiOperation(value = "登录接口", response = SysUser.class)
    @PostMapping(value = "/login")
    public Object logIn(SysUser sysUser) {
        //todo:这个位置以后要改成校验框架
        ComplexResult ret = FluentValidator.checkAll()
                .on(sysUser.getUserName(), new IsNotBlank())
                .on(sysUser.getPassWord(), new IsNotBlank())
                //只有执行到这一句的时候校验才开始执行(也就是我们自定义的NotNullValidator方法才开始运行)类似于懒加载-只有用到才执行.
                .doValidate()
                .result(ResultCollectors.toComplex());

        log.info("ComplexResult:" + ret);
        Result rets = FluentValidator.checkAll()
                .on(sysUser.getUserName(), new IsNotBlank())
                .on(sysUser.getPassWord(), new IsNotBlank())
                //只有执行到这一句的时候校验才开始执行(也就是我们自定义的NotNullValidator方法才开始运行)类似于懒加载-只有用到才执行.
                .doValidate()
                .result(toSimple());
        log.info("toSimple:" + ret);
        return sysLoginUserService.login(sysUser);
    }

  2.7 运行结果

这里面我要说一下.我验证了两次分别获取了相应的结果,来却分最后传入参数的区别,而且我只把有用的日志截取出来了.

2020-03-27 15:43:57.683  INFO 18156 --- [nio-8220-exec-1] c.w.s.controller.SysLoginUserController  : ComplexResult:Result{isSuccess=false, errors=[ValidationError{errorCode=-1, errorMsg='值不能为空', field='名字', invalidValue=2X}], timeElapsedInMillis=0}
2020-03-27 15:44:21.074  INFO 18156 --- [nio-8220-exec-1] c.w.s.controller.SysLoginUserController  : toSimple:Result{isSuccess=false, errors=[ValidationError{errorCode=-1, errorMsg='值不能为空', field='名字', invalidValue=2X}], timeElapsedInMillis=0}

3.简单工具类编写(待续)