七叶笔记 » java编程 » SpringBoot进行参数校验的方法详解

SpringBoot进行参数校验的方法详解

介绍

在日常的接口开发中,为了防止非法参数对业务造成影响,经常需要对接口的参数进行校验,例如登录的时候需要校验用户名和密码是否为空,添加用户的时候校验用户邮箱地址、手机号码格式是否正确。 靠代码对接口参数一个个校验的话就太繁琐了,代码可读性极差。

Validator框架就是为了解决开发人员在开发的时候少写代码,提升开发效率;Validator专门用来进行接口参数校验,例如常见的必填校验,email格式校验,用户名必须位于6到12之间等等。

接下来我们看看在SpringbBoot中如何集成参数校验框架。

1.SpringBoot中集成参数校验

1.1引入依赖

1.2定义参数实体类

常见的约束注解如下:

注解功能@AssertFalse可以为null,如果不为null的话必须为false@AssertTrue可以为null,如果不为null的话必须为true@DecimalMax设置不能超过最大值@DecimalMin设置不能超过最小值@Digits设置必须是数字且数字整数的位数和小数的位数必须在指定范围内@Future日期必须在当前日期的未来@Past日期必须在当前日期的过去@Max最大不得超过此最大值@Min最大不得小于此最小值@NotNull不能为null,可以是空@Null必须为null@Pattern必须满足指定的正则表达式@Size集合、数组、map等的size()值必须在指定范围内@Email必须是email格式@Length长度必须在指定范围内@NotBlank字符串不能为null,字符串trim()后也不能等于""@NotEmpty不能为null,集合、数组、map等size()不能为0;字符串trim()后可以等于""@Range值必须在指定范围内@URL必须是一个URL

1.3定义校验类进行测试

这里我们先定义两个方法add,edit,都是使用了 @RequestBody注解,用于接受前端发送的json数据。

1.4打开接口文档模拟提交数据

通过接口文档看到前三个字段都是必填项。

由于email的格式不对就被拦截了,提示是因为邮箱地址不对。

2.参数异常加入全局异常处理器

虽然我们之前定义了全局异常拦截器,也看到了拦截器确实生效了,但是Validator校验框架返回的错误提示太臃肿了,不便于阅读,为了方便前端提示,我们需要将其简化一下。

直接修改之前定义的 RestExceptionHandler,单独拦截参数校验的三个异常:

javax.validation.ConstraintViolationException

org.springframework.validation.BindException

org.springframework.web.bind.MethodArgumentNotValidException

代码如下:

美化之后错误信息提示更加友好

3.自定义参数校验

虽然Spring Validation 提供的注解基本上够用,但是面对复杂的定义,我们还是需要自己定义相关注解来实现自动校验。比如上面实体类中添加的sex性别属性,只允许前端传递传 M,F 这2个枚举值,如何实现呢?

3.1创建自定义注解

3.2自定义校验逻辑

3.3在字段上增加注解

3.4体验效果

4.分组校验

一个对象在新增的时候某些字段是必填,在更新是有非必填。如上面的 SysDictType中id 属性在新增操作时都是必填。 面对这种场景你会怎么处理呢?

其实 Validator校验框架已经考虑到了这种场景并且提供了解决方案,就是分组校验。 要使用分组校验,只需要三个步骤:

4.1定义分组接口

4.2在模型中给参数分配分组

4.3体现效果

以上就是SpringBoot进行参数校验的方法详解的详细内容,更多关于SpringBoot参数校验的资料请关注七叶笔记其它相关文章!

相关文章