Hibernate Validator实现更简洁的参数校验及一个util

那我来为您讲解一下Hibernate Validator实现更简洁的参数校验及一个util的完整攻略。

1. 简介

Hibernate Validator是一个基于Java Bean验证规范（JSR-303，JSR-349）的校验框架，可以用来校验JavaBean中的字段，包括对基本类型、日期、字符串等数据类型的支持。Hibernate Validator提供了一种使用注解或者编程方式进行校验的方法，可以用来实现更简洁方便的参数校验。

2. Hibernate Validator基本用法

2.1 引入依赖

首先需要在Maven中引入Hibernate Validator的依赖：

<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.1.0.Final</version>
</dependency> 

2.2 基本注解

在定义Java Bean时，可以使用Hibernate Validator提供的注解对Bean中的字段进行校验，如下所示：

public class User {
    @NotNull(message = "用户名不能为空")
    @NotBlank(message = "用户名不能为空")
    private String username;

    @NotNull(message = "密码不能为空")
    @Size(min = 6, max = 18, message = "密码长度为6-18位")
    private String password;
    //...
}

在上面的代码中，@NotNull、@NotBlank和@Size都是Hibernate Validator提供的常用注解。其中：

• @NotNull 表示该字段不能为空
• @NotBlank 表示该字段不能为空且字符串中至少有一个非空格字符
• @Size 表示该字段长度必须在指定范围内

2.3 校验

在实际代码中，可以使用Validator进行校验，如下所示：

public class UserController {

    @Autowired
    private Validator validator;

    /**
     * 注册
     *
     * @param user
     * @return
     */
    @PostMapping("/register")
    public Object register(@Valid @RequestBody User user) {
        // 校验参数
        Set<ConstraintViolation<User>> validateResult = validator.validate(user);
        if (validateResult.size() > 0) {
            return "参数错误！";
        }
        // 执行业务逻辑
        return "注册成功！";
    }

}

在上面的代码中，@Valid注解表示要校验被注解标记的Bean参数，Validator.validate方法会返回一个Set类型的结果集，如果结果集的大小大于0，则表示有校验失败的情况。

3. Hibernate Validator Util工具类

在实际应用开发中，我们会需要编写很多很多的校验代码，为了简化代码，我们可以封装一个校验工具类，如下所示：

public class ValidatorUtil {

    private static ValidatorFactory validatorFactory;

    private static Validator validator;

    static {
        validatorFactory = Validation.buildDefaultValidatorFactory();
        validator = validatorFactory.getValidator();
    }

    /**
     * 校验对象
     *
     * @param object
     * @param groups
     * @throws Exception
     */
    public static void validateObject(Object object, Class<?>... groups) throws Exception {
        Set<ConstraintViolation<Object>> constraintViolations = validator.validate(object, groups);
        if (!CollectionUtils.isEmpty(constraintViolations)) {
            ConstraintViolation<Object> violation = constraintViolations.iterator().next();
            throw new Exception(violation.getMessage());
        }
    }
}

在上面的代码中，我们封装了一个校验Util类ValidatorUtil，该类中包含了校验方法validateObject。在该方法中，我们使用Validation.buildDefaultValidatorFactory().getValidator()来创建validator实例，然后使用validator.validate来进行校验。

4. 示例

我们来通过两个示例来说明Hibernate Validator的使用方法：

4.1 校验Java Bean

public class User {
    @NotNull(message = "用户名不能为空")
    @NotBlank(message = "用户名不能为空")
    private String username;

    @NotNull(message = "密码不能为空")
    @Size(min = 6, max = 18, message = "密码长度为6-18位")
    private String password;
    //...
}

public class UserController {

    /**
     * 注册
     *
     * @param user
     * @return
     * @throws Exception
     */
    @PostMapping("/register")
    public Object register(@RequestBody User user) throws Exception {
        ValidatorUtil.validateObject(user);
        // 执行业务逻辑
        return "注册成功！";
    }

}

4.2 校验@RequestParam

public class UserController {

    /**
     * 登录
     *
     * @param username
     * @param password
     * @return
     * @throws Exception
     */
    @PostMapping("/login")
    public Object login(@RequestParam @NotNull @NotBlank String username,
                        @RequestParam @NotNull @Size(min = 6, max = 18) String password) throws Exception {
        // 校验参数
        ValidatorUtil.validateObject(username);
        ValidatorUtil.validateObject(password);
        // 执行业务逻辑
        return "登录成功！";
    }

}

在上面的代码中，我们使用@RequestParam注解来接收请求参数，并且使用ValidatorUtil.validateObject方法对参数进行校验。如果参数校验失败，我们将会抛出异常并返回错误信息。

以上就是Hibernate Validator实现更简洁的参数校验及一个util的完整攻略。