Spring Boot 服务端表单数据校验
实现添加用户功能
创建项目
修改pom文件
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.10.RELEASE</version>
</parent>
<groupId>com.bjsxt</groupId>
<artifactId>13-spring-boot-validate</artifactId>
<version>0.0.1-SNAPSHOT</version>
<properties>
<thymeleaf.version>3.0.2.RELEASE</thymeleaf.version>
<thymeleaf-layout-dialect.version>2.0.4</thymeleaf-layout-dialect.version>
</properties>
<dependencies>
<!-- springboot的启动器 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- thymeleaf的启动器 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
</dependencies>
</project>
编写添加用户功能
创建实体
Users
package com.bjsxt.pojo;
public class Users {
private String name;
private String password;
private String age;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public String getAge() {
return age;
}
public void setAge(String age) {
this.age = age;
}
@Override
public String toString() {
return "Users [name=" + name + ", password=" + password + ", age=" + age + "]";
}
}
创建Controller
package com.bjsxt.controller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import com.bjsxt.pojo.Users;
/**
* SpringBoot 表单数据校验
* @author john
*
*/
@Controller
public class UsersController {
@RequestMapping("/addUser")
public String showPage() {
return "add";
}
/**
* 完成用户添加
*/
@RequestMapping("/save")
public String saveUser(Users users) {
System.out.println(users);
return "OK";
}
}
编写页面
add.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>添加用户</title>
</head>
<body>
<form th:action="@{/save}" method="post">
用户姓名:<input type="text" name="name"><br/>
用户密码:<input type="password" name="password"><br/>
用户年龄:<input type="text" name="age"><br/>
<input type="submit" value="OK">
</form>
</body>
</html>
OK.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>操作成功</title>
</head>
<body>
OK!
</body>
</html>
启动类
package com.bjsxt;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class App {
public static void main(String[] args) {
SpringApplication.run(App.class, args);
}
}
SpringBoot对表单做数据校验
SpringBoot对表单数据校验的技术特点
SpringBoot中使用了Hibernate-validate校验框架
SpringBoot表单数据校验步骤
第一步:在实体类中添加校验规则
package com.bjsxt.pojo;
import org.hibernate.validator.constraints.NotBlank;
public class Users {
@NotBlank //不可为空
private String name;
@NotBlank
private String password;
private String age;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public String getAge() {
return age;
}
public void setAge(String age) {
this.age = age;
}
@Override
public String toString() {
return "Users [name=" + name + ", password=" + password + ", age=" + age + "]";
}
}
第二步:在Controller中需要校验的方法上添加校验注解
package com.bjsxt.controller;
import javax.validation.Valid;
import org.springframework.stereotype.Controller;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.RequestMapping;
import com.bjsxt.pojo.Users;
/**
* SpringBoot 表单数据校验
* @author john
*
*/
@Controller
public class UsersController {
@RequestMapping("/addUser")
public String showPage() {
return "add";
}
/**
* 完成用户添加
* @Valid 开启对Users对象的数据校验
* BindingResult : 封装了校验的结果
*/
@RequestMapping("/save")
public String saveUser(@Valid Users users,BindingResult result) {
if(result.hasErrors()) {
return "add";
}
System.out.println(users);
return "OK";
}
}
第三步:在页面中获取提示信息
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>添加用户</title>
</head>
<body>
<form th:action="@{/save}" method="post">
用户姓名:<input type="text" name="name"/><font color="red" th:errors="${users.name}"></font><br/>
用户密码:<input type="password" name="password"/><font color="red" th:errors="${users.password}"></font><br/>
用户年龄:<input type="text" name="age"/><font color="red" th:errors="${users.age}"></font><br/>
<input type="submit" value="OK">
</form>
</body>
</html>
运行之后,遇到一个异常
java.lang.IllegalStateException: Neither BindingResult nor plain target object for bean name 'users' available as request attribute
在访问控制器addUser并没有users
解决数据校验时的异常问题
解决问题第一种方式
解决异常的方式。可以在跳转页面的方法中注入一个Users对象注意: 由于springmvc会将该对象放入到Model中传递。key的名称会使用该对象的驼峰式的命名规则来作为key.
参数的变量名需要与对象的名称相同。将首字母小写。
package com.bjsxt.controller;
import javax.validation.Valid;
import org.springframework.stereotype.Controller;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.RequestMapping;
import com.bjsxt.pojo.Users;
/**
* SpringBoot 表单数据校验
* @author john
*
*/
@Controller
public class UsersController {
/**
* 解决异常的方式。可以在跳转页面的方法中注入一个Users对象
* 注意: 由于springmvc会将该对象放入到Model中传递。key的名称会使用该对象的驼峰式的命名规则来作为key.
* 参数的变量名需要与对象的名称相同。将首字母小写。
* @param users
* @return
*/
@RequestMapping("/addUser")
public String showPage(Users users) {
return "add";
}
/**
* 完成用户添加
* @Valid 开启对Users对象的数据校验
* BindingResult : 封装了校验的结果
*/
@RequestMapping("/save")
public String saveUser(@Valid Users users,BindingResult result) {
if(result.hasErrors()) {
return "add";
}
System.out.println(users);
return "OK";
}
}
解决问题第二种方式
如果想为传递的对象更改名称,可以使用@ModelAttribute(“aa”)这表示当前传递的对象的key为aa.
那么我们在页面中获取该对象的key也需要修改为aa
package com.bjsxt.controller;
import javax.validation.Valid;
import org.springframework.stereotype.Controller;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import com.bjsxt.pojo.Users;
/**
* SpringBoot 表单数据校验
* @author john
*
*/
@Controller
public class UsersController {
/**
* 解决异常的方式一。可以在跳转页面的方法中注入一个Users对象
* 注意: 由于springmvc会将该对象放入到Model中传递。key的名称会使用该对象的驼峰式的命名规则来作为key.
* 参数的变量名需要与对象的名称相同。将首字母小写。
*
* 如果想为传递的对象更改名称,可以使用@ModelAttribute("aa")这表示当前传递的对象的key为aa
* 那么我们在页面中获取该对象的key也需要修改为aa
* @param users
* @return
*/
@RequestMapping("/addUser")
public String showPage(@ModelAttribute("aa") Users users) {
return "add";
}
/**
* 完成用户添加
* @Valid 开启对Users对象的数据校验
* BindingResult : 封装了校验的结果
*/
@RequestMapping("/save")
public String saveUser(@ModelAttribute("aa") @Valid Users users,BindingResult result) {
if(result.hasErrors()) {
return "add";
}
System.out.println(users);
return "OK";
}
}
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>添加用户</title>
</head>
<body>
<form th:action="@{/save}" method="post">
用户姓名:<input type="text" name="name"/><font color="red" th:errors="${aa.name}"></font><br/>
用户密码:<input type="password" name="password"/><font color="red" th:errors="${aa.password}"></font><br/>
用户年龄:<input type="text" name="age"/><font color="red" th:errors="${aa.age}"></font><br/>
<input type="submit" value="OK">
</form>
</body>
</html>
运行测试
其他校验规则
- @NotBlank : 判断字符串是否为null 或者是空串(去掉首尾空格)
- @NotEmpty : 判断字符串是否null 或者是空车(不去掉首尾空格)
- @Lenth : 判断字符的长度(不超过最大、不低于最小)
- @Min : 判断数值最小值
- @Max : 判断数值最大值
- @Email : 判断邮箱是否合法