欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

SpringBoot服务端表单数据校验

程序员文章站 2022-05-03 10:23:59
...

一、实现添加用户功能

1、创建项目spring-boot-validate,修改 POM 文件
<?xml version="1.0" encoding="UTF-8"?>
<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 http://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>spring-boot-validate</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <java.version>1.8</java.version>
        <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>
2、编写添加用户功能创建实体类
package com.bjsxt.pojo;

public class Users {
    private String name;
    private String password;
    private Integer 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 Integer getAge() {
        return age;
    }

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

    @Override
    public String toString() {
        return "Users{" +
                "name='" + name + '\'' +
                ", password='" + password + '\'' +
                ", age=" + age +
                '}';
    }
}
3、编写 Controller
package com.bjsxt.controller;

import com.bjsxt.pojo.Users;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * SpringBoot 表单数据校验
 */
@Controller
public class UsersController {

    @RequestMapping("/addUser")
    public String showPage() {
        return "add";
    }

    /**
     * 完成用户添加
     */
    @RequestMapping("/save")
    public String saveUser(Users users) {
        System.out.println(users);
        return "ok";
    }
}
4、在src/main/resources/tmplates目录下编写页面 add.html ok.html
  • 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>
5、测试运行

SpringBoot服务端表单数据校验

二、SpringBoot 对表单做数据校验

SpringBoot 对表单数据校验的技术特点:SpringBoot 中使用了 Hibernate-validate 校验框架

SpringBoot 表单数据校验步骤
1、在实体类中添加校验规则
package com.bjsxt.pojo;

import org.hibernate.validator.constraints.NotBlank;

public class Users {
    @NotBlank // 非空校验
    private String name;
    @NotBlank // 密码非空校验
    private String password;
    private Integer 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 Integer getAge() {
        return age;
    }

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

    @Override
    public String toString() {
        return "Users{" +
                "name='" + name + '\'' +
                ", password='" + password + '\'' +
                ", age=" + age +
                '}';
    }
}
2、在 Controller 中开启校验
package com.bjsxt.controller;

import com.bjsxt.pojo.Users;
import org.springframework.stereotype.Controller;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.RequestMapping;


import javax.validation.Valid;

/**
 * SpringBoot 表单数据校验
 */
@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";
    }
}
3、在页面中获取提示信息
  • 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"/><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>
4、遇到异常

SpringBoot服务端表单数据校验

解决数据校验时的异常问题

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

1、修改controller层showPage()方法
package com.bjsxt.controller;

import com.bjsxt.pojo.Users;
import org.springframework.stereotype.Controller;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.RequestMapping;


import javax.validation.Valid;

/**
 * SpringBoot 表单数据校验
 */
@Controller
public class UsersController {

    /**
     * 解决异常的方式。 可以在跳转页面的方法中注入一个 Uesrs 对象。
     * 注意: 由于 springmvc 会将该对象放入到 Model 中传递。 key 的名称会使用该对象的驼峰式的命名规则来作为 key。
     * 参数的变量名需要与对象的名称相同。 将首字母小写。
     * @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";
    }
}
2、修改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"/><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>
如果参数的名称需要做改变
package com.bjsxt.controller;

import com.bjsxt.pojo.Users;
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 javax.validation.Valid;

/**
 * SpringBoot 表单数据校验
 */
@Controller
public class UsersController {

    /**
     * 如果想为传递的对象更改名称, 可以使用@ModelAttribute("aa")这表示当前传递的对象的 key 为 aa。
     * 那么我们在页面中获取该对象的 key 也需要修改为 aa
     *
     * @param users
     * @return
     */
    @RequestMapping("/addUser")
    public String showPage1(@ModelAttribute("aa") 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";
    }
}
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"/><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>

四、其他校验规则

  • @NotBlank : 判断字符串是否为 null 或者是空串(去掉首尾空格)。
  • @NotEmpty : 判断字符串是否 null 或者是空串。
  • @Length :判断字符的长度(最大或者最小)
  • @Min :判断数值最小值
  • @Max : 判断数值最大值
  • @Email : 判断邮箱是否合法
测试代码
  • Users实体类
package com.bjsxt.pojo;

import javax.validation.constraints.Min;

import org.hibernate.validator.constraints.Email;
import org.hibernate.validator.constraints.Length;
import org.hibernate.validator.constraints.NotBlank;
import org.hibernate.validator.constraints.NotEmpty;

public class Users {
	@NotBlank(message="用户名不能为空") //非空校验
	@Length(min=2,max=6,message="最小长度为2位,最大长度为6位")
	private String name;
	@NotEmpty
	private String password;
	@Min(value=15)
	private Integer age;
	@Email
	private String email;
	
	public String getEmail() {
		return email;
	}
	public void setEmail(String email) {
		this.email = email;
	}
	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 Integer getAge() {
		return age;
	}
	public void setAge(Integer age) {
		this.age = age;
	}
	@Override
	public String toString() {
		return "Users [name=" + name + ", password=" + password + ", age=" + age + "]";
	}
}
  • controller
package com.bjsxt.contorller;


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 表单数据校验
 *
 *
 */
@Controller
public class UsersController {
	/**
	 * 
	 * 如果想为传递的对象更改名称,可以使用@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";
	}
}
测试运行

SpringBoot服务端表单数据校验

相关标签: Springboot