网站设计网站建设专业,挂机宝可以做网站吗,西安建设市场诚信信息平台网站,推广引流平台前言
在实际开发中#xff0c;我们无法保证客户端传来的请求都是合法的。比如一些要求必传的参数没有传递#xff0c;传来的参数长度不符合要求等#xff0c;这种时候如果放任不管#xff0c;继续执行后续业务逻辑#xff0c;很有可能就会出现意想不到的bug。
有人可能会…前言
在实际开发中我们无法保证客户端传来的请求都是合法的。比如一些要求必传的参数没有传递传来的参数长度不符合要求等这种时候如果放任不管继续执行后续业务逻辑很有可能就会出现意想不到的bug。
有人可能会说这不是前端的问题吗让前端校验去。话是这么说但我们也不能前端校验百分百不会出现问题。并且有些请求可能也不是正规通过客户端发来的可能是黑客恶意攻击又或是通过Postman等发来的这些请求就不一定会“合法”了。
因此对客户端传来的每个请求都进行必要的参数校验是十分重要的。而很多简单的校验如果都需要程序员自己去写的话就会导致代码过于冗长、繁琐。为了让校验更加简洁明了Spring为我们提供了Validation工具类来提供各种校验方法。
一、Validation常见的校验注解
空校验注解 Null被注释的元素必须为null。NotNull被注释的元素必须不为null。NotBlank被注释的字符串去掉前后空格后长度必须非零。NotEmpty被注释的字符串、集合或数组不能为空字符串长度非零、集合大小非零。 布尔校验注解 AssertTrue被注释的元素必须为true。AssertFalse被注释的元素必须为false。 日期校验注解 Past被注释的元素必须是一个过去的日期。Future被注释的元素必须是一个将来的日期。 数字校验注解 Min(value)被注释的元素必须是一个数字其值必须大于等于指定的最小值。Max(value)被注释的元素必须是一个数字其值必须小于等于指定的最大值。DecimalMin(value)被注释的元素必须是一个数字其值必须大于等于指定的最小值。DecimalMax(value)被注释的元素必须是一个数字其值必须小于等于指定的最大值。 长度校验注解 Size(max, min)被注释的元素如字符串、集合、数组的大小必须在指定的范围内。 模式匹配校验注解 Pattern(regexp)被注释的元素必须符合指定的正则表达式。 邮箱校验注解 Email被注释的元素必须是电子邮箱地址。 范围校验注解 Range(min, max)被注释的元素必须在合适的范围内。 二、Validation的简单应用
首先我们需要导入Validation的依赖
!--validation依赖,负责参数校验--
dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-validation/artifactId
/dependency接着在需要使用校验的类上添加Validation注解 接着主要有两种方式使用校验注解
1、直接在对应参数上加上注解
RestController
RequestMapping(/user)
Validation
public class UserController {RequestMapping(/login)public Result login(Size(max 12,min 4) String username, Pattern(regexp ^\S{5,16}$) String password){//登录return Result.success();}}2、实体类添加校验
对于一些实体类来说直接在参数上加注解就不太可取了程序会无法定位到指定参数。
需要再实体类内部对应的变量上添加注解
Data
NoArgsConstructor
AllArgsConstructor
public class Category {NotNullprivate Integer id;//主键IDNotEmptyprivate String categoryName;//分类名称NotEmptyprivate String categoryAlias;//分类别名private Integer createUser;//创建人IDJsonFormat(pattern yyyy-MM-dd HH:mm:ss)private LocalDateTime createTime;//创建时间JsonFormat(pattern yyyy-MM-dd HH:mm:ss)private LocalDateTime updateTime;//更新时间
}接着在使用实体类的地方加上 Validated 注解就能让这些校验生效了
PutMapping(/update)public Result update(RequestBody Validated User user){//业务逻辑return Result.success();}二、分组校验
前面我们介绍了如何在实体类中添加校验注解。但是事实上在实现不同功能时对同一个实体类的校验规则可能是会有差异的。 比如在添加用户的场景下用户的id值就是在存入数据库后生成的在参数传递时自然就不是必传项而在更新用户的场景下我们需要通过id定位指定用户完成信息更新操作这时在参数传递时id就是必传项了。 这样对id值的校验就会产生冲突了。如果将id设定为必传值那么就会导致添加用户的操作可能出现错误。不把id设定为必传值更新用户的操作又会出现错误。
为了应对这一问题就可以对校验项进行分组归类。具体操作步骤如下
在实体类内部定义相应组别接口
public class User {//各成员变量//添加用户类分组public interface Add extends Default {}//更新用户类分组public interface Update extends Default{}
}注意如果没有手动对校验项进行分组其默认就在 Default 组 对校验项进行分组只需要通过groups属性指定组别即可
NotNull(groups Update.class)接着在校验时指定对应的分组即可
PutMapping
public Result update(RequestBody Validated(User.Update.class) User user){//业务逻辑return Result.success();
}PostMapping
public Result add(RequestBody Validated(User.Add.class) User user){//业务逻辑return Result.success();
}这样就能实现不同业务场景下的多样化校验了。
三、自定义校验
实际开发中的校验规则可能是五花八门的但官方提供的校验注解就这么多很多时候并不能满足我们的校验需求。这时候就需要通过自定义校验注解来实现个性化的校验了。
首先需要定义一个注解
Documented //元注解
Target(ElementType.FIELD) //元注解
Retention(RetentionPolicy.RUNTIME) //元注解
Constraint(validatedBy {/*校验规则*/}) //自定义校验规则
public interface State {//提供校验失败后的提示信息String message() default state参数的值只能是已发布或草稿;//指定分组Class?[] groups() default {};//负载 获取到State注解的附加信息Class? extends Payload[] payload() default {};
}接着定义一个类去实现 ConstraintValidator 接口并实现 isValid 方法
public class StateValidation implements ConstraintValidatorState,String {Overridepublic boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext) {//返回true表示校验通过返回false则表示校验不通过if(valuenull) return false;if(value.equals(已发布)||value.equals(草稿))return true;return false;}
}然后就要在之前定义的注解中的Constraint中填入自定义类
Constraint(validatedBy {StateValidation.class}) //自定义校验规则接着就可以像使用其它校验注解一样来使用自己自定义的注解了 那么本篇文章就到此为止了如果觉得这篇文章对你有帮助的话可以点一下关注和点赞来支持作者哦。如果有什么讲的不对的地方欢迎在评论区指出希望能够和你们一起进步
