实用———springmvc接收参数校验
Posted a1304908180
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了实用———springmvc接收参数校验相关的知识，希望对你有一定的参考价值。
https://www.cnblogs.com/funyoung/p/8670550.html
https://www.cnblogs.com/monkeydai/p/10068547.html
SpringMVC参数校验
使用SpringMVC时配合hibernate-validate进行参数的合法性校验，能节省一定的代码量。
1.搭建Web工程并引入hibernate-validate依赖
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.7.Final</version>
</dependency>
Maven依赖传递，自动依赖validation-api、jboss-logging、classmate。
2.使用校验注解标注在属性上(DTO)
*每个注解都有message属性，该属性用于填写校验失败时的异常描述信息，当校验失败时可以获取对应的message属性值。
按 Ctrl+C 复制代码
按 Ctrl+C 复制代码
3.控制层中使用DTO接收参数并使用@Validated/@Valid注解开启对参数的校验
*@Validated注解表示开启Spring的校验机制，支持分组校验,声明在入参上。
*@Valid注解表示开启Hibernate的校验机制，不支持分组校验,声明在入参上。
*在DTO后面紧跟BindingResult对象，那么当参数不符合时，能通过该对象直接获取不符合校验的message描述信息。
*若使用了@Validated/@Valid注解开启校验，但DTO后面没有紧跟BindingResult对象，那么当参数不符合时，将直接返回400 Bad Request状态码。
按 Ctrl+C 复制代码
按 Ctrl+C 复制代码
演示：
结果：
密码不能为空! id不能为空! 用户名的长度在4~12之间!
*校验的顺序是随机的，因此程序不能依赖校验的顺序去做相关的逻辑处理。
4.分组校验
每个校验注解都有group属性用于指定校验所属的组，其值是Class数组，在Controller中使用@Validated注解开启对参数的校验时若指定要进行校验的组，那么只有组相同的属性才会被进行校验(默认全匹配)
Class<?>[] groups() default ;
一般定义标识接口作为组资源
public interface GroupA public interface GroupB
使用校验注解标注在属性上并进行分组
public class User
@NotNull(message="id不能为空!",groups = GroupA.class)
private Integer id;
@NotBlank(message="用户名不能为空!",groups = GroupB.class)
@Size(min=4,max=12,message="用户名的长度在4~12之间!")
private String username;
@NotBlank(message="密码不能为空!")
private String password;
@Email(message="非法邮箱!")
private String email;
public Integer getId()
return id;
public void setId(Integer id)
this.id = id;
public String getUsername()
return username;
public void setUsername(String username)
this.username = username;
public String getPassword()
return password;
public void setPassword(String password)
this.password = password;
public String getEmail()
return email;
public void setEmail(String email)
this.email = email;
public User()
super();
Controller中使用@Validated注解开启对参数的校验并指定校验的组，那么只有组相同的属性才会被进行校验(默认全匹配)
@RestController
public class BaseController
@RequestMapping("/test")
public User test(@Validated(value= GroupB.class) User user, BindingResult result)
if (result.hasErrors())
List<ObjectError> errors = result.getAllErrors();
for (ObjectError error : errors)
System.out.println(error.getDefaultMessage());
return user;
演示：
结果：
用户名不能为空!
*后端一般只返回重名等错误描述信息，对于非空、字符长度、手机邮箱合法性校验等由前端进行判断并提示，后端校验不通过时不返回错误描述信息，所以不需要使用BindingResult获取错误描述，当参数不符合时直接返回400 Bad Request请求。
spring mvc 参数校验
spring mvc中的参数校验
spring mvc 支持jsr-303 Bean验证框架，默认实现是使用的Hibernate validator。在spring mvc中只需要使用@Validated注解在方法参数上即可对参数对象进行校验。校验结果放在BindingResult中，所以每个被校验的参数后面都需要放一个BindingResult。
因为有时候并不是所有的地方需要的验证都是一样的，例如更新的时候需要id notnull，而插入的时候确需要id为null，所以验证的时候在每个验证条件中都增加了groups属性，用于标识需要哪种校验，而在@validated中可以设置vlue属性，用于和验证条件中的groups配合使用，只有@Validated中的value类型和验证注解中的groups属性一致的时候才进行校验。
JSR-303提供的常用的校验注解主要有以下几类
空类型检查
@Null验证对象必须为空
@NotNull验证对象不能为空
@NotBlank 验证对象不能为空字符串
@NotEmpty 验证对象不能为空，集合类型不能为空
长度检查
@Size(min= ,max=) 验证对象长度，支持字符串和集合
@Length 验证字符串长度
数值检查
@Max 验证数字大小是否小于某个数值
@Min 验证数字大小是否大于某个数值
@Digits 验证数字是否符合某个格式例如：整数3为，小数2位
@Range 验证数值是否在某个范围之内
其他检查
@Email 验证是否位邮件格式，若为null则不做校验
@Pattern 验证是否符合正则表达式规则
例子
在controller中使用@Validated注解
1 @Controller
2 @RequestMapping("valid")
3 @Slf4j
4 public class ValidateController
5
6 private static final String BASE_PATH = "/valid/";
7
8 @RequestMapping("index")
9 public String index(@Validated() Student student,BindingResult result)
10 if(result.hasErrors())
11 StringBuffer sb = new StringBuffer();
12 List<FieldError> errorList = result.getFieldErrors();
13 errorList.stream().forEach(error->
14 String message = error.getDefaultMessage();
15 String field = error.getField();
16 sb.append(field).append(":").append(message).append(",");
17 );
18 log.error(sb.toString());
19
20
21 return BASE_PATH + "index";
22
23
在bean中使用验证注解
@Data
public class Student
@Length(max = 32,min = 32,groups = )
private String id;
@NotNull
@Size(max = 50)
private String name;
@Max(100)
@Min(12)
@NotNull
private Integer age;
@Email
@NotNull
private String email;
@AssertFalse
private Boolean isLeader;
@WorkOverTime
private String workOverTime;
这样在前台请求该方法的时候就会进行自动校验。而校验结果会保存在BindingResult中。可以通过hasErrors判断校验是否通过，getFieldErrors可以获取所有的错误。
自定义参数校验
有的时候自带的参数校验类型并不能满足我们的需求，这时我们可以自定校验注解。
定义自定义注解类：
@Constraint(validatedBy = ValidatedWorkOverTime.class)
@Documented
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface WorkOverTime
String message() default "加班时长不能超过max小时";
int max() default 5;
Class<?>[] groups() default ;
Class<? extends Payload>[] payload() default ;
在这个类中我们使用Constraint注解声明我们需要使用哪个类来进行具体的验证。
注解类中必须包含1.错误信息。即message方法，2.验证规则分组，即gourps方法，3.验证的有效负荷即payload方法。
我们还必须实现一个类来进行具体的验证。即上面Constraint声明的类。
@Slf4j
public class ValidatedWorkOverTime implements ConstraintValidator<WorkOverTime,Object>
private Integer max;
private WorkOverTime workOverTime;
@Override
public void initialize(WorkOverTime constraintAnnotation)
this.max = constraintAnnotation.max();
this.workOverTime = constraintAnnotation;
@Override
public boolean isValid(Object integer, ConstraintValidatorContext constraintValidatorContext)
Integer overWorkTime = Integer.MAX_VALUE;
if(integer instanceof Integer)
overWorkTime = (Integer) integer;
else
try
overWorkTime = Integer.parseInt(integer.toString());
catch (Exception e)
log.error(e.toString(),e);
if(e instanceof NumberFormatException)
return max>overWorkTime;
这样我们就可以在bean中的属性中使用@WorkOverTime注解来进行参数校验了。
以上是关于实用———springmvc接收参数校验的主要内容，如果未能解决你的问题，请参考以下文章
springmvc数据校验。（后台校验 hibernate validate）.
SpringMvc，Springboot统一校验自定义异常全局异常处理
SpringMvc，Springboot统一校验自定义异常全局异常处理