Spring Boot项目传参校验的方法

在Spring Boot项目中，参数校验是一个非常重要的环节。它确保了传入的数据符合预期的格式和规则，从而避免了潜在的错误和安全问题。本文将详细介绍在Spring Boot项目中如何进行参数校验，包括使用注解、自定义校验器、全局异常处理等方法。

1. 使用注解进行参数校验

Spring Boot提供了基于JSR-303/JSR-380规范的参数校验支持，主要通过javax.validation包中的注解来实现。以下是一些常用的校验注解：

• @NotNull：验证对象是否为null
• @NotEmpty：验证字符串、集合、数组等是否为空
• @NotBlank：验证字符串是否为空或仅包含空白字符
• @Size：验证字符串、集合、数组等的长度是否在指定范围内
• @Min、@Max：验证数字是否在指定范围内
• @Pattern：验证字符串是否匹配指定的正则表达式
• @Email：验证字符串是否为有效的电子邮件地址

1.1 在实体类中使用注解

首先，我们可以在实体类中使用这些注解来定义校验规则。例如：

public class User {
    @NotNull(message = "用户名不能为空")
    private String username;

    @NotBlank(message = "密码不能为空")
    @Size(min = 6, max = 20, message = "密码长度必须在6到20个字符之间")
    private String password;

    @Email(message = "邮箱格式不正确")
    private String email;

    // getters and setters
}

1.2 在Controller中使用注解

在Controller中，我们可以使用@Valid注解来触发参数校验。例如：

@RestController
@RequestMapping("/users")
public class UserController {

    @PostMapping
    public ResponseEntity<String> createUser(@Valid @RequestBody User user) {
        // 处理用户创建逻辑
        return ResponseEntity.ok("用户创建成功");
    }
}

当请求参数不符合校验规则时，Spring Boot会自动抛出MethodArgumentNotValidException异常。

2. 自定义校验器

虽然Spring Boot提供了丰富的校验注解，但在某些情况下，我们可能需要自定义校验规则。这时，我们可以通过实现ConstraintValidator接口来创建自定义校验器。

2.1 创建自定义注解

首先，我们需要创建一个自定义注解。例如，我们创建一个@PhoneNumber注解来验证手机号码：

@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = PhoneNumberValidator.class)
public @interface PhoneNumber {
    String message() default "手机号码格式不正确";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

2.2 实现校验逻辑

接下来，我们实现PhoneNumberValidator类来定义校验逻辑：

public class PhoneNumberValidator implements ConstraintValidator<PhoneNumber, String> {

    private static final Pattern PHONE_PATTERN = Pattern.compile("^1[3-9]\\d{9}$");

    @Override
    public boolean isValid(String phoneNumber, ConstraintValidatorContext context) {
        if (phoneNumber == null) {
            return true; // 允许为空
        }
        return PHONE_PATTERN.matcher(phoneNumber).matches();
    }
}

2.3 使用自定义注解

最后，我们可以在实体类中使用自定义的@PhoneNumber注解：

public class User {
    @PhoneNumber
    private String phoneNumber;

    // getters and setters
}

3. 全局异常处理

当参数校验失败时，Spring Boot会抛出MethodArgumentNotValidException异常。为了返回友好的错误信息，我们可以通过全局异常处理来捕获并处理这些异常。

3.1 创建全局异常处理器

我们可以使用@ControllerAdvice和@ExceptionHandler注解来创建一个全局异常处理器：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<Map<String, String>> handleValidationExceptions(MethodArgumentNotValidException ex) {
        Map<String, String> errors = new HashMap<>();
        ex.getBindingResult().getFieldErrors().forEach(error -> 
            errors.put(error.getField(), error.getDefaultMessage()));
        return ResponseEntity.badRequest().body(errors);
    }
}

3.2 返回自定义错误信息

通过全局异常处理器，我们可以将校验失败的错误信息以JSON格式返回给客户端：

{
    "username": "用户名不能为空",
    "password": "密码长度必须在6到20个字符之间",
    "email": "邮箱格式不正确"
}

4. 分组校验

在某些情况下，我们可能需要对同一个实体类在不同的场景下应用不同的校验规则。这时，我们可以使用分组校验。

4.1 定义分组接口

首先，我们需要定义分组接口。例如，我们定义两个分组接口Create和Update：

public interface Create {
}

public interface Update {
}

4.2 在实体类中使用分组

接下来，我们可以在实体类中使用这些分组接口：

public class User {
    @NotNull(groups = {Create.class, Update.class}, message = "用户名不能为空")
    private String username;

    @NotBlank(groups = Create.class, message = "密码不能为空")
    @Size(min = 6, max = 20, groups = Create.class, message = "密码长度必须在6到20个字符之间")
    private String password;

    @Email(groups = {Create.class, Update.class}, message = "邮箱格式不正确")
    private String email;

    // getters and setters
}

4.3 在Controller中使用分组

最后，我们可以在Controller中使用@Validated注解来指定分组：

@RestController
@RequestMapping("/users")
public class UserController {

    @PostMapping
    public ResponseEntity<String> createUser(@Validated(Create.class) @RequestBody User user) {
        // 处理用户创建逻辑
        return ResponseEntity.ok("用户创建成功");
    }

    @PutMapping("/{id}")
    public ResponseEntity<String> updateUser(@PathVariable Long id, @Validated(Update.class) @RequestBody User user) {
        // 处理用户更新逻辑
        return ResponseEntity.ok("用户更新成功");
    }
}

5. 总结

在Spring Boot项目中，参数校验是确保数据完整性和安全性的重要手段。通过使用注解、自定义校验器、全局异常处理和分组校验等方法，我们可以有效地对传入的参数进行校验，并返回友好的错误信息。希望本文能帮助你在Spring Boot项目中更好地实现参数校验。