参数校验别再写满屏的 if/else 了,差点被劝退……(上)

简介: 参数校验别再写满屏的 if/else 了,差点被劝退…(上)

很痛苦遇到大量的参数进行校验,在业务中还要抛出异常或者不断的返回异常时的校验信息,在代码中相当冗长,充满了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/spring-boot-best-practice


在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>

image.png


3.注解说明

@NotNull:不能为null,但可以为empty(""," "," ")


@NotEmpty:不能为null,而且长度必须大于0 (" "," ")


@NotBlank:只能作用在String上,不能为null,而且调用trim()后,长度必须大于0("test") 即:必须有实际字符

55dad4326b1d452fb94d90f7f134e364.jpg

此处只列出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,方便了我们不再繁琐的处理参数校验。

image.png

在ValidationMessages.properties 就是校验的message,有着已经写好的默认的message,且是支持i18n的,大家可以阅读源码赏析。

目录
打赏
0
0
0
1
308
分享
相关文章
|
2月前
|
理所当然也能错,数学界震动:上下铺猜想被证伪
上下铺猜想是图论中的一个命题,断言在任何有限图中,如果将顶点排成一行,使每条边连接的顶点位置相邻或相隔一个位置,则图一定是二分图。然而,近期研究通过构造反例证明了这一猜想是错误的。这一结果不仅挑战了数学家的直觉,也为图论的结构性质提供了新的视角,强调了数学的严谨性和反直觉现象的重要性。
188 93
网工救急秘籍:四种恢复 console 口密码的神奇方法背后藏着怎样的玄机?
【8月更文挑战第19天】作为网络工程师,遇到设备console口密码遗忘实属头疼。这里有四大救急法助你迅速解决:一是调整配置寄存器值让设备忽略原有配置;二是利用无密码的备份配置文件恢复;三是重置设备至出厂设置(慎用);四是通过硬件短接清除密码(需谨慎)。这些方法曾在关键时候帮助我解决了客户的网络危机,避免业务中断。记得恢复后要设置强密码并妥善保管,确保网络安全稳定。
131 0
|
8月前
|
不扒瞎,这个程序让我从150s优化到了5s
在优化一个业务开发组的生产问题时,发现销售管理系统查询数据延迟高达2-3分钟。问题根源在于,程序在for循环中频繁读取Redis大KEY数据,导致性能下降。解决方案是采用本地缓存HutoolCache,将耗时降至毫秒级别。此外,还对RedisTemplate配置进行了研究,Jackson2JsonRedisSerializer在序列化时包括了所有字段,即使字段值为null,增加了数据体积。通过对ObjectMapper的调整,仅序列化非空字段,可以显著提升redis读取性能。本文同时还提醒我们在使用Redis时要注意大对象缓存,强调了正确使用和配置缓存以及避免大对象存储的重要性。
79 5
求求你不要写满屏的 try...catch 了,这才是优雅的处理方式,真香...
求求你不要写满屏的 try...catch 了,这才是优雅的处理方式,真香...
292 0
求求你不要写满屏的 try...catch 了,这才是优雅的处理方式,真香...
前端工作总结152-报错可以直接查看下面红字寻找对应的报错
前端工作总结152-报错可以直接查看下面红字寻找对应的报错
301 0
前端工作总结152-报错可以直接查看下面红字寻找对应的报错
参数校验别再写满屏的 if/else 了,差点被劝退……(下)
参数校验别再写满屏的 if/else 了,差点被劝退……(下)
126 0
又烧脑又炫技还没什么用,在代码里面打印自身
又烧脑又炫技还没什么用,在代码里面打印自身
230 0
又烧脑又炫技还没什么用,在代码里面打印自身
为何代码没错,却出不来结果,你可能...
为何代码没错,却出不来结果,你可能...
143 0
为何代码没错,却出不来结果,你可能...

热门文章

最新文章

AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等