博客

Spring中使用JSR303请求约束判空的实现

  • Post category:http

那我来详细讲解一下。

什么是JSR 303

JSR 303 是一个 Java 标准，它定义了一些用于数据校验的注解。这些注解可以用于 JavaBean 中的字段上，用于验证在处理这些字段时是否符合某些要求。比如是否为空、长度是否符合要求、格式是否正确等等。JSR 303 是 Bean Validation 的一部分，可以与 Hibernate Validator 一起使用。同时，Spring 框架也提供了对 JSR 303 的支持。

Spring 中使用JSR 303

Spring 中使用 JSR 303 可以防止提交的表单数据为空或格式不正确，提高了应用程序的健壮性和用户体验。以下是 Spring 中使用 JSR 303 进行请求约束判空的实现攻略：

1. 引入 JSR 303 相关的依赖

在 pom.xml 中添加以下依赖：

<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>2.0.1.Final</version>
</dependency>
<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.1.5.Final</version>
</dependency>

2. 添加 Controller

在 Controller 中添加方法，这个方法接受的参数就是需要校验的对象，例如下面的示例代码中校验的是一个用户对象：

@Controller
@RequestMapping("/user")
public class UserController {
    @PostMapping("/save")
    public String saveUser(@Valid @ModelAttribute User user, BindingResult bindingResult) {
        if (bindingResult.hasErrors()) {
            // 处理校验失败的情况
        }
        // 处理保存用户信息的逻辑
        return "success";
    }
}

3. 添加 Bean

在 JavaBean 中添加要校验的注解。例如下面的用户对象，使用了 @NotBlank、@Size 和 @Email 注解：

public class User {
    @NotBlank
    @Size(min = 2, max = 20)
    private String username;

    @NotBlank
    @Size(min = 6, max = 20)
    private String password;

    @NotBlank
    @Email
    private String email;

    // 省略 get/set 方法
}

4. 配置文件

在 application.properties 或 application.yml 中添加下面的配置：

# 开启 JSR 303 支持
spring.mvc.validation=true

5. 添加校验错误信息

在 messages.properties 或 messages_zh_CN.properties 文件中添加错误信息：

NotBlank.user.username=用户名不能为空
Size.user.username=用户名长度应该在 {min} 到 {max} 之间
NotBlank.user.password=密码不能为空
Size.user.password=密码长度应该在 {min} 到 {max} 之间
NotBlank.user.email=邮箱不能为空
Email.user.email=邮箱格式不正确，请输入正确的邮箱地址

示例1

对于一个 POST 请求，在请求体中包含一个 username 属性的数据，这个数据为空。使用上文所述的代码和配置，在 BindingResult 中可以得到一个错误信息：”username不能为空”。

示例2

对于一个 POST 请求，在请求体中包含一个 email 属性的数据，这个数据的格式不正确。使用上文所述的代码和配置，在 BindingResult 中可以得到一个错误信息：”邮箱格式不正确，请输入正确的邮箱地址”。

以上就是 Spring 中使用 JSR 303 进行请求约束判空的实现攻略了。需要注意的是，JSR 303 只能进行请求数据约束的判空，不能检查数据库中存在的条目和条目中数据类型和长度等的合法性。如果需要进行数据库数据的增删改查操作时，还需要使用其他技术手段进行数据合法性的验证。

Tags: