1、功能描述

在实际项目开发过程中，经常会遇到需要对接口的参数进行校验的诉求。但是，如果把参数校验的实现写到每个接口的业务处理方法里面，那么就会使得业务处理方法的实现显得比较臃肿，不便于阅读；业务处理方法的功能不单一。
针对上面的情况，使用Hibernate的validator自定义注解，可以比较优雅的实现参数校验，且复用性好。使用统一异常处理，可以对参数校验返回的错误信息进行国际化，使得适用场景更加广泛，同时把校验器中国际化的处理抽取到全局异常处理。下面，举个校验用户ID的个数的参数校验，来看一下具体实现。

2、自定义注解实现参数校验

2.1、 添加依赖

hibernate的依赖必须添加，ConstraintValidator只是一个接口，没有具体实现。Hibernate Validator有对该接口的调用逻辑实现，需要引用，才能使校验器生效。

        <!-- parameter verification start-->
        <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.4.1.Final</version>
        </dependency>
        <!-- parameter verification end-->

2.2、添加注解

@Documented
@Target({ElementType.FIELD,ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = UserIdsValidator.class)
public @interface UserIdsSize {
    boolean acceptNull() default true;

    int max() default 1;

    String separator() default ",";

    String message() default "";

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

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

}

2.3 添加校验类

public class UserIdsValidator implements ConstraintValidator<UserIdsSize, String> {
    private UserIdsSize annotation;

    public void initialize(UserIdsSize annotation) {
        this.annotation = annotation;
    }

    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (StringUtils.isEmpty(value)) {
            return annotation.acceptNull();
        }
        return value.split(annotation.separator()).length <= annotation.max();
    }
}

2.4、 使用校验

@Data
public class BatchReq {
    @UserIdsSize(max = 2)
    private String userIds;
}

3、 参数校验异常消息的国际化处理

3.1 国际化配置和添加国际化文件

借助SpringBoot的MessageSource做国际化，先在application.yml中添加配置
spring:
messages:
basename: i18n/message
encoding: UTF-8
添加国家化文件，其中message.properties为默认文件，即找不到对应国家的语言，会返回默认文件的消息

国家化文件的位置

IDEA添加Resource Bundle的操作如下

IDEA添加Resource Bundle操作

3.2、message中的定义

message.properties

uam.validate.60010001=size of user id is over maxvalue

message_en_US.properties

uam.validate.60010001=size of user id is over maxvalue

message_zh_CN.properties

uam.validate.60010001=user id \u7684\u5927\u5c0f\u8d85\u8fc7\u6700\u5927\u503c

3.3、全局异常处理中做国际化

考虑到通用性，对参数校验的异常返回做全局统一处理
借助@ControllerAdvice来定义全局的异常处理逻辑

@ControllerAdvice
public class GlobalExceptionHandler {
    @Autowired
    private MessageSource messageSource;

    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public Map<String, Object> handlerException(MethodArgumentNotValidException ex){
        Map<String,Object> result = new HashMap<>();
        List<ObjectError> errors = ex.getBindingResult().getAllErrors();
        errors.forEach(error -> {
            result.put("errorCode","6001");
            result.put("errorMsg", messageSource.getMessage(error.getDefaultMessage(), null,LocaleContextHolder.getLocale()));//调用messageSource.getMessage来实现国际化
        });
        return result;
    }
}

3.4、在注解中的message设置异常码

校验注解中的message设置为UserIds校验失败的异常码uam.validate.60010001,将异常码通过常量的方式定义

public interface ErrorCodeConstant {
    String USER_ID_OVER_SIZE = "uam.validate.60010001";
}

修改BatchReq中的注解@UserIdsSize，在注解中的message设置异常码

@Data
public class BatchReq {
    @UserIdsSize(max = 2,message = ErrorCodeConstant.USER_ID_OVER_SIZE)
    private String userIds;
}

4、验证结果和代码地址

POST http://localhost:8088/users
Content-Type: application/json

{
"userIds": "1,2,3"
}

返回结果

代码地址
https://github.com/xujinhelaw/sysusermanager