项目开发中我们经常需要对接口参数进行检验,有些参数必须有值,有些参数比如手机号,身份证号必须符合一定的格式规范。如果把参数检验都写在业务代码中,会造成业务代码又长又杂,且每个接口都得去校验,影响开发效率以及代码质量。有没有方法可以把参数检验统一在一个地方进行,不对我们的业务代码进行干扰呢?
SpringMVC给我们提供了一些支持数据校验的注解,如@NotNull,@NotBlank,@Length(min=,max=)等,将这些注解添在bean的属性上,结合在Controller里对请求参数添加@Valid注解即可完成参数的校验。
实例演练:
1、创建需要被校验的实体类:
package com.ouyangjia.miaosha.vo;
import lombok.Data;
import org.hibernate.validator.constraints.NotBlank;
@Data
public class LoginVo {
@NotBlank(message="电话号码不能为空")
private String phone;
@NotBlank(message="密码不能为空")
private String password;
}
2、controller 接口设计,在参数接受的地方添加 @Valid
关键字:
@RequestMapping("/do_login_1")
@ResponseBody
public Result<String> doLogin_1(@RequestBody@Valid LoginVo loginVo){
log.info(loginVo.toString());
String str=loginService.login(loginVo);
return Result.success(str);
}
3、访问测试,数据如下:
{
"phone":"",
"password":""
}
4、响应为:
{
"timestamp": 1537152065877,
"status": 400,
"error": "Bad Request",
"exception": "org.springframework.web.bind.MethodArgumentNotValidException",
"errors": [
{
"codes": [
"NotBlank.loginVo.password",
"NotBlank.password",
"NotBlank.java.lang.String",
"NotBlank"
],
"arguments": [
&n