1. 为什么要进行参数校验
在后端进行工作时,需要接收前端传来的数据去数据库查询,但是如果有些数据过于离谱,我们就可以直接把它pass掉,不让这种垃圾数据接触数据库,减小数据库的压力。
有时候会有不安分的人通过一些垃圾数据攻击咱们的程序,让咱们的服务器或数据库崩溃,这种攻击虽然低级但不得不防,就像QQ进行登录请求时,它们向后端发送 账号=123,密码=123 的数据,一秒钟还发1w次,这很明显就是找事的好吧,什么人类的手速能达到1秒1万次?
解决方法是:一方面我们可以通过Redis记录ip/账号的方式拒绝一部分请求,例如1s中同一个ip/账号最多请求100次。在数据校验过程中,有一部分数据被通过了,但在这100条数据中有多少是垃圾数据,另一方面需要考虑。这样就可以尽量减小服务器数据库的压力。
2. 如何实现参数校验
实现参数校验说实话方式还挺多,个人使用过直接在Controller代码里面写、AOP+自定义注解、ConstraintValidator
。本篇博客讲的是ConstraintValidator
实现。
在Controller代码内直接编写这段代码虽然容易,但代码体积庞大,耦合度高,最主要的是缺乏优雅性。
AOP实现有难度,代码繁琐,显得逻辑杂乱。
所以我建议使用ConstraintValidator
。
在这里先提供一个工具类进行参数校验,提供了对于手机号、邮箱、验证码、密码、身份证号的验证方法,可以直接copy来用。等下进行参数校验时我使用的就是这个类里的校验方法。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
|
使用案例:
1 2 3 4 5 |
|
3. 注解实现参数校验
首先导入依赖:
1 2 3 4 |
|
导入依赖后可以尝试使用一下它自带的参数校验注解:@NotNull 非空校验
先来说一下这注解实现参数校验的使用步骤。
在平时写的demo中,本人比较喜欢对接口另外定义vo来接收数据,例如前端传的数据是user对象里的username和password,我们的user里有很多字段,如果单纯使用user就太浪费了,而且如果直接在实体类上进行自定义注解会对实体类造成代码污染。所以个人认为定义vo类是很有必要的。
以下是我的登录接口:
1 2 3 4 5 |
|
以下是我登录接口的vo类:
1 2 3 4 5 6 7 8 |
|
大家可能注意到我多写了两个注解:@Validated、@NotNull(message = “邮箱不能为空”)
对,使用注解进行参数校验就分为两步:
在需要进行校验的字段上加对应校验方式,如@NotNull
在需要进行校验的接口参数前加@Validated,告诉Spring,这个类你给我看一下,里面有的字段加了校验注解,符合要求就放行,不符合要求就报错。
如图所示:
使用postman发起请求,故意使得邮箱为空:
会发现报错:
Resolved [org.springframework.web.bind.MethodArgumentNotValidException:
Validation failed for argument [0] in public java.lang.String com.example.demo.controller.UserController.login(com.example.demo.domain.vo.LoginVo):
[Field error in object 'loginVo' on field 'email': rejected value [null]; codes [NotNull.loginVo.email,NotNull.email,NotNull.java.lang.String,NotNull]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [loginVo.email,email]; arguments [];
default message [email]];
default message [邮箱不能为空]] ]
出现这个异常:MethodArgumentNotValidException
,我们就可以在全局异常处理器中捕获它,返回一个较为规范的信息。
4. 自定义注解实现参数校验
学习了如何使用注解进行参数校验,我们就可以进行接下来的工作:自定义注解。
由于需求的复杂,我们现在需要完成注册接口,注册时需要身份证号、电话号码、邮箱、密码,这些字段的注解校验Spring并没有帮我们实现,此时就需要DIY注解满足需求。
如何实现自定义注解?我们先模仿,先来看看@NotNull注解里面有什么:
@Target、@Retention、@Repeatable、@Documented这些常用的注解就不再解释,
@Constraint:表示此注解是一个参数校验的注解,validateBy指定校验规则实现类,这里需要填实现类.class。
各个字段的含义:
message :数据不符合校验规则后的报错信息。如果需要校验多个字段,建议实现文件形式,以字符串或文件形式传递数据均可。
groups :指定注解使用场景,例如新增、删除
payload :往往对Bean使用
以上这三个字段都是必须的,每一个使用ConstraintValidator完成参数校验都要有这三个字段。
后面的那个List是NotNull专属的,所以不必关心。
那么我们大可以模仿@NotNull来实现自定义注解。
第一步:实现校验类:
需要实现一个接口:ConstraintValidator<?, ?>
# ConstraintValidator<?, ?>
第一个参数是自定义注解
第二个参数是需要进行校验的数据的数据类型
例如想对手机号校验,第一个参数是Phone,第二个参数是String
这个接口提供了一个方法:
1 |
|
第一个参数就是前端传来的数据。我们可以对这个数据进行判断,返回一个布尔值
1 2 3 4 5 6 7 8 |
|
第二步:实现注解,这个注解的名称需要与ConstraintValidator的第一个参数保持一致。
特别注意的是,@Constraint注解里面的validatedBy的值是第一步的Class实例。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
|
第三步:在字段上加上相应注解。
1 2 3 4 5 6 7 8 9 10 11 12 13 |
|
第四步:在参数前加上@Validated
。
1 2 3 4 |
|
这样一来,就优雅的实现了参数校验。如果你不想在每个controller里都这样写,那么请不要认为我们分这么多类很麻烦
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
|
真的很low很麻烦好吗。
可能步骤有点繁琐,不过也就4步,画张图加强一下记忆:
以上就是SpringBoot如何通过自定义注解实现参数校验的详细内容
发表评论:
◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。