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属性值。

 

public class User {
@NotNull(message</span>="id不能为空!"<span style="color: #000000;">)
</span><span style="color: #0000ff;">private</span><span style="color: #000000;"> Integer id;

@NotBlank(message</span>="用户名不能为空!"<span style="color: #000000;">)<br>    @Size(min=4,max=12,message="用户名的长度在4~12之间!")
</span><span style="color: #0000ff;">private</span><span style="color: #000000;"> String username;

@NotBlank(message</span>="密码不能为空!"<span style="color: #000000;">)
</span><span style="color: #0000ff;">private</span><span style="color: #000000;"> String password;

@Email(message</span>="非法邮箱!"<span style="color: #000000;">)
</span><span style="color: #0000ff;">private</span><span style="color: #000000;"> String email;

</span><span style="color: #0000ff;">public</span><span style="color: #000000;"> Integer getId() {
    </span><span style="color: #0000ff;">return</span><span style="color: #000000;"> id;
}

</span><span style="color: #0000ff;">public</span> <span style="color: #0000ff;">void</span><span style="color: #000000;"> setId(Integer id) {
    </span><span style="color: #0000ff;">this</span>.id =<span style="color: #000000;"> id;
}

</span><span style="color: #0000ff;">public</span><span style="color: #000000;"> String getUsername() {
    </span><span style="color: #0000ff;">return</span><span style="color: #000000;"> username;
}

</span><span style="color: #0000ff;">public</span> <span style="color: #0000ff;">void</span><span style="color: #000000;"> setUsername(String username) {
    </span><span style="color: #0000ff;">this</span>.username =<span style="color: #000000;"> username;
}

</span><span style="color: #0000ff;">public</span><span style="color: #000000;"> String getPassword() {
    </span><span style="color: #0000ff;">return</span><span style="color: #000000;"> password;
}

</span><span style="color: #0000ff;">public</span> <span style="color: #0000ff;">void</span><span style="color: #000000;"> setPassword(String password) {
    </span><span style="color: #0000ff;">this</span>.password =<span style="color: #000000;"> password;
}

</span><span style="color: #0000ff;">public</span><span style="color: #000000;"> String getEmail() {
    </span><span style="color: #0000ff;">return</span><span style="color: #000000;"> email;
}

</span><span style="color: #0000ff;">public</span> <span style="color: #0000ff;">void</span><span style="color: #000000;"> setEmail(String email) {
    </span><span style="color: #0000ff;">this</span>.email =<span style="color: #000000;"> email;
}

</span><span style="color: #0000ff;">public</span><span style="color: #000000;"> User() {
    </span><span style="color: #0000ff;">super</span><span style="color: #000000;">();
}

}

 

3.控制层中使用DTO接收参数并使用@Validated/@Valid注解开启对参数的校验

　

*@Validated注解表示开启Spring的校验机制，支持分组校验,声明在入参上。

*@Valid注解表示开启Hibernate的校验机制，不支持分组校验,声明在入参上。

*在DTO后面紧跟BindingResult对象，那么当参数不符合时，能通过该对象直接获取不符合校验的message描述信息。

*若使用了@Validated/@Valid注解开启校验，但DTO后面没有紧跟BindingResult对象，那么当参数不符合时，将直接返回400 Bad Request状态码。 

@RestController
public class BaseController {
@RequestMapping(</span>"/test"<span style="color: #000000;">)
</span><span style="color: #0000ff;">public</span><span style="color: #000000;"> User test(@Validated User user, BindingResult result) {
    </span><span style="color: #0000ff;">if</span><span style="color: #000000;"> (result.hasErrors()) {
        List</span>&lt;ObjectError&gt; errors =<span style="color: #000000;"> result.getAllErrors();
        </span><span style="color: #0000ff;">for</span><span style="color: #000000;"> (ObjectError error : errors) {
            System.out.println(error.getDefaultMessage());
        }
    }
    </span><span style="color: #0000ff;">return</span><span style="color: #000000;"> user;
}

}

 

演示：

 

 结果：

密码不能为空!
id不能为空!
用户名的长度在4~12之间!

 

*校验的顺序是随机的，因此程序不能依赖校验的顺序去做相关的逻辑处理。

4.分组校验

 

每个校验注解都有group属性用于指定校验所属的组，其值是Class数组，在Controller中使用@Validated注解开启对参数的校验时若指定要进行校验的组，那么只有组相同的属性才会被进行校验(默认全匹配)

Class<?>[] groups() default { };

 

一般定义标识接口作为组资源

public interface GroupA {
}
public interface GroupB {
}

 

使用校验注解标注在属性上并进行分组

public class User {
@NotNull(message</span>="id不能为空!",groups = {GroupA.<span style="color: #0000ff;">class</span><span style="color: #000000;">})
</span><span style="color: #0000ff;">private</span><span style="color: #000000;"> Integer id;

@NotBlank(message</span>="用户名不能为空!",groups = {GroupB.<span style="color: #0000ff;">class</span><span style="color: #000000;">})
@Size(min</span>=4,max=12,message="用户名的长度在4~12之间!"<span style="color: #000000;">)
</span><span style="color: #0000ff;">private</span><span style="color: #000000;"> String username;

@NotBlank(message</span>="密码不能为空!"<span style="color: #000000;">)
</span><span style="color: #0000ff;">private</span><span style="color: #000000;"> String password;

@Email(message</span>="非法邮箱!"<span style="color: #000000;">)
</span><span style="color: #0000ff;">private</span><span style="color: #000000;"> String email;

</span><span style="color: #0000ff;">public</span><span style="color: #000000;"> Integer getId() {
    </span><span style="color: #0000ff;">return</span><span style="color: #000000;"> id;
}

</span><span style="color: #0000ff;">public</span> <span style="color: #0000ff;">void</span><span style="color: #000000;"> setId(Integer id) {
    </span><span style="color: #0000ff;">this</span>.id =<span style="color: #000000;"> id;
}

</span><span style="color: #0000ff;">public</span><span style="color: #000000;"> String getUsername() {
    </span><span style="color: #0000ff;">return</span><span style="color: #000000;"> username;
}

</span><span style="color: #0000ff;">public</span> <span style="color: #0000ff;">void</span><span style="color: #000000;"> setUsername(String username) {
    </span><span style="color: #0000ff;">this</span>.username =<span style="color: #000000;"> username;
}

</span><span style="color: #0000ff;">public</span><span style="color: #000000;"> String getPassword() {
    </span><span style="color: #0000ff;">return</span><span style="color: #000000;"> password;
}

</span><span style="color: #0000ff;">public</span> <span style="color: #0000ff;">void</span><span style="color: #000000;"> setPassword(String password) {
    </span><span style="color: #0000ff;">this</span>.password =<span style="color: #000000;"> password;
}

</span><span style="color: #0000ff;">public</span><span style="color: #000000;"> String getEmail() {
    </span><span style="color: #0000ff;">return</span><span style="color: #000000;"> email;
}

</span><span style="color: #0000ff;">public</span> <span style="color: #0000ff;">void</span><span style="color: #000000;"> setEmail(String email) {
    </span><span style="color: #0000ff;">this</span>.email =<span style="color: #000000;"> email;
}

</span><span style="color: #0000ff;">public</span><span style="color: #000000;"> User() {
    </span><span style="color: #0000ff;">super</span><span style="color: #000000;">();
}

}

 

 Controller中使用@Validated注解开启对参数的校验并指定校验的组，那么只有组相同的属性才会被进行校验(默认全匹配)

@RestController
public class BaseController {
@RequestMapping(</span>"/test"<span style="color: #000000;">)
</span><span style="color: #0000ff;">public</span> User test(@Validated(value= {GroupB.<span style="color: #0000ff;">class</span><span style="color: #000000;">}) User user, BindingResult result) {
    </span><span style="color: #0000ff;">if</span><span style="color: #000000;"> (result.hasErrors()) {
        List</span>&lt;ObjectError&gt; errors =<span style="color: #000000;"> result.getAllErrors();
        </span><span style="color: #0000ff;">for</span><span style="color: #000000;"> (ObjectError error : errors) {
            System.out.println(error.getDefaultMessage());
        }
    }
    </span><span style="color: #0000ff;">return</span><span style="color: #000000;"> user;
}

}

 

演示：

 

结果：

用户名不能为空!

 

*后端一般只返回重名等错误描述信息，对于非空、字符长度、手机邮箱合法性校验等由前端进行判断并提示，后端校验不通过时不返回错误描述信息，所以不需要使用BindingResult获取错误描述，当参数不符合时直接返回400 Bad Request请求。

原文地址：https://www.cnblogs.com/funyoung/p/8670550.html