Spring MVC参数校验框架简单实践
程序员文章站
2022-04-13 16:03:26
...
校验框架选择
关于参数校验,网上已有大量的博客。但是大部分都不全面(PS:我在使用的时候竟然校验不了),不知道是jar版本的问题还是什么原因。本文选择hibernate validator的框架进行controller的参数校验,没有什么特别的原因,公司此前一直在用这个框架,也是一个主流的校验框架,大多数人的选择。
maven依赖
spring boot 已经集成此校验框架,故如果你用的是spring boot 此处可以省略。
<!-- https://mvnrepository.com/artifact/org.hibernate/hibernate-validator -->
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.10.Final</version>
</dependency>
校验器配置
@Bean
public Validator validator() {
return Validation.byProvider(HibernateValidator.class)
.configure()
.failFast(true) // 是否快速失败,true-遇到失败即返回错误信息,
// false-校验所有的参数之后再返回最终的结果,多个参数不通过以map的格式返回
.buildValidatorFactory()
.getValidator();
}
代码
- controller 声明
@Validated // 此处可以抽取一个BaseController进行配置,改方式在校验实体参数时可以不必
@RestController
@RequestMapping(value = {"/app/version"})
public class AppVersionController {}
- 单参数校验方式
@GetMapping("/v4")
public AppVersion obtainLastVersion4(@NotNull(message = "app版本号不能为空") Integer version)
- 实体表单校验方式
此处仅实现简单校验,至于实体参数的级联校验,分组校验可自行google
// 实体参数方法声明
@PostMapping
public String save(@Valid AppVersion av){
return "SUCCESS";
}
// 实体声明
public class AppVersion implements Serializable {
@NotNull(message = "版本号不能为空")
@Min(value = 1, message = "版本号不能小于1")
private Integer version; // 版本号
@NotEmpty(message = "版本代码不能为空")
private String versionCode; // 版本代码
}
常用的注解及作用
可通过以下博比较全面的了解
https://blog.csdn.net/danielzhou888/article/details/74740817