Spring Boot 服务端数据校验

一、对实体对象的校验

Spring Boot 中使用了 Hibernate-validator 校验框架。

常用校验注解

注解名称 适用范围 作用
@NotNull 对象类型 对象不为Null
@NotBlank 字符串类型 字符串不为空
@NotEmpty 集合类型 集合不为空
@Length 字符串 判断字符串的长度(最大或最小)
@Min 数值 判断数值最小值
@Max 数值 判断数值最大值
@Email 字符串 判断邮箱是否合法

1.1 修改实体类添加校验规则

实体类添加@NotNull、@NotBlank、@NotEmpty等注解

@Data
public class Users {
    @NotNull
    private Integer userid;
    @NotBlank
    private String username;
    @NotEmpty
    private String usersex;
}

1.2 在Controller中开启校验

1、校验对象前添加@Validated注解,并添加BindingResult参数。
2、每一个校验对象后面必须配对一个BindingResult参数
3、多个校验对象配对多个参数

@RequestMapping("/addUser")
public String addUser(@Validated Users users, BindingResult result) {
    if (result.hasErrors()) {
        return "addUser";
    }
    return "ok";
}

1.3 在页面中获取提示信息

1、页面中使用th:errors标签引用校验消息
2、页面中使用控制器校验对象名.属性名引用错误值

<span th:errors="${users.username}"></span>
<span th:errors="${users.usersex}"></span>

二、自定义错误提示信息

2.1 在注解中定义提示信息

通过message属性定义提示信息。此方法存在硬编码,替换不便。

@NotNull(message = "用户ID不能为空")
private Integer userid;

2.2 在配置文件中定义提示信息

新建ValidationMessages.properties文件,添加键值对:

# 前端显式时会出现中文乱码
usersex.notnull = 用户性别不能为空

针对乱码问题,需要使用jdk的bin目录下的native2ascii工具进行转码。(在线转换工具)

usersex.notnull = \u7528\u6237\u6027\u522b\u4e0d\u80fd\u4e3a\u7a7a

2.3 解决页面跳转异常

在跳转页面的方法中注入一个对象,要求参数对象的变量名必须是对象类型名称首字母的小写格式。

问题描述:
1.2 中通过addUser接口跳转至addUser.html页面不会报错,因为该跳转包含了users对象(@Validated Users users)。如果用户直接访问addUser.html页面则会报如下错误,因为没有传递User对象过来。

添加直接访问控制类

@Controller
public class PageController {

    @RequestMapping("/{page}")
    public String showPage(@PathVariable String page) {
        return page;
    }
}

直接访问

http://localhost:8080/addUser

页面错误信息

This application has no explicit mapping for /error, so you
are seeing this as a fallback.

Mon Apr 27 17:41:43 CST 2020

There was an unexpected error (type=Internal Server Error, status=500).

during execution of processor 'org.thymeleaf.spring5.processor.SpringErrorsTagProcessor'
(template: "addUser" - line 9, col 50)

解决方法:
跳转接口添加User对象

@Controller
public class PageController {

    @RequestMapping("/{page}")
    public String showPage(@PathVariable String page, Users users) {
        return page;
    }
}

2.4 修改参数key的名称

页面中引用的对象名为控制类入参的小驼峰命名,与入参的形参名称无关。如果需要修改默认命名规则,可通过@ModelAttribute属性修改。

@RequestMapping("/{page}")
public String showPage(@PathVariable String page, Users suibian) {
    return page;
}

// 无法访问
<span th:errors="${suibian.username}"></span>

// 依然可以访问
<span th:errors="${users.username}"></span>

修改默认规则

// 直接跳转处修改key
@RequestMapping("/{page}")
public String showPage(@PathVariable String page, @ModelAttribute("u") Users users) {
    return page;
}

// 接口调用处修改key
@RequestMapping("/addUser")
public String addUser(@ModelAttribute("u") @Validated Users users, BindingResult result) {
    if (result.hasErrors()) {
        return "addUser";
    }
    return "ok";
}

// 调用
<span th:errors="${u.username}"></span>
<span th:errors="${u.username}"></span>

三、对其它参数的校验

场景:查找用户时只需传递username字符串而不是Users对象,此时对username字符串也需要进行参数校验。

3.1 开启校验并添加校验规则

对参数指定校验规则

// 参数添加校验规则
@PostMapping("/findUser")
public String findUser(@NotBlank String username) {
    System.out.println(username);
    return "ok";
}

Controller中开启校验

// 所属控制类添加@validated注解
@Validated
@Controller
@RequestMapping("/user")
public class UsersController {
}

错误页面

findUser.username: 不能为空

3.2 异常处理和异常获取

全局异常处理

@Configuration
public class GlobalException implements HandlerExceptionResolver {
    @Override
    public ModelAndView resolveException(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) {
        ModelAndView mv = new ModelAndView();

        if(e instanceof ConstraintViolationException) {
            mv.setViewName("findUser");
            mv.addObject("error", e.toString().split(":")[2]);
        }
        return mv;
    }
}

页面获取异常

<span th:text="${error}"></span>

评论

暂无评论