导语
在 Spring Boot 中，我们经常需要对输入参数进行校验，以确保数据的有效性。通常情况下，我们可以使用 javax.validation 包中的注解来进行参数校验，比如 @NotNull、@Min、@Max 等。但是，这些注解只能对非空值进行校验，无法对可选的 int 值进行校验。本篇博客将介绍如何在 Spring Boot 中自定义注解来实现可选 int 值的校验。
自定义注解
首先，我们需要定义一个自定义注解来进行校验。我们可以使用 @Constraint 注解将自定义注解标记为约束注解，然后使用注解的 validatedBy 属性指定对应的校验器。
@Target({ ElementType.FIELD, ElementType.PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = { OptionalIntValidator.class })
public @interface OptionalIntValue {
String message() default "Invalid optional int value";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
在上面的代码中，我们定义了一个名为 OptionalIntValue 的注解，并将其标记为约束注解。同时，我们指定了对应的校验器类为 OptionalIntValidator。
校验器
接下来，我们需要定义校验器类 OptionalIntValidator 来实现对可选 int 值的校验逻辑。校验器需要实现 ConstraintValidator 接口，并重写其中的方法。
public class OptionalIntValidator implements ConstraintValidator<OptionalIntValue, Integer> {
@Override
public boolean isValid(Integer value, ConstraintValidatorContext context) {
if (value == null) {
return true; // 可选值为 null，无需校验
}
// 根据业务需求进行校验逻辑的实现
// 比如校验 value 是否在指定范围内
return true; // 校验通过
}
}
在上面的代码中，我们实现了 isValid 方法，在该方法中，我们根据业务需求进行校验逻辑的实现。在这个例子中，我们只是简单地判断可选值是否为 null，并返回相应的校验结果。
使用注解进行参数校验
在使用自定义注解进行参数校验时，我们只需要在需要校验的参数上加上自定义注解即可。
@RestController
@RequestMapping("/api")
public class UserController {
@GetMapping("/user/{id}")
public User getUserById(@PathVariable @OptionalIntValue Integer id) {
// 校验通过，继续处理
return userService.getUserById(id);
}
}
在上面的代码中，我们在 getUserById 方法的 id 参数上加上了 @OptionalIntValue 注解。当传入的 id 值为可选值且不为 null 时，该值会被校验器进行校验。
总结
通过自定义注解实现可选 int 值的校验，我们可以扩展 Spring Boot 的参数校验功能，提高代码的可读性和可维护性。同时，我们也可以根据业务需求，在校验器中根据实际情况实现自定义的校验逻辑。
希望本篇博客能为大家在 Spring Boot 中实现可选 int 值的校验提供一些参考和帮助。如果有任何疑问或建议，欢迎留言讨论。感谢阅读！
本文来自极简博客，作者：风吹麦浪，转载请注明原文链接：Spring Boot 中自定义注解实现可选 int 值的校验
