再看参数校验

2023-12-19

作者简介:大家好,我是smart哥,前中兴通讯、美团架构师,现某互联网公司CTO

联系qq:184480602,加我进群,大家一起学习,一起进步,一起对抗互联网寒冬

写一个接口,大致就几个步骤:

  • 参数校验
  • 编写Service、Dao(SQL)
  • Result封装返回值
  • 如果是分布式,还可能涉及网关配置、服务引用等

业务代码总是变化的,没太多可说的,统一结果封装我们已经介绍过,今天我们来聊聊参数校验的琐事。

老实说,参数校验很烦!不校验不行,仔细校验吧,代码又显得非常冗余,很丑:

@PostMapping("insertUser")
public Result<Boolean> insertUser(@RequestBody User user) {
    if (user == null) {
        return Result.error(ExceptionCodeEnum.EMPTY_PARAM);
    }
    if (user.getId() == null || user.getId() <= 0) {
        return Result.error("id为空或小于0");
    }
    if (StringUtils.isEmpty(user.getName()) || user.getName().length() > 4) {
        return Result.error("姓名不符合规范");
    }
    if (user.getAge() < 18) {
        return Result.error("年龄不小于18");
    }
    if (StringUtils.isEmpty(user.getPhone()) || user.getPhone().length() != 11) {
        return Result.error("手机号码不正确");
    }
    
    return Result.success(userService.save(user));
}

但无论以什么方式进行参数校验,归根到底就是两种:

  • 手动校验
  • 自动校验

对应到实际编码的话,推荐:

  • 封装ValidatorUtils
  • 使用Spring Validation

其实对于上面两种方式,Spring都提供了解决方案。很多人只知道Spring Validation,却不知道简单好用的Assert。

public class SpringAssertTest {

    /**
     * Spring提供的Assert工具类,可以指定IllegalArgumentException的message
     *
     * @param args
     */
    public static void main(String[] args) {
        String name = "";
//        Assert.hasText(name, "名字不能为空");

        Integer age = null;
//        Assert.notNull(age, "年龄不能为空");

        Integer height = 180;
        Assert.isTrue(height > 185, "身高不能低于185");
    }
}

只要在全局异常处理IllegalArgumentException即可。但个人觉得还是自己封装自由度高一些,所以我们按照这个思路,写一个ValidatorUtils。

封装ValidatorUtils

封装ValidatorUtils也有两种思路:

  • 校验并返回结果,调用者自行处理
  • 校验失败直接抛异常

方式一:校验并返回结果,调用者自行处理

比如,方法只返回true/false:

public final class ValidatorUtils {
    private ValidatorUtils() {}
    
    /**
     * 校验id是否合法
     *
     * @param id
     */
    public static boolean isNotId(Long id) {
        if (id == null) {
            return true;
        }
        if (id < 0) {
            return true;
        }
        return false;
    }
}

调用者根据返回值自行处理(抛异常或者用Result封装):

@PostMapping("insertUser")
public Result<Boolean> insertUser(@RequestBody User user) {
    if (user == null) {
        return Result.error(ExceptionCodeEnum.EMPTY_PARAM);
    }
    // 对校验结果进行判断并返回,也可以抛异常让@RestControllerAdvice兜底
    if (ValidatorUtils.isNotId(user.getId())) {
        return Result.error("id为空或小于0");
    }
    
    return Result.success(userService.save(user));
}

这种方式,本质上和不封装差不多...

方式二:校验失败直接抛异常

这种形式一般会结合@RestControllerAdvice进行全局异常处理:

public final class ValidatorUtils {
    private ValidatorUtils() {}
    
    // 错误信息模板
    private static final String IS_EMPTY = "%s不能为空";
    private static final String LESS_THAN_ZERO = "%s不能小于0";
    
    /**
     * 校验参数是否为null
     *
     * @param param
     * @param fieldName
     */
    public static void checkNull(Object param, String fieldName) {
        if (param == null) {
            // ValidatorException是自定义异常
            throw new ValidatorException(String.format(IS_EMPTY, fieldName));
        }
    }
    
    /**
     * 校验id是否合法
     *
     * @param id
     * @param fieldName
     */
    public static void checkId(Long id, String fieldName) {
        if (id == null) {
            throw new ValidatorException(String.format(IS_EMPTY, fieldName));
        }
        if (id < 0) {
            throw new ValidatorException(String.format(LESS_THAN_ZERO, fieldName));
        }
    }
}
@PostMapping("updateUser")
public Result<Boolean> updateUser(@RequestBody User user) {
    // 一连串的校验
    ValidatorUtils.checkNull(user, "user");
    ValidatorUtils.checkId(user.getId(), "用户id");

    return Result.success(true);
}
@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {
	/* 省略业务异常、运行时异常处理*/
    
    /**
     * ValidatorUtils校验异常
     * @see ValidatorUtils
     *
     * @param e
     * @return
     */
    @ExceptionHandler(ValidatorException.class)
    public Result<ExceptionCodeEnum> handleValidatorException(ValidatorException e) {
        // 打印精确的参数错误日志,方便后端排查
        log.warn("参数校验异常: {}", e.getMessage(), e);
        // 一般来说,给客户端展示“参数错误”等泛化的错误信息即可,联调时可以返回精确的信息:e.getMessage()
        return Result.error(ExceptionCodeEnum.ERROR_PARAM);
    }
}

代码

具体选择哪种,看个人喜好啦。这里给出第二种封装形式(也可以改成第一种):

public final class ValidatorUtils {
    private ValidatorUtils() {}

    private static final String IS_EMPTY = "%s不能为空";
    private static final String LESS_THAN_ZERO = "%s不能小于0";
    private static final String LENGTH_OUT_OF_RANGE = "%s长度要在%d~%d之间";
    private static final String LENGTH_LESS_THAN = "%s长度不能小于%d";
    private static final String LENGTH_GREATER_THAN = "%s长度不能大于%d";
    private static final String ILLEGAL_PARAM = "%s不符合规则";
	// 手机号码正则,可以根据需要自行调整
    public static final String MOBILE = "1\\d{10}";
    
    /**
     * 是否为true
     *
     * @param expression
     * @param message
     */
    public static void isTrue(boolean expression, String message) {
        if (!expression) {
            throw new ValidatorException(message);
        }
    }

    /**
     * 校验参数是否为null
     *
     * @param param
     * @param fieldName
     */
    public static void checkNull(Object param, String fieldName) {
        if (param == null) {
            throw new ValidatorException(String.format(IS_EMPTY, fieldName));
        }
    }

    /**
     * 校验参数是否为null或empty
     *
     * @param param
     * @param fieldName
     */
    public static void checkNullOrEmpty(Object param, String fieldName) {
        if (param == null) {
            throw new ValidatorException(String.format(IS_EMPTY, fieldName));
        }

        if (param instanceof CharSequence) {
            if (param instanceof String && "null".equals(((String) param).toLowerCase())) {
                throw new ValidatorException(String.format(IS_EMPTY, fieldName));
            }
            if (isBlank((CharSequence) param)) {
                throw new ValidatorException(String.format(IS_EMPTY, fieldName));
            }
        }

        if (isCollectionsSupportType(param) && sizeIsEmpty(param)) {
            throw new ValidatorException(String.format(IS_EMPTY, fieldName));
        }
    }

    /**
     * 校验id是否合法
     *
     * @param id
     * @param fieldName
     */
    public static void checkId(Long id, String fieldName) {
        if (id == null) {
            throw new ValidatorException(String.format(IS_EMPTY, fieldName));
        }
        if (id < 0) {
            throw new ValidatorException(String.format(LESS_THAN_ZERO, fieldName));
        }
    }

    /**
     * 校验id是否合法
     *
     * @param id
     * @param fieldName
     */
    public static void checkId(Integer id, String fieldName) {
        if (id == null) {
            throw new ValidatorException(String.format(IS_EMPTY, fieldName));
        }
        if (id < 0) {
            throw new ValidatorException(String.format(LESS_THAN_ZERO, fieldName));
        }
    }

    /**
     * 校验参数字符串
     *
     * @param param 字符串参数
     * @param min   最小长度
     * @param max   最大长度
     */
    public static void checkLength(String param, int min, int max, String fieldName) {
        if (param == null || "".equals(param)) {
            throw new ValidatorException(String.format(IS_EMPTY, fieldName));
        }

        int length = param.length();
        if (length < min || length > max) {
            throw new ValidatorException(String.format(LENGTH_OUT_OF_RANGE, fieldName, min, max));
        }
    }

    /**
     * 校验参数字符串
     *
     * @param param 字符串参数
     * @param min   最小长度
     */
    public static void checkMinLength(String param, int min, String fieldName) {
        if (param == null || "".equals(param)) {
            throw new ValidatorException(String.format(IS_EMPTY, fieldName));
        }

        if (param.length() < min) {
            throw new ValidatorException(String.format(LENGTH_LESS_THAN, fieldName, min));
        }
    }

    /**
     * 校验参数字符串
     *
     * @param param 字符串参数
     * @param max   最大长度
     */
    public static void checkMaxLength(String param, int max, String fieldName) {
        if (param == null || "".equals(param)) {
            throw new ValidatorException(String.format(IS_EMPTY, fieldName));
        }

        if (param.length() > max) {
            throw new ValidatorException(String.format(LENGTH_GREATER_THAN, fieldName, max));
        }
    }

    /**
     * 校验手机号是否合法
     *
     * @param phone 手机号
     */
    public static void checkPhone(String phone, String fieldName) {
        if (phone == null || "".equals(phone)) {
            throw new ValidatorException(String.format(IS_EMPTY, fieldName));
        }
        boolean matches = Pattern.matches(MOBILE, phone);
        if (!matches) {
            throw new ValidatorException(String.format(ILLEGAL_PARAM, fieldName));
        }
    }

    // --------- private method ----------

    private static boolean isBlank(CharSequence cs) {
        int strLen;
        if (cs != null && (strLen = cs.length()) != 0) {
            for (int i = 0; i < strLen; ++i) {
                if (!Character.isWhitespace(cs.charAt(i))) {
                    return false;
                }
            }

        }
        return true;
    }

    private static boolean sizeIsEmpty(final Object object) {
        if (object == null) {
            return true;
        } else if (object instanceof Collection<?>) {
            return ((Collection<?>) object).isEmpty();
        } else if (object instanceof Map<?, ?>) {
            return ((Map<?, ?>) object).isEmpty();
        } else if (object instanceof Object[]) {
            return ((Object[]) object).length == 0;
        } else {
            try {
                return Array.getLength(object) == 0;
            } catch (final IllegalArgumentException ex) {
                throw new IllegalArgumentException("Unsupported object type: " + object.getClass().getName());
            }
        }
    }

    private static boolean isCollectionsSupportType(Object value) {
        boolean isCollectionOrMap = value instanceof Collection || value instanceof Map;
        return isCollectionOrMap || value.getClass().isArray();
    }
}
@Getter
@NoArgsConstructor
public class ValidatorException extends RuntimeException {
    /**
     * 自定义业务错误码
     */
    private Integer code;
    /**
     * 系统源异常
     */
    private Exception originException;


    /**
     * 完整的构造函数:参数错误码+参数错误信息+源异常信息
     *
     * @param code            参数错误码
     * @param message         参数错误信息
     * @param originException 系统源异常
     */
    public ValidatorException(Integer code, String message, Exception originException) {
        super(message);
        this.code = code;
        this.originException = originException;
    }

    /**
     * 构造函数:错误枚举+源异常信息
     *
     * @param codeEnum
     */
    public ValidatorException(ExceptionCodeEnum codeEnum, Exception originException) {
        this(codeEnum.getCode(), codeEnum.getDesc(), originException);
    }

    /**
     * 构造函数:参数错误信息+源异常信息
     *
     * @param message         参数错误信息
     * @param originException 系统源错误
     */
    public ValidatorException(String message, Exception originException) {
        this(ExceptionCodeEnum.ERROR_PARAM.getCode(), message, originException);
    }

    /**
     * 构造函数:错误枚举
     *
     * @param codeEnum 错误枚举
     */
    public ValidatorException(ExceptionCodeEnum codeEnum) {
        this(codeEnum.getCode(), codeEnum.getDesc(), null);
    }

    /**
     * 构造函数:参数错误信息
     *
     * @param message 参数错误信息
     */
    public ValidatorException(String message) {
        this(ExceptionCodeEnum.ERROR_PARAM.getCode(), message, null);
    }
}

Spring Validation

Spring也封装了一套基于注解的参数校验逻辑,常用的有:

  • @Validated
  • @NotNull
  • @NotBlank
  • @NotEmpty
  • @Positive
  • @Length
  • @Max
  • @Min

大家可能之前听说过@Valid,它和@Validated有什么关系呢?@Valid是JSR303规定的,@Validated是Spring扩展的,@Validated相对来说功能更加强大, 推荐优先使用@Validated。

SpringBoot2.3.x之前可以直接使用@Validated及@Valid,SpringBoot2.3.x以后需要额外引入依赖:

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

GET散装参数校验:ConstraintViolationException

实际开发中,如果某个GET接口只有一两个参数,可以使用“散装”的参数列表(注意类上加@Validated):

@Slf4j
@Validated
@RestController
public class UserController {

    @GetMapping("getUser")
    public Result<User> getUser(@NotNull(message = "部门id不能为空") Long departmentId,
                                @NotNull(message = "年龄不能为空")
                                @Max(value = 35, message = "年龄不超过35")
                                @Min(value = 18, message = "年龄不小于18") Integer age) {


        return Result.success(null);
    }
}

如果@RestControllerAdvice没有捕获对应的异常,会返回SpringBoot默认的异常JSON:

服务端则抛出ConstraintViolationException:

这样的提示不够友好,我们可以按之前的思路,为ConstraintViolationException进行全局异常处理:

@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {
	/* 省略业务异常、运行时异常等其他异常处理*/
    
    /**
     * ConstraintViolationException异常
     *
     * @param e
     * @return
     * @see ValidatorUtils
     */
    @ExceptionHandler(ConstraintViolationException.class)
    public Result<ExceptionCodeEnum> handleConstraintViolationException(ConstraintViolationException e) {
        log.warn("参数错误: {}", e.getMessage(), e);
        // 一般只需返回泛化的错误信息,比如“参数错误”
        return Result.error(ExceptionCodeEnum.ERROR_PARAM, e.getMessage());
    }
}

格式觉得丑的话,可以自己调整。

GET DTO参数校验:BindException

@Data
public class User {

    @NotNull(message = "id不能为空")
    private Long id;
    
    @NotNull(message = "年龄不能为空")
    @Max(value = 35, message = "年龄不超过35")
    @Min(value = 18, message = "年龄不小于18")
    private Integer age;
}
@Slf4j
@RestController
public class UserController {

    /**
     * 如果都是用DTO包装参数,那么Controller可以不加@Validated(但建议还是都加上吧)
     * 参数列表里用@Validated或@Valid都可以
     *
     * @param user
     * @return
     */
    @GetMapping("getUser")
    public Result<User> getUser(@Validated User user) {
        System.out.println("进来了");
        return Result.success(null);
    }
}

你会发现,虽然参数校验确实生效了:

但是全局异常似乎没有捕获到这个异常,最终又交给了SpringBoot处理:

{
    "timestamp": "2021-02-08T02:57:27.025+00:00",
    "status": 400,
    "error": "Bad Request",
    "message": "",
    "path": "/getUser"
}

这是怎么回事呢?

实际上,从GET“散装参数”变成“DTO参数”后,校验异常从ConstraintViolationException变成了BindException(见上面的截图),所以需要另外定义:

@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {
	/* 省略业务异常、运行时异常等其他异常处理*/
    
	/**
     * BindException异常
     *
     * @param e
     * @return
     */
    @ExceptionHandler(BindException.class)
    public Result<Map<String, String>> validationBindException(BindException e) {
        List<FieldError> fieldErrors = e.getBindingResult().getFieldErrors();
        String message = fieldErrors.stream()
                .map(FieldError::getDefaultMessage)
                .collect(Collectors.joining(" && "));
        log.error("参数错误: {}", message, e);
        return Result.error(ExceptionCodeEnum.ERROR_PARAM, message);
    }
}

重新请求:

{
    "code": 10000,
    "message": "id不能为空 && 年龄不小于18",
    "data": null
}

POST参数校验:MethodArgumentNotValidException

@PostMapping("updateUser")
public Result<Boolean> updateUser(@Validated @RequestBody User user) {
    System.out.println("进来了");
    return Result.success(null);
}

和GET DTO参数校验形式上一样,但POST校验的异常又是另一种, 所以全局异常处理又要加一种:

@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {
	/* 省略业务异常、运行时异常等其他异常处理*/
    
	/**
     * MethodArgumentNotValidException异常
     *
     * @param e
     * @return
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Result<Map<String, String>> validationMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        List<FieldError> fieldErrors = e.getBindingResult().getFieldErrors();
        String message = fieldErrors.stream()
                .map(FieldError::getDefaultMessage)
                .collect(Collectors.joining(" && "));
        log.error("参数错误: {}", message, e);
        return Result.error(ExceptionCodeEnum.ERROR_PARAM, message);
    }
}

代码

@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {

    /**
     * 业务异常
     *
     * @param
     * @return
     */
    @ExceptionHandler(BizException.class)
    public Result<ExceptionCodeEnum> handleBizException(BizException bizException) {
        log.warn("业务异常:{}", bizException.getMessage(), bizException);
        return Result.error(bizException.getError());
    }

    /**
     * 运行时异常
     *
     * @param e
     * @return
     */
    @ExceptionHandler(RuntimeException.class)
    public Result<ExceptionCodeEnum> handleRunTimeException(RuntimeException e) {
        log.warn("运行时异常: {}", e.getMessage(), e);
        return Result.error(ExceptionCodeEnum.ERROR);
    }

    /**
     * ValidatorUtils校验异常
     *
     * @param e
     * @return
     * @see ValidatorUtils
     */
    @ExceptionHandler(ValidatorException.class)
    public Result<ExceptionCodeEnum> handleValidatorException(ValidatorException e) {
        // 打印精确的参数错误日志,方便后端排查
        log.warn("参数校验异常: {}", e.getMessage(), e);
        // 一般来说,给客户端展示泛化的错误信息即可,联调时可以返回精确的信息
        return Result.error(e.getMessage());
    }

    /**
     * ConstraintViolationException异常(散装GET参数校验)
     *
     * @param e
     * @return
     * @see ValidatorUtils
     */
    @ExceptionHandler(ConstraintViolationException.class)
    public Result<ExceptionCodeEnum> handleConstraintViolationException(ConstraintViolationException e) {
        log.warn("参数错误: {}", e.getMessage(), e);
        return Result.error(ExceptionCodeEnum.ERROR_PARAM, e.getMessage());
    }

    /**
     * BindException异常(GET DTO校验)
     *
     * @param e
     * @return
     */
    @ExceptionHandler(BindException.class)
    public Result<Map<String, String>> validationBindException(BindException e) {
        List<FieldError> fieldErrors = e.getBindingResult().getFieldErrors();
        String message = fieldErrors.stream()
                .map(FieldError::getDefaultMessage)
                .collect(Collectors.joining(" && "));
        log.error("参数错误: {}", message, e);
        return Result.error(ExceptionCodeEnum.ERROR_PARAM, message);
    }

    /**
     * MethodArgumentNotValidException异常(POST DTO校验)
     *
     * @param e
     * @return
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Result<Map<String, String>> validationMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        List<FieldError> fieldErrors = e.getBindingResult().getFieldErrors();
        String message = fieldErrors.stream()
                .map(FieldError::getDefaultMessage)
                .collect(Collectors.joining(" && "));
        log.error("参数错误: {}", message, e);
        return Result.error(ExceptionCodeEnum.ERROR_PARAM, message);
    }

}

其他校验场景

Spring Validation还有一些校验场景,这里补充一下:

  • 嵌套校验
  • 分组校验
  • List校验

嵌套校验

@Validated不支持嵌套校验,只能用@Valid:

@Data
public class User {

    @NotNull(message = "id不能为空")
    private Long id;

    @NotNull(message = "年龄不能为空")
    @Max(value = 35, message = "年龄不超过35")
    @Min(value = 18, message = "年龄不小于18")
    private Integer age;

    @NotNull(message = "所属部门不能为空")
    @Valid
    private Department department;
    
    @Data
    static class Department {
        @NotNull(message = "部门编码不能为空")
        private Integer sn;
        @NotBlank(message = "部门名称不能为空")
        private String name;
    }
}

分组校验

@Data
public class User {

    @NotNull(message = "id不能为空", groups = {Update.class})
    private Long id;

    @NotNull(message = "年龄不能为空", groups = {Add.class, Update.class})
    @Max(value = 35, message = "年龄不超过35", groups = {Add.class, Update.class})
    @Min(value = 18, message = "年龄不小于18", groups = {Add.class, Update.class})
    private Integer age;

    public interface Add {
    }

    public interface Update {
    }
}
@Slf4j
@RestController
public class UserController {
    
    @PostMapping("insertUser")
    public Result<Boolean> insertUser(@Validated(User.Add.class) @RequestBody User user) {
        System.out.println("进来了");
        return Result.success(null);
    }

    @PostMapping("updateUser")
    public Result<Boolean> updateUser(@Validated(User.Update.class) @RequestBody User user) {
        System.out.println("进来了");
        return Result.success(null);
    }
}

有两点需要注意:

  • interface Add这些接口只是做个标记,本身没有任何实际意义,可以抽取出来,作为单独的接口复用
  • interface Add还可以继承Default接口
@Data
public class User {

    // 只在Update分组下生效
    @NotNull(message = "id不能为空", groups = {Update.class})
    private Long id;

    // 此时如果没执行Group,那么无论什么分组,都会校验
    @NotNull(message = "年龄不能为空")
    @Max(value = 35, message = "年龄不超过35")
    @Min(value = 18, message = "年龄不小于18")
    private Integer age;

    public interface Add extends Default {
    }

    public interface Update extends Default {
    }
}

继承Default后,除非显示指定,否则只要加了@NotNull等注解,就会起效。 但显示指定Group后,就按指定的分组进行校验。比如,上面的id只会在update时校验生效。

个人不建议继承Default,一方面是理解起来比较乱,另一方是加了Default后就无法进行 部分字段更新 了。比如:

@PostMapping("updateUser")
public Result<Boolean> updateUser(@Validated(User.Update.class) @RequestBody User user) {
    System.out.println("进来了");
    return Result.success(null);
}
@Data
public class User {

    @NotNull(message = "id不能为空", groups = {Update.class})
    private Long id;

    @NotNull(message = "年龄不能为空")
    private Integer age;
    
    @NotBlank(message = "住址不能为空")
    private String address;

    public interface Add extends Default {
    }

    public interface Update extends Default {
    }
}

此时如果想更新name,就不能只传id和name了,address也要传(默认也会校验)。当然,你也可以认为一般情况下update前都会有getById(),所以更新时数据也是全量的。

List校验

Spring Validation不支持以下方式校验:

@Data
public class User {

    @NotNull(message = "id不能为空")
    private Long id;

    @NotNull(message = "年龄不能为空")
    private Integer age;
}
@PostMapping("updateBatchUser")
public Result<Boolean> updateBatchUser(@Validated @RequestBody List<User> list) {
    System.out.println(list);
    return Result.success(null);
}

即使age不填,还是进来了,说明对于List而言,@Validated根本没作用:

解决办法是,借鉴嵌套校验的模式,在List外面再包一层:

@PostMapping("updateBatchUser")
public Result<Boolean> updateBatchUser(@Validated @RequestBody ValidationList<User> userList) {
    System.out.println(userList);
    return Result.success(null);
}
public class ValidationList<E> implements List<E> {

    @NotEmpty(message = "参数不能为空")
    @Valid
    private List<E> list = new LinkedList<>();

    @Override
    public int size() {
        return list.size();
    }

    @Override
    public boolean isEmpty() {
        return list.isEmpty();
    }

    @Override
    public boolean contains(Object o) {
        return list.contains(o);
    }

    @Override
    public Iterator<E> iterator() {
        return list.iterator();
    }

    @Override
    public Object[] toArray() {
        return list.toArray();
    }

    @Override
    public <T> T[] toArray(T[] a) {
        return list.toArray(a);
    }

    @Override
    public boolean add(E e) {
        return list.add(e);
    }

    @Override
    public boolean remove(Object o) {
        return list.remove(o);
    }

    @Override
    public boolean containsAll(Collection<?> c) {
        return list.containsAll(c);
    }

    @Override
    public boolean addAll(Collection<? extends E> c) {
        return list.addAll(c);
    }

    @Override
    public boolean addAll(int index, Collection<? extends E> c) {
        return list.addAll(index, c);
    }

    @Override
    public boolean removeAll(Collection<?> c) {
        return list.removeAll(c);
    }

    @Override
    public boolean retainAll(Collection<?> c) {
        return list.retainAll(c);
    }

    @Override
    public void clear() {
        list.clear();
    }

    @Override
    public E get(int index) {
        return list.get(index);
    }

    @Override
    public E set(int index, E element) {
        return list.set(index, element);
    }

    @Override
    public void add(int index, E element) {
        list.add(index, element);
    }

    @Override
    public E remove(int index) {
        return list.remove(index);
    }

    @Override
    public int indexOf(Object o) {
        return list.indexOf(o);
    }

    @Override
    public int lastIndexOf(Object o) {
        return list.lastIndexOf(o);
    }

    @Override
    public ListIterator<E> listIterator() {
        return list.listIterator();
    }

    @Override
    public ListIterator<E> listIterator(int index) {
        return list.listIterator(index);
    }

    @Override
    public List<E> subList(int fromIndex, int toIndex) {
        return list.subList(fromIndex, toIndex);
    }

    public List<E> getList() {
        return list;
    }

    public void setList(List<E> list) {
        this.list = list;
    }

}

实际开发时,建议专门建一个package存放Spring Validation相关的接口和类:

SpringValidatorUtils封装

一起来封装一个SpringValidatorUtils:

public final class SpringValidatorUtils {
    private SpringValidatorUtils() {}
    
    /**
     * 校验器
     */
    private static final Validator validator = Validation.buildDefaultValidatorFactory().getValidator();

    /**
     * 校验参数
     *
     * @param param  待校验的参数
     * @param groups 分组校验,比如Update.class(可以不传)
     * @param <T>
     */
    public static <T> void validate(T param, Class<?>... groups) {
        Set<ConstraintViolation<T>> validateResult = validator.validate(param, groups);
        if (!CollectionUtils.isEmpty(validateResult)) {
            StringBuilder validateMessage = new StringBuilder();
            for (ConstraintViolation<T> constraintViolation : validateResult) {
                validateMessage.append(constraintViolation.getMessage()).append(" && ");
            }
            // 去除末尾的 &&
            validateMessage.delete(validateMessage.length() - 4, validateMessage.length());
            // 抛给全局异常处理
            throw new ValidatorException(validateMessage.toString());
        }
    }
}

代码很简单, 做的事情本质是和@Validated是一模一样的。 @Validated通过注解方式让Spring使用Validator帮我们校验,而SpringValidatorUtils则是我们从Spring那借来Validator自己校验:

@PostMapping("insertUser")
public Result<Boolean> insertUser(@RequestBody User user) {
    SpringValidatorUtils.validate(user);
    System.out.println("进来了");
    return Result.success(null);
}

此时不需要加@Validated。

买一送一,看看我之前一个同事封装的工具类(更加自由,调用者决定抛异常还是返回错误信息):

public final class ValidationUtils {

    private static final Validator DEFAULT_VALIDATOR = Validation.buildDefaultValidatorFactory().getValidator();

    private ValidationUtils() {
    }

    /**
     * 验证基于注解的对象
     *
     * @param target
     */
    public static <T> String validateReq(T target, boolean throwException) {
        if (null == target) {
            return errorProcess("校验对象不能为空", throwException);
        } else {
            Set<ConstraintViolation<T>> constraintViolations = DEFAULT_VALIDATOR.validate(target);
            ConstraintViolation<T> constraintViolation = Iterables.getFirst(constraintViolations, null);
            if (constraintViolation != null) {
                // 用户可以指定抛异常还是返回错误信息
                return errorProcess(constraintViolation.getPropertyPath() + ":" + constraintViolation.getMessage(),
                        throwException);
            }
        }
        return "";
    }

    private static String errorProcess(String errorMsg, boolean throwException) {
        if (throwException) {
            throw new InvalidParameterException(errorMsg);
        }
        return errorMsg;
    }
}

OK,至此对Spring Validation的介绍结束。

为什么@Validated这么方便,还要封装这个工具类呢?首先,很多人搞不清楚@Validated的使用或者觉得注解很碍眼,不喜欢。其次,也是最重要的,如果你想在Service层做校验,使用SpringValidatorUtils会方便些(Service有接口和实现类,麻烦些)。当然,Service也能用注解方式校验。

参数校验就介绍到这,有更好的方式欢迎大家评论交流。我个人曾经特别喜欢Spring Validation,后来觉得其实使用工具类也蛮好,想校验啥就写啥,很细腻,不用考虑乱七八糟的分组,而Spring Validation有时需要花费很多心思在分组上,就有点本末倒置了。

最后抛出两个问题:

  • 写完才发现,ValidatorUtils竟然用了static final抽取错误信息模板,然后利用String.format()拼接。会出现线程安全问题吗?
  • 你知道如何设计山寨版的Spring Validation吗?(只需要实现@NotNull + ValidatorUtils,参考答案见评论区)
作者简介:大家好,我是smart哥,前中兴通讯、美团架构师,现某互联网公司CTO

进群,大家一起学习,一起进步,一起对抗互联网寒冬
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

再看参数校验 的相关文章

  • win10任务栏透明?教你轻松搞定

    windows 10的任务栏一直是用户桌面的焦点之一 为了提升用户体验 许多人希望让任务栏变得更加美观 其中之一就是使任务栏透明 本文将为您揭示win10任务栏透明的奥秘 介绍三种方法 让您的任务栏焕然一新 方法1 系统设置 透明的任务栏不
  • 10000亿规模AIGC产业,谁会成为下一个“巨头”?

    ChatGPT的热潮带火了大语言模型 也让AIGC插上了效率的翅膀 Midjourney 妙鸭相机等产品相继走入大众用户视线 根据艾瑞咨询的预测 2023年中国AIGC产业规模约为143亿元 而随着相关生态的完善 到2030年 中国AIGC
  • OpenAI公布ChatGPT安全框架

    12月19日 OpenAI在官网公布了 准备框架 Preparedness Framework 测试版 该文档详细介绍了OpenAI是如何保证ChatGPT等产品的安全防护措施 开发和部署流程 OpenAI表示 随着大模型的功能迭代不断完善

随机推荐

  • 三星手机如何录屏?让你轻松成为录屏专家

    三星手机怎么录屏呀 最近需要录一场很重要的线上视频会议 眼看时间就要到了 就是找不到手机的录屏在哪里 真的不知道该怎么办了 这场会议对我来说非常重要 有没有人会用三星手机录屏的 教教我 随着智能手机功能的不断提升 录制手机屏幕成为许多用户分
  • 在 Ubuntu 22.04 上安装 .NET 8

    1 增加微软包安装源 wget https packages microsoft com config ubuntu 22 04 packages microsoft prod deb O packages microsoft prod d
  • AI写作范文:心血管内科护理风险因素分析及防范对策

    1 引言 1 1 心血管内科的重要性与护理挑战 1 2 研究背景与论文的研究目的 2 心血管内科护理风险因素的现状分析 2 1 国内外心血管内科护理风险研究进展 2 2 心血管内科常见护理风险因素总结 3 心血管内科护理风险因素具体分析 3
  • mes系统的核心功能是什么?

    MES 定义为 位于上层的计划管理系统与底层的工业控制之间的面向车间层的管理信息系统 它为操作人员 管理人员提供计划的执行 跟踪以及所有资源 人 设备 物料 客户需求等 的当前状态 目的是解决工厂生产过程的黑匣子问题 实现生产过程的可视化
  • vue中使用echarts实现省市地图绘制,根据数据在地图上显示柱状图信息,增加涟漪特效动画效果

    一 实现效果 使用echarts实现省市地图绘制 根据数据在地图显示柱状图 根据数据显示数据 涟漪效果 二 实现方法 1 安装echarts插件 npm install echarts save 2 获取省市json数据 https dat
  • Https图片链接下载问题

    1 获取方法 入参是一个Url 和一个随机的名称 返回值是MultipartFile 这里因为我这里需要调接口传到服务器 这里也可以直接通过inputStream进行操作 按需修改 通过Url获取文件 param url param fil
  • 搭建Eureka服务

    搭建Eureka服务 文章目录 搭建Eureka服务 搭建EurekaServer 注册user service 注册多个实例 在order service中完成服务拉取和负载均衡
  • DTO/DO/VO分层与拷贝

    作者简介 大家好 我是smart哥 前中兴通讯 美团架构师 现某互联网公司CTO 联系qq 184480602 加我进群 大家一起学习 一起进步 一起对抗互联网寒冬 这一篇其实没太多实质内容 本来不打算写的 但想到当初从传统通信行业跳到互联
  • 迪普防火墙开局登录

    文章内容来自迪普官方 产品文档 杭州迪普科技股份有限公司
  • H3C 交换机指示灯说明

    端口模式指示灯 mode 为了使用户通过交换机各类型端口的 端口状态指示灯 能够获取更多的设备信息 本系列交换机 S5560S 28F EI 和 S5560S 52F EI 除外 的同一个 10 100 1000BASE T 自适应以太网端
  • H3C AC双链路备份基本组网典型配置举例

    1 6 1 双链路备份基本组网典型配置举例 1 组网需求 AP 通过 Router A 与 AC 1 和 AC 2 连接 要求使用双链路备份对 AC 进行备份 AC 1 工作在主用状态 AC 2 工作在备用状态 当 AC 1
  • 基于SpringBoot+Vue的科研项目验收管理系统设计实现(源码+lw+部署文档+讲解等)

    文章目录 前言 详细视频演示 具体实现截图 技术栈 后端框架SpringBoot 前端框架Vue 持久层框架MyBaitsPlus 系统测试 系统测试目的
  • AWS解决方案架构师学习与备考

    系列文章目录 送书第一期 用户画像 平台构建与业务实践 送书活动之抽奖工具的打造 获取博客评论用户抽取幸运中奖者 送书第二期 Spring Cloud Alibaba核心技术与实战案例 送书第三期 深入浅出Java虚拟机 送书第四期 AI时
  • 2015,TEVC,Adaptive MOPSO Based on Parallel Cell Coordinate System

    Abstract 在多目标粒子群优化 MOPSO 的设计中 管理收敛性和多样性是至关重要的 以搜索真实Pareto最优前沿的准确和良好分布的近似 粒子群优化算法由于其快速收敛性 在进化过程中会导致多样性的快速丢失 现有的MOPSOs在 le
  • OneNote笔记使用记录

    1 快捷键 2 快速设置行距 Ctrl 1 设置一倍行距 Ctrl 2 两倍行距 Ctrl 5 1 5 倍行距 3 切换样式标题 Ctrl Alt 1 标题 1 Ctrl Alt 2 标题 2 Ctrl Alt 3 标题 3 Ctrl Sh
  • vtk用户指南 第十一章 随时间变化的数据

    11 1时序支持简介 创建可视化工具包的目的是允许人们可视化 从而探索具有空间范围的数据中的特征 它允许人们回答一些问题 比如 在这些数据中 最大价值的区域在哪里 它们有什么形状和价值 以及 这些形状是如何分布的 VTK提供了大量的技术来显
  • 阿里云一二级域名配置

    一级域名配置 二级域名配置
  • 2023中国品牌节金谱奖荣誉发布 酷开科技获颁OTT行业科技创新奖

    11月17日 19日 以 复苏与腾飞 为主题的2023第十七届中国品牌节 在杭州市云栖小镇国际会展中心成功举行 在18日晚间的荣耀盛典上 TopBrand 2023中国品牌节金谱奖 荣誉发布 酷开科技斩获OTT行业科技创新奖 酷开科技作为O
  • 面试150-13(Leetcode238除自身以外数组的乘积)

    代码 class Solution public int productExceptSelf int nums int n nums length int res new int n int product 1 int zerocnt 0
  • 再看参数校验

    作者简介 大家好 我是smart哥 前中兴通讯 美团架构师 现某互联网公司CTO 联系qq 184480602 加我进群 大家一起学习 一起进步 一起对抗互联网寒冬 写一个接口 大致就几个步骤 参数校验 编写Service Dao SQL