你真会写CRUD？如何优雅参数校验

CRUD（创建、读取、更新、删除）操作是必不可少的基础功能。然而，如何优雅地进行参数校验，以确保数据的有效性和安全性，是每个开发者都需要掌握的重要技能。本文将探讨如何在Spring Boot中实现优雅的参数校验。

1. 使用BindingResult进行参数校验

在Spring Boot中，BindingResult用于接收前一个对象的校验结果。如果校验失败，错误信息将被封装到此对象中。

示例代码

/**
 * 新增用户
 */
@PostMapping
public AppResponse<?> addOne(@Validated @RequestBody SysUser user, BindingResult result) {
    if (result.hasErrors()) {
        Map<String, String> errorMap = new LinkedHashMap<>();
        result.getFieldErrors().forEach(fieldError -> {
            // 发生错误的字段名
            String field = fieldError.getField();
            // 发生错误的提示消息
            String defaultMessage = fieldError.getDefaultMessage();
            errorMap.put(field, defaultMessage);
        });
        return AppResponse.error("参数错误", errorMap);
    }
    return AppResponse.success();
}

校验字段

在SysUser类中定义需要校验的字段及其约束条件：

@NotBlank(message = "{not.null}")
@Length(min = 2, message = "{user.username.not.valid}")
@TableField("user_name")
private String userName;

2. 默认校验顺序

在使用多个校验注解时，Hibernate Validator 默认会按照注解的顺序进行校验。具体来说，校验的顺序是通过注解的标识符第一个英文字母进行排序的。这意味着，如果你希望在多个校验注解之间指定顺序，可能需要进行额外的处理，因为默认排序可能无法满足需求。

例如，若同时使用@NotBlank和@Length注解，校验顺序可能不是你所期望的。

3. 全局异常处理

为了避免在每个CRUD操作中重复编写相同的校验处理代码，可以使用全局异常处理来集中管理。

创建全局异常处理类

@Slf4j
@RestControllerAdvice
public class AppGlobalValidExceptionAdvice {
    /**
     * 全局统一处理参数校验
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public AppResponse<?> handleMethodArgumentNotValidException(MethodArgumentNotValidException ex) {
        BindingResult result = ex.getBindingResult();
        Map<String, String> errorMap = new LinkedHashMap<>();
        result.getFieldErrors().forEach(fieldError -> {
            String field = fieldError.getField();
            String defaultMessage = fieldError.getDefaultMessage();
            errorMap.put(field, defaultMessage);
        });
        return AppResponse.error("参数不合法", errorMap);
    }

    @ExceptionHandler(BusinessException.class)
    public AppResponse<?> handleBusinessException(BusinessException ex) {
        log.error("业务异常:{}", ex);
        return AppResponse.error(ex.getMessage());
    }
}

通过这种方式，我们能够统一处理参数校验异常，提高代码的可维护性。

响应值示例：

{
    "code": "400",
    "message": "参数不合法",
    "data": {
        "errorCount": 3,
        "errors": {
            "userName": "用户名不能为空",
            "email": "邮箱格式不正确",
            "password": "密码长度必须大于6个字符"
        }
    }
}

4. 自定义校验注解

在某些情况下，内置的校验注解可能无法满足需求。例如，我们可能需要检查用户名是否已存在于数据库中。为此，可以创建自定义注解。

自定义注解示例

@Documented
@Constraint(validatedBy = {UniqueUserConstraintValidator.class}) // 指定校验器
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
public @interface UniqueUser {
    String[] baned() default {"admin", "root"}; // 自定义属性

    String message() default "{org.hibernate.validator.constraints.Length.message}";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

自定义校验器

自定义校验器实现ConstraintValidator接口，负责具体的校验逻辑：

@Data
@Scope("prototype")
@Component
public class UniqueUserConstraintValidator implements ConstraintValidator<UniqueUser, String> {
    private String[] baned;

    @Resource
    private ISysUserService userService;

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        long blackUserNameCount = Arrays.stream(baned).filter(s -> s.equals(value)).count();
        long count = userService.lambdaQuery().eq(SysUser::getUserName, value).last("limit 1").count();
        return count == 0L && blackUserNameCount == 0L;
    }

    @Override
    public void initialize(UniqueUser constraintAnnotation) {
        baned = constraintAnnotation.baned();
    }
}

使用自定义注解

在SysUser类中应用自定义校验注解：

@NotBlank(message = "{not.null}")
@UniqueUser(message = "{username.exist}", baned = {"admin", "root"}) // 使用自定义注解
@TableField("user_name")
private String userName;

5. 国际化消息配置

为了提升用户体验，可以将错误消息进行国际化配置。创建资源文件，例如message_zh_CN.properties，并在其中定义错误消息：

# 错误消息
not.null=* 必须填写
user.username.not.valid=* 2到20个汉字、字母、数字或下划线组成，且必须以非数字开头
username.exist=用户名已存在

6. 自定义校验顺序

如果需要指定校验顺序，可以在自定义校验器中实现多个校验逻辑，而不必在字段上添加多个注解。例如，可以在UniqueUserConstraintValidator中先执行@NotBlank的校验，再执行@Length的校验。

总结

优雅地处理CRUD操作中的参数校验，不仅可以提高代码的可读性和可维护性，还能确保系统的健壮性。通过使用BindingResult、全局异常处理、自定义校验注解和国际化配置，我们能够有效地管理参数校验，提升用户体验。