金刀的博客 | SpringBoot validate 服务端数据校验入门

SpringBoot validate服务端数据校验

SpringBoot使用了hibernate-validate数据校验框架

SpringBoot表单数据校验步骤

1.在实体类中(entity/pojo)添加校验规则

public class User {
	@Length(min = 5,max = 15)	// 长度最少不能小于5位，最大不能大于15位
	@NotBlank(message = "用户名不能为空")	// 表示用户名不能为空
	private String username;	// 用户名
	
	@Length(min = 8,max = 20)	// 密码长度不能小于8位并且不能大于20位
	@NotBlank(message = "密码不能为空")	// 密码不能为空
	private String password; 	// 密码
	private String address;		// 地址
	
	@Length(min = 11,max = 11,message = "手机号格式错误")
	private String phone;		// 手机号
	
	@Min(value = 12)	// 年龄最小值为12岁
	@Max(value = 100)	// 年龄最大值为100岁
	private Integer age;
	
	@Email	// 验证邮箱是否合法
	private String email;	// 邮箱
	
	public User() {
		super();
	}
	
	public User(String username, String password, String address, String phone, Integer age, String email) {
		super();
		this.username = username;
		this.password = password;
		this.address = address;
		this.phone = phone;
		this.age = age;
		this.email = email;
	}

	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 getAddress() {
		return address;
	}
	public void setAddress(String address) {
		this.address = address;
	}
	public String getPhone() {
		return phone;
	}
	public void setPhone(String phone) {
		this.phone = phone;
	}
	
	public Integer getAge() {
		return age;
	}

	public void setAge(Integer age) {
		this.age = age;
	}

	public String getEmail() {
		return email;
	}
	public void setEmail(String email) {
		this.email = email;
	}

	@Override
	public String toString() {
		return "User [username=" + username + ", password=" + password + ", address=" + address + ", phone=" + phone
				+ ", age=" + age + ", email=" + email + "]";
	}
}

2.在Controller中开启校验

/**
 * 新增方法
 * @valid	// 开启对User对象的数据校验
 * BindingResult	// 封装了校验的结果
 * @param user
 * @return
 */
@RequestMapping(value = "/save")
public String userSave(@Valid User user, BindingResult result) {
	/**
	 * result.hasErrors该方法返回一个布尔值，
	 * 当布尔值为true时，表示校验失败
	 * 当布尔值为false时，表示校验成功
	 */
	if(result.hasErrors()) {
		// 数据校验失败，返回到请求时的页面
		return "index";
	}
	System.err.println(user);
	return "success";
}

3.在页面中获取错误信息(使用的是Thymeleaf模板引擎)

<form action="/save" method="post">
	<table align="center">
		<tr>
			<th colspan="2" align="center">Spring Boot validateth>
		tr>
		<tr>
			<td>用户名td>
			<td><input type="text" name="username">td>
			<td><font color="red" th:errors="${user.username}">font>td>
		tr>
		<tr>
			<td>密码td>
			<td><input type="password" name="password">td>
			<td><font color="red" th:errors="${user.password}">font>td>
		tr>
		<tr>
			<td>地址td>
			<td><input type="text" name="address">td>
			<td><font color="red" th:errors="${user.address}">font>td>
		tr>
		<tr>
			<td>手机号td>
			<td><input type="text" name="phone">td>
			<td><font color="red" th:errors="${user.phone}">font>td>
		tr>
		<tr>
			<td>年龄td>
			<td><input type="text" name="age">td>
			<td><font color="red" th:errors="${user.age}">font>td>
		tr>
		<tr>
			<td>邮箱td>
			<td><input type="text" name="email">td>
			<td><font color="red" th:errors="${user.email}">font>td>
		tr>
		<tr>
			<td colspan="2" align="center"><input type="submit" value="提交">td>
		tr>
	table>
form>

• **“Neither BindingResult nor plain target object for bean name ‘user’ available as request attribute”**异常的解决方案

在跳转页面的方法中注入一个对象，来解决问题，要求参数对象的变量名必须是对象的类名的全称首字母小写

• Java后端代码片段

/**
 * 解决“java.lang.IllegalStateException: Neither BindingResult nor plain target object for bean name 'user' available as request attribute”异常：
 * 	可以在跳转页面的方法中注入一个实体对象
 * 注意：
 * 	由于SpringMVC会将该对象放入到Model中传值。key的名称会使用该对象的驼峰式的命名规则来作为key。
 * 	参数的变量名需要与对象的名称相同，将首字母小写。
 *
 * @param page	请求的页面名称
 * @return
 */
@RequestMapping(value = "/{page}")
public String returnPage(@PathVariable String page,User user) {
	return page;
}

/**
 * 新增方法
 * @valid	// 开启对User对象的数据校验
 * BindingResult	// 封装了校验的结果
 * @param user
 * @return
 */
@RequestMapping(value = "/save")
public String userSave(@Valid User user, BindingResult result) {
	/**
	 * result.hasErrors该方法返回一个布尔值，
	 * 当布尔值为true时，表示校验失败
	 * 当布尔值为false时，表示校验成功
	 */
	if(result.hasErrors()) {
		// 数据校验失败，返回到请求时的页面
		return "index";
	}
	System.err.println(user);
	return "success";
}

• html代码片段

<form action="/save" method="post">
	<table align="center">
		<tr>
			<th colspan="2" align="center">Spring Boot validateth>
		tr>
		<tr>
			<td>用户名td>
			<td><input type="text" name="username">td>
			<td><font color="red" th:errors="${user.username}">font>td>
		tr>
		<tr>
			<td>密码td>
			<td><input type="password" name="password">td>
			<td><font color="red" th:errors="${user.password}">font>td>
		tr>
		<tr>
			<td>地址td>
			<td><input type="text" name="address">td>
		tr>
		<tr>
			<td>手机号td>
			<td><input type="text" name="phone">td>
		tr>
		<tr>
			<td colspan="2" align="center"><input type="submit" value="提交">td>
		tr>
	table>
form>

• 如果参数的名称需要做改变，则可以采用@ModelAttribute(value = “值”)注解形式实现

• Java后端代码片段

/**
 * 
 * 如果想为传递的对象更改名称，可以使用@ModelAttribute(value = "users")这表示当前传递的对象的key为"users",
 * 那么在页面中获取该对象的key也需要修改为“users”
 * @param page	请求的页面名称
 * @return
 */
@RequestMapping(value = "/{page}")
public String returnPage(@PathVariable String page,@ModelAttribute(value = "users") User user) {
	return page;
}

/**
 * 新增方法
 * @valid	// 开启对User对象的数据校验
 * BindingResult	// 封装了校验的结果
 * @param user
 * @return
 */
@RequestMapping(value = "/save")
public String userSave(@ModelAttribute(value = "users")@Valid User user, BindingResult result) {
	/**
	 * result.hasErrors该方法返回一个布尔值，
	 * 当布尔值为true时，表示校验失败
	 * 当布尔值为false时，表示校验成功
	 */
	if(result.hasErrors()) {
		// 数据校验失败，返回到请求时的页面
		return "index";
	}
	System.err.println(user);
	return "success";
}

• HTML代码片段

form action="/save" method="post">
	<table align="center">
		<tr>
			<th colspan="2" align="center">Spring Boot validateth>
		tr>
		<tr>
			<td>用户名td>
			<td><input type="text" name="username">td>
			<td><font color="red" th:errors="${users.username}">font>td>
		tr>
		<tr>
			<td>密码td>
			<td><input type="password" name="password">td>
			<td><font color="red" th:errors="${users.password}">font>td>
		tr>
		<tr>
			<td>地址td>
			<td><input type="text" name="address">td>
		tr>
		<tr>
			<td>手机号td>
			<td><input type="text" name="phone">td>
		tr>
		<tr>
			<td colspan="2" align="center"><input type="submit" value="提交">td>
		tr>
	table>
form>

其他校验规则

• @NotBlank：判断字符串是否为null或者空字符串,去掉首位空格；
• @NotEmpty：判断字符串是否为null或者空字符串；
• @Length:判断字符的长度，例如：@Length(min = 5,max = 15) // 长度最少不能小于5位，最大不能大于15位
• @Min：判断数值最小值,例如：@Min(value = 12) // 年龄最小值为12岁
• @Max：判断数值最大值，例如：@Max(value = 100) // 年龄最大值为100岁
• @Email:判断邮箱是否合法，例如：@Email // 验证邮箱是否合法