专栏首页Java系列文章SpringBoot如何优雅的校验参数

SpringBoot如何优雅的校验参数

前言

做web开发有一点很烦人就是要校验参数,基本上每个接口都要对参数进行校验,比如一些格式校验 非空校验都是必不可少的。如果参数比较少的话还是容易 处理的一但参数比较多了的话代码中就会出现大量的IF ELSE就比如下面这样:

这个例子只是校验了一下空参数。如果需要验证邮箱格式和手机号格式校验的话代码会更多,所以介绍一下validator通过注解的方式进行校验参数。

什么是Validator

Bean Validation是Java定义的一套基于注解的数据校验规范,目前已经从JSR 303的1.0版本升级到JSR 349的1.1版本,再到JSR 380的2.0版本(2.0完成于2017.08),已经经历了三个版本 。在SpringBoot中已经集成在 starter-web中,所以无需在添加其他依赖。

注解介绍

validator内置注解

被注释的元素必须为 null

Hibernate Validator 附加的 constraint

被注释的元素必须是电子邮箱地址

注意

  • @NotNull 适用于任何类型被注解的元素必须不能与NULL
  • @NotEmpty 适用于String Map或者数组不能为Null且长度必须大于0
  • @NotBlank 只能用于String上面 不能为null,调用trim()后,长度必须大于0

使用

使用起来也非常简单,下面略过创建项目

模拟用户注册封装了一个UserDTO

当提交数据的时候如果使用以前的做法就是IF ELSE判断参数使用validator则是需要增加注解即可。

例如非空校验:

然后需要在controller方法体添加@Validated不加@Validated校验会不起作用

然后请求一下请求接口,把Email参数设置为空

参数:

{
	"userName":"luomengsun",
	"mobileNo":"11111111111",
	"sex":1,
	"age":21,
	"email":""
}

返回结果:

后台抛出异常

这样是能校验成功,但是有个问题就是返回参数并不理想,前端也并不容易处理返回参数,所以我们添加一下全局异常处理,然后添加一下全局统一返回参数这样比较规范。

添加全局异常

创建一个GlobalExceptionHandler类,在类上方添加@RestControllerAdvice注解然后添加以下代码:

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

此方法主要捕捉MethodArgumentNotValidException异常然后对异常结果进行封装,如果需要在自行添加其他异常处理。

添加完之后我们在看一下运行结果,调用接口返回:

{
    "code": "9999",
    "desc": "邮箱不能为空",
    "data": null
}

OK 已经对异常进行处理。

校验格式

如果想要校验邮箱格式或者手机号的话也非常简单。

校验邮箱

    /**
     * 邮箱
     */
    @NotBlank(message = "邮箱不能为空")
    @NotNull(message = "邮箱不能为空")
    @Email(message = "邮箱格式错误")
    private String email;

使用正则校验手机号

校验手机号使用正则进行校验,然后限制了一下位数

    /**
     * 手机号
     */
    @NotNull(message = "手机号不能为空")
    @NotBlank(message = "手机号不能为空")
    @Pattern(regexp ="^[1][3,4,5,6,7,8,9][0-9]{9}$", message = "手机号格式有误")
    @Max(value = 11,message = "手机号只能为{max}位")
    @Min(value = 11,message = "手机号只能为{min}位")
    private String mobileNo;

查看一下运行结果

传入参数:

{
	"userName":"luomengsun",
	"mobileNo":"111111a",
	"sex":1,
	"age":21,
	"email":"1212121"
}

返回结果:

{
    "code": "9999",
    "desc": "邮箱格式错误",
    "data": null
}

这里不再验证手机号的例子

自定义注解

上面的注解只有这么多,如果有特殊校验的参数我们可以使用Validator自定义注解进行校验

首先创建一个IdCard注解类

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

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

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

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

}

在UserDTO中添加@IdCard注解即可验证,在运行时触发,本文不对自定义注解做过多的解释,下篇文章介绍自定义注解

  • message 提示信息
  • groups 分组
  • payload 针对于Bean

然后添加IdCardValidator 主要进行验证逻辑

上面调用了is18ByteIdCardComplex方法,传入参数就是手机号,验证身份证规则自行百度:see_no_evil:

然后使用

    @NotNull(message = "身份证号不能为空")
    @IdCard(message = "身份证不合法")
    private String IdCardNumber;

分组

就比如上面我们定义的UserDTO中的参数如果要复用的话怎么办?

在重新定义一个类然后里面的参数要重新添加注解?

Validator提供了分组方法完美了解决DTO服用问题

现在我们注册的接口修改一下规则,只有用户名不能为空其他参数都不进行校验

先创建分组的接口

public interface Create  extends Default {
}

我们只需要在注解加入分组参数即可例如:

  /**
     * 用户名
     */
    @NotBlank(message = "用户姓名不能为空",groups = Create.class)
    @NotNull(message = "用户姓名不能为空",groups = Create.class)
    private String userName;

    @NotBlank(message = "邮箱不能为空",groups = Update.class)
    @NotNull(message = "邮箱不能为空",groups = Update.class)
    @Email(message = "邮箱格式错误",groups = Update.class)
    private String email;

然后在修改Controller在@Validated中传入Create.class

    @PostMapping("/user")
    public ReturnVO userRegistra(@RequestBody @Validated(Create.class) UserDTO userDTO){
        ReturnVO returnVO = userService.userRegistra(userDTO);
        return returnVO ;
    }

然后调用传入参数:

{
	"userName":"",
}

返回参数:

{
    "code": "9999",
    "desc": "用户姓名不能为空",
    "data": null
}

OK 现在只对Create的进行校验,而Updata组的不校验,如果需要复用DTO的话可以使用分组校验

校验单个参数

在开发的时候一定遇到过单个参数的情况,在参数前面加上注解即可

    @PostMapping("/get")
    public ReturnVO getUserInfo(@RequestParam("userId") @NotNull(message = "用户ID不能为空") String userId){
        return new ReturnVO().success();
    }

然后在Controller类上面增加@Validated注解,注意不是增加在参数前面。

本文分享自微信公众号 - 乱敲代码(gh_baf1250e9b02),作者:乱敲代码

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2019-12-09

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • Spring Boot 2动态修改日志级别

    作为程序猿,定位问题是我们的日常工作,而日志是我们定位问题非常重要的依据。传统方式定位问题时,往往是如下步骤:

    乱敲代码
  • @ConditionalOn...注解,条件组合你知道吗?

    上一篇文章 你应该知道的 @ConfigurationProperties 注解的使用姿势,这一篇就够了 介绍了如何通过 @ConfigurationPrope...

    乱敲代码
  • 如何使用Arrays工具类操作数组

    我们要先知道Arrays 是什么。 java.util.Arrays 类是 JDK 提供的一个工具类主要用来操作数组,比如数组的复制转换等各种方法,Arrays...

    乱敲代码
  • 为什么我不建议你在当前购买 5G 手机

    每年的八九月份都是各大厂商发布年自己旗舰机的时候,最近 vivo、oppo、小米、华为、苹果接连发布了自己的年度旗舰,这当中除了苹果,其它厂商均发布了 5G 版...

    张磊BARON
  • 如何开心愉快兴趣满满的学习机器人和人工智能知识并提升思维力

    涉及知识点:编程基础Python,图像识别OpenCV,机器人学相关,如:传感器信息融合,运动控制,策略规划等,人工智能相关,如强化学习等。环境如下图所示:

    zhangrelay
  • ABAP Netweaver里的附件病毒扫描实现Virus Scan

    版权声明:本文为博主原创文章,遵循 CC 4.0 by-sa 版权协议,转载请附上原文出处链接和本声明。

    Jerry Wang
  • 一文总结学习 Python 的 14 张思维导图

    大数据时代,数据是智能世界的土壤,发达的数据文明孕育于此之上。但大数据只是一种资源,它告知信息但不解释,只有学会深耕这片土地,真正挖掘到深埋土壤之下的数据金矿,...

    钱塘数据
  • Python 基础知识学习

          Python中默认的编码格式是 ASCII 格式在没修改编码格式时无法正确打印汉字所以在读取中文           时会报错解决方法为只要在文件开...

    用户2398817
  • 日本女排的新陪练:可以模仿对手球风的机器人

    问耕 编译 量子位 报道 | 公众号 QbitAI ? 为了强化进攻能力,日本顶级排球运动员有了一个新的陪练:机器人。而且是可以模仿对手球风的机器人。 日本排协...

    量子位
  • 图解数据结构之数组、链表、栈、队列

    今天带各位回顾一下线性数据结构:数组、链表、栈、队列,相信通过下面的文字,你会加深对这几种数据结构的认识。

    Java3y

扫码关注云+社区

领取腾讯云代金券