Spring Boot 中使用 JSR-303 数据校验

系统管理员 2024-03-16 21:38 94阅读 0赞

## Spring Boot 中使用 JSR-303 数据校验 ##

在 Web 开发中，数据校验是一个非常重要的环节。它可以帮助我们在用户提交表单数据时验证数据的合法性，防止一些不必要的错误和漏洞。在 Spring Boot 中，我们可以使用 JSR-303 数据校验规范来实现数据校验。本文将介绍如何在 Spring Boot 中使用 JSR-303 数据校验，并提供示例代码来演示它的用法。

![在这里插入图片描述][ba7feb116d5f4948b2455b20b3e1b743.png]

### 什么是 JSR-303 数据校验？ ###

JSR-303 是 Java 中的一个数据校验规范。它定义了一组注解，可以用于对 Java 对象中的属性进行校验。在 Spring Boot 中，我们可以使用 JSR-303 数据校验规范来校验表单数据的合法性。

### 使用 JSR-303 数据校验 ###

在 Spring Boot 中，我们可以使用 `@Valid` 注解来指示需要校验的对象，并使用 JSR-303 中的注解来指示需要进行校验的属性。例如，如果我们有一个名为 `User` 的对象，并且我们想校验该对象的 `username` 和 `password` 属性，我们可以使用以下代码：

public class User {
        
    
        @NotBlank(message = "用户名不能为空")
        private String username;
    
        @NotBlank(message = "密码不能为空")
        private String password;
    
        // 省略 getter 和 setter 方法
    }

在上面的示例代码中，我们使用了 JSR-303 中的 `@NotBlank` 注解来指示 `username` 和 `password` 属性不能为空。如果这些属性为空，校验将失败，并返回一个包含错误信息的对象。

在控制器中，我们可以使用 `@Valid` 注解来指示需要校验的对象。例如：

@RestController
    @RequestMapping("/users")
    public class UserController {
        
    
        @PostMapping
        public ResponseEntity<?> createUser(@Valid @RequestBody User user) {
        
            // 创建用户
            return ResponseEntity.ok().build();
        }
    }

在上面的示例代码中，我们使用了 `@Valid` 注解来指示需要校验 `RequestBody` 中的 `User` 对象。如果校验失败，Spring Boot 将自动返回一个包含错误信息的响应。

### 校验器 ###

除了使用 JSR-303 的注解进行校验外，我们还可以自定义校验器来实现更复杂的校验逻辑。在 Spring Boot 中，我们可以实现 `org.springframework.validation.Validator` 接口，并将其配置为 Spring Bean，以便在控制器中使用。

以下是一个示例校验器，用于校验 `User` 对象中的 `username` 和 `password` 属性：

@Component
    public class UserValidator implements Validator {
        
    
        @Override
        public boolean supports(Class<?> clazz) {
        
            return User.class.equals(clazz);
        }
    
        @Override
        public void validate(Object target, Errors errors) {
        
            User user = (User) target;
            if (StringUtils.isEmpty(user.getUsername())) {
        
                errors.rejectValue("username", "username.empty");
            }
            if (StringUtils.isEmpty(user.getPassword())) {
        
                errors.rejectValue("password", "password.empty");
            }
        }
    }

在上面的示例代码中，我们实现了 `org.springframework.validation.Validator` 接口，并重写了 `supports` 和 `validate` 方法。`supports` 方法用于判断该校验器是否支持校验给定的对象。在本例中，我们判断该校验器是否支持 `User` 类型的对象。`validate` 方法用于实际校验对象。在本例中，我们校验了 `User` 对象中的 `username` 和 `password` 属性是否为空，并使用 `Errors` 对象保存错误信息。

在控制器中，我们可以使用 `Errors` 对象来获取校验结果，并决定如何处理错误。例如：

@RestController
    @RequestMapping("/users")
    public class UserController {
        
    
        @Autowired
        private UserValidator userValidator;
    
        @PostMapping
        public ResponseEntity<?> createUser(@RequestBody User user, Errors errors) {
        
            userValidator.validate(user, errors);
            if (errors.hasErrors()) {
        
                // 处理校验错误
                return ResponseEntity.badRequest().body(errors.getAllErrors());
            }
            // 创建用户
            return ResponseEntity.ok().build();
        }
    }

在上面的示例代码中，我们将 `Errors` 对象作为参数传递给控制器方法，并在方法中调用 `userValidator.validate(user, errors)` 方法进行校验。如果校验失败，我们可以使用 `errors.getAllErrors()` 方法获取所有错误信息，并返回一个包含错误信息的响应。如果校验成功，我们将创建用户并返回一个成功响应。

### 总结 ###

在本文中，我们介绍了在 Spring Boot 中使用 JSR-303 数据校验的方法，并提供了示例代码来演示它的用法。使用数据校验可以帮助我们提高 Web 应用程序的安全性和可靠性，减少不必要的错误和漏洞。如果您在开发 Web 应用程序时需要进行数据校验，请务必考虑使用 JSR-303 数据校验规范。

[ba7feb116d5f4948b2455b20b3e1b743.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/09c96c898e6a46229f27173a3b237570.png