关于java:参数校验别再写满屏的-ifelse-了差点被劝退……

作者：锦成同学\
起源：juejin.im/post/5d3fbeb46fb9a06b317b3c48

很苦楚遇到大量的参数进行校验，在业务中还要抛出异样或者一直的返回异样时的校验信息，在代码中相当简短，充斥了if-else这种校验代码，明天咱们就来学习spring的javax.validation 注解式参数校验。

1.为什么要用validator

javax.validation的一系列注解能够帮咱们实现参数校验,免去繁琐的串行校验

不然咱们的代码就像上面这样：

//  http://localhost:8080/api/user/save/serial

/**
 * 走串行校验
 *
 * @param userVO
 * @return
 */
@PostMapping("/save/serial")
public Object save(@RequestBody UserVO userVO) {
    String mobile = userVO.getMobile();

    //手动一一 参数校验~ 写法
    if (StringUtils.isBlank(mobile)) {
        return RspDTO.paramFail("mobile:手机号码不能为空");
    } else if (!Pattern.matches("^[1][3,4,5,6,7,8,9][0-9]{9}$", mobile)) {
        return RspDTO.paramFail("mobile:手机号码格局不对");
    }

    //抛出自定义异样等~写法
    if (StringUtils.isBlank(userVO.getUsername())) {
        throw new BizException(Constant.PARAM_FAIL_CODE, "用户名不能为空");
    }

    // 比方写一个map返回
    if (StringUtils.isBlank(userVO.getSex())) {
        Map<String, Object> result = new HashMap<>(5);
        result.put("code", Constant.PARAM_FAIL_CODE);
        result.put("msg", "性别不能为空");
        return result;
    }
    //.........各种写法 ...
    userService.save(userVO);
    return RspDTO.success();
}

这被大佬看见,肯定说,都9102了还这么写，而后被劝退了…..

2.什么是javax.validation

JSR303 是一套JavaBean参数校验的规范，它定义了很多罕用的校验注解，咱们能够间接将这些注解加在咱们JavaBean的属性下面(面向注解编程的时代)，就能够在须要校验的时候进行校验了。

Spring Boot 根底就不介绍了，举荐下这个实战教程：

https://github.com/javastacks…

在SpringBoot中曾经蕴含在starter-web中,再其余我的项目中能够援用依赖，并自行调整版本：

<!--jsr 303-->
<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>1.1.0.Final</version>
</dependency>
<!-- hibernate validator-->
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>5.2.0.Final</version>
</dependency>

3.注解阐明

@NotNull：不能为null，但能够为empty(“”,” “,” “)
@NotEmpty：不能为null，而且长度必须大于0 (” “,” “)
@NotBlank：只能作用在String上，不能为null，而且调用trim()后，长度必须大于0(“test”) 即：必须有理论字符

此处只列出Hibernate Validator提供的大部分验证束缚注解，请参考hibernate validator官网文档理解其余验证束缚注解和进行自定义的验证束缚注解定义。

4.实战演练

话不多说，间接走实际路线，同样应用的是SpringBoot的疾速框架。

具体代码见：

https://github.com/leaJone/mybot

4.1. @Validated 申明要查看的参数

这里咱们在控制器层进行注解申明

/**
 * 走参数校验注解
 *
 * @param userDTO
 * @return
 */
@PostMapping("/save/valid")
public RspDTO save(@RequestBody @Validated UserDTO userDTO) {
    userService.save(userDTO);
    return RspDTO.success();
}

4.2. 对参数的字段进行注解标注

import lombok.Data;
import org.hibernate.validator.constraints.Length;

import javax.validation.constraints.*;
import java.io.Serializable;
import java.util.Date;

/**
 * @author LiJing
 * @ClassName: UserDTO
 * @Description: 用户传输对象
 * @date 2019/7/30 13:55
 */
@Data
public class UserDTO implements Serializable {

    private static final long serialVersionUID = 1L;

    /*** 用户ID*/
    @NotNull(message = "用户id不能为空")
    private Long userId;

    /** 用户名*/
    @NotBlank(message = "用户名不能为空")
    @Length(max = 20, message = "用户名不能超过20个字符")
    @Pattern(regexp = "^[\\u4E00-\\u9FA5A-Za-z0-9\\*]*$", message = "用户昵称限度：最多20字符，蕴含文字、字母和数字")
    private String username;

    /** 手机号*/
    @NotBlank(message = "手机号不能为空")
    @Pattern(regexp = "^[1][3,4,5,6,7,8,9][0-9]{9}$", message = "手机号格局有误")
    private String mobile;

    /**性别*/
    private String sex;

    /** 邮箱*/
    @NotBlank(message = "分割邮箱不能为空")
    @Email(message = "邮箱格局不对")
    private String email;

    /** 明码*/
    private String password;

    /*** 创立工夫 */
    @Future(message = "工夫必须是未来工夫")
    private Date createTime;

}

4.3. 在全局校验中减少校验异样

MethodArgumentNotValidException是springBoot中进行绑定参数校验时的异样,须要在springBoot中解决,其余须要解决ConstraintViolationException异样进行解决。

为了优雅一点，咱们将参数异样，业务异样，对立做了一个全局异样，将管制层的异样包装到咱们自定义的异样中。

为了优雅一点，咱们还做了一个对立的构造体，将申请的code，和msg，data一起对立封装到构造体中，减少了代码的复用性。

import com.boot.lea.mybot.dto.RspDTO;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.dao.DuplicateKeyException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.NoHandlerFoundException;

import javax.validation.ConstraintViolationException;
import javax.validation.ValidationException;

/**
 * @author LiJing
 * @ClassName: GlobalExceptionHandler
 * @Description: 全局异样处理器
 * @date 2019/7/30 13:57
 */
@RestControllerAdvice
public class GlobalExceptionHandler {

    private Logger logger = LoggerFactory.getLogger(getClass());

    private static int DUPLICATE_KEY_CODE = 1001;
    private static int PARAM_FAIL_CODE = 1002;
    private static int VALIDATION_CODE = 1003;

    /**
     * 解决自定义异样
     */
    @ExceptionHandler(BizException.class)
    public RspDTO handleRRException(BizException e) {
        logger.error(e.getMessage(), e);
        return new RspDTO(e.getCode(), e.getMessage());
    }

    /**
     * 办法参数校验
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public RspDTO handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        logger.error(e.getMessage(), e);
        return new RspDTO(PARAM_FAIL_CODE, e.getBindingResult().getFieldError().getDefaultMessage());
    }

    /**
     * ValidationException
     */
    @ExceptionHandler(ValidationException.class)
    public RspDTO handleValidationException(ValidationException e) {
        logger.error(e.getMessage(), e);
        return new RspDTO(VALIDATION_CODE, e.getCause().getMessage());
    }

    /**
     * ConstraintViolationException
     */
    @ExceptionHandler(ConstraintViolationException.class)
    public RspDTO handleConstraintViolationException(ConstraintViolationException e) {
        logger.error(e.getMessage(), e);
        return new RspDTO(PARAM_FAIL_CODE, e.getMessage());
    }

    @ExceptionHandler(NoHandlerFoundException.class)
    public RspDTO handlerNoFoundException(Exception e) {
        logger.error(e.getMessage(), e);
        return new RspDTO(404, "门路不存在，请查看门路是否正确");
    }

    @ExceptionHandler(DuplicateKeyException.class)
    public RspDTO handleDuplicateKeyException(DuplicateKeyException e) {
        logger.error(e.getMessage(), e);
        return new RspDTO(DUPLICATE_KEY_CODE, "数据反复，请查看后提交");
    }

    @ExceptionHandler(Exception.class)
    public RspDTO handleException(Exception e) {
        logger.error(e.getMessage(), e);
        return new RspDTO(500, "零碎忙碌,请稍后再试");
    }
}

4.4. 测试

如下文：的确做到了参数校验时返回异样信息和对应的code，不便了咱们不再繁琐的解决参数校验。

在ValidationMessages.properties 就是校验的message，有着曾经写好的默认的message，且是反对i18n的，大家能够浏览源码赏析。

5.自定义参数注解

5.1. 比方咱们来个自定义身份证校验注解

@Documented
@Target({ElementType.PARAMETER, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = IdentityCardNumberValidator.class)
public @interface IdentityCardNumber {

    String message() default "身份证号码不非法";

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

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

这个注解是作用在Field字段上，运行时失效，触发的是IdentityCardNumber这个验证类。

message 定制化的提示信息，次要是从ValidationMessages.properties里提取，也能够根据理论状况进行定制
groups 这里次要进行将validator进行分类，不同的类group中会执行不同的validator操作
payload 次要是针对bean的，应用不多。

5.2. 而后自定义Validator

这个是真正进行验证的逻辑代码：

public class IdentityCardNumberValidator implements ConstraintValidator<IdentityCardNumber, Object> {

    @Override
    public void initialize(IdentityCardNumber identityCardNumber) {
    }

    @Override
    public boolean isValid(Object o, ConstraintValidatorContext constraintValidatorContext) {
        return IdCardValidatorUtils.isValidate18Idcard(o.toString());
    }
}

IdCardValidatorUtils在我的项目源码中,可自行查看

5.3. 应用自定义的注解

@NotBlank(message = "身份证号不能为空")
@IdentityCardNumber(message = "身份证信息有误,请核查后提交")
private String clientCardNo;

5.4.应用groups的校验

有的宝宝说同一个对象要复用，比方UserDTO在更新时候要校验userId，在保留的时候不须要校验userId，在两种状况下都要校验username，那就用上groups了：

先定义groups的分组接口Create和Update。

import javax.validation.groups.Default;

public interface Create extends Default {
}

import javax.validation.groups.Default;

public interface Update extends Default{
}

再在须要校验的中央@Validated申明校验组

/**
 * 走参数校验注解的 groups 组合校验
 *
 * @param userDTO
 * @return
 */
@PostMapping("/update/groups")
public RspDTO update(@RequestBody @Validated(Update.class) UserDTO userDTO) {
    userService.updateById(userDTO);
    return RspDTO.success();
}

在DTO中的字段上定义好groups = {}的分组类型

@Data
public class UserDTO implements Serializable {

    private static final long serialVersionUID = 1L;

    /*** 用户ID*/
    @NotNull(message = "用户id不能为空", groups = Update.class)
    private Long userId;

    /**
     * 用户名
     */
    @NotBlank(message = "用户名不能为空")
    @Length(max = 20, message = "用户名不能超过20个字符", groups = {Create.class, Update.class})
    @Pattern(regexp = "^[\\u4E00-\\u9FA5A-Za-z0-9\\*]*$", message = "用户昵称限度：最多20字符，蕴含文字、字母和数字")
    private String username;

    /**
     * 手机号
     */
    @NotBlank(message = "手机号不能为空")
    @Pattern(regexp = "^[1][3,4,5,6,7,8,9][0-9]{9}$", message = "手机号格局有误", groups = {Create.class, Update.class})
    private String mobile;

    /**
     * 性别
     */
    private String sex;

    /**
     * 邮箱
     */
    @NotBlank(message = "分割邮箱不能为空")
    @Email(message = "邮箱格局不对")
    private String email;

    /**
     * 明码
     */
    private String password;

    /*** 创立工夫 */
    @Future(message = "工夫必须是未来工夫", groups = {Create.class})
    private Date createTime;

}

留神:在申明分组的时候尽量加上 extend javax.validation.groups.Default 否则,在你申明@Validated(Update.class)的时候，就会呈现你在默认没增加groups = {}的时候的校验组@Email(message = “邮箱格局不对”)，会不去校验，因为默认的校验组是groups = {Default.class}.

5.5.restful格调用法

在多个参数校验，或者@RequestParam 模式时候，须要在controller上加注@Validated。

@GetMapping("/get")
public RspDTO getUser(@RequestParam("userId") @NotNull(message = "用户id不能为空") Long userId) {
    User user = userService.selectById(userId);
    if (user == null) {
        return new RspDTO<User>().nonAbsent("用户不存在");
    }
    return new RspDTO<User>().success(user);
}

@RestController
@RequestMapping("user/")
@Validated
public class UserController extends AbstractController {

....圣洛代码...

6.总结

用起来很简略，soEasy，重点参加的对立构造体返回，对立参数校验，是缩小咱们代码大量的try catch 的法宝，我感觉在我的项目中，将异样解决好，并将异样做好日志治理，才是很好的升华，文章通俗，只是一个菜鸟的进阶笔记….

这里只是个人见解，技术菜，欢送大佬不吝赐教……

近期热文举荐：

1.1,000+ 道 Java面试题及答案整顿(2022最新版)

2.劲爆！Java 协程要来了。。。

3.Spring Boot 2.x 教程，太全了！

4.20w 程序员红包封面，快快支付。。。

5.《Java开发手册（嵩山版）》最新公布，速速下载！

感觉不错，别忘了顺手点赞+转发哦！

关于java:参数校验别再写满屏的-ifelse-了差点被劝退……

1.为什么要用validator

2.什么是javax.validation

3.注解阐明

4.实战演练

4.1. @Validated 申明要查看的参数

4.2. 对参数的字段进行注解标注

4.3. 在全局校验中减少校验异样

4.4. 测试

5.自定义参数注解

5.1. 比方咱们来个自定义身份证校验注解

5.2. 而后自定义Validator

5.3. 应用自定义的注解

5.4.应用groups的校验

5.5.restful格调用法

6.总结

评论

发表回复取消回复

更多文章

DDN HPC 存储硬件架构设计深度分析

探秘IO500：从Lustre并行文件系统出发，开启HPC存储性能新征程

苹果iOS打包的ipa应用无法安装？一篇文章带你了解可能的原因及排查方法

图解Golang：从零开始实现简易版过期LRU缓存

关于java:参数校验别再写满屏的-ifelse-了差点被劝退……

1.为什么要用validator

2.什么是javax.validation

3.注解阐明

4.实战演练

4.1. @Validated 申明要查看的参数

4.2. 对参数的字段进行注解标注

4.3. 在全局校验中减少校验异样

4.4. 测试

5.自定义参数注解

5.1. 比方咱们来个 自定义身份证校验 注解

5.2. 而后自定义Validator

5.3. 应用自定义的注解

5.4.应用groups的校验

5.5.restful格调用法

6.总结

评论

发表回复 取消回复

更多文章

DDN HPC 存储硬件架构设计深度分析

探秘IO500：从Lustre并行文件系统出发，开启HPC存储性能新征程

苹果iOS打包的ipa应用无法安装？一篇文章带你了解可能的原因及排查方法

图解Golang：从零开始实现简易版过期LRU缓存

5.1. 比方咱们来个自定义身份证校验注解

发表回复取消回复