如何优雅地进行参数校验
写在前面
再Javaweb的开发中,为了防止懂技术的人对数据库的恶意攻击,我们通常使用参数校验对无效数据进行筛选,Java生态下的@valid注解配置SpringBoot的使用可以方便快速的完成对数据校验的各种场景
同时数据校验分为前端校验和后端校验
前端校验
通常我们使用脚手架快速搭建页面,比如element-ui提供了可以参数校验的表单,官方文档有较为详细的使用教程,传送门,在此就不再重复,本文重点在于后端的参数校验
后端校验
如果有人拿到了url地址,使用第三方测试工具比如postman就可以跳过前端页面的参数检验,所以为了数据库数据正确性,我们十分有必要对传来的数据在后端进行第二次校验
一、普通的字段校验
基本的使用步骤
1.引入依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
2.在实体类entity需要检验的字段上加上注解
常见的注解,这里只是列举一些
@NotEmpty:加了此注解的String类、Collection、Map、数组,是不能为null或者长度为0的(String Collection Map的isEmpty()方法)
@NotBlank:只用于String,不能为null且trim()之后size>0
@NotNull:不能为null,但可以为empty,没有Size的约束
@Pattern(value):val为指定的正则表达式
在要检验的字段上加上注解,同时指定如果不匹配的报错信息
3.开启校验,如果只是加注解并不生效
如图所示,列举一个简单的例子,刚刚我们在NewsVo的title中加上了@NotBlank注解,此时我们在方法中加入@Valid注解,这样便完成了参数校验的简单使用
简单测试一下
我们发现返回的信息十分复杂,我们希望可以在项目中统一返回错误信息
4.统一返回错误信息和状态码
我们需要定义一个异常捕获处理类,和一个状态码Enum枚举类来规范返回的数据
- Enum枚举类
public enum CodeEnum {
// 根据自己的项目需求更改状态码,这里只是一个示范
UNKNOW_EXCEPTION(10000,"系统未知错误"),
VALID_EXCETIPON(10001,"参数格式校验错误");
private int code;
private String msg;
CodeEnum(int code, String msg){
this.code = code;
this.msg = msg;
}
public int getCode() {
return code;
}
public void setCode(int code) {
this.code = code;
}