@NotNull注解的基本概念与来源
在Java开发中,参数校验是确保程序健壮性的重要环节。@NotNull是JSR 303（Java Bean Validation）规范中的一个核心注解，用于标记某个字段、方法参数或返回值不能为null，该注解通常与Hibernate Validator等实现框架结合使用，为开发者提供声明式的校验方式，避免手动编写大量的if-else判断代码。
@NotNull属于javax.validation.constraints包下的注解，自Java EE 6起被广泛采用，其核心作用是在运行时检查被标注的元素是否为null，若为null则抛出ConstraintViolationException异常，与@NotEmpty（检查字符串非空且长度大于0）和@NotBlank（检查字符串非空且去除空格后长度大于0）不同，@NotNull仅关注是否为null，不关心元素的实际内容或长度。
@NotNull的基本使用场景
类字段校验
在实体类中,@NotNull常用于标记必须赋值的字段，用户注册时，用户名、邮箱等关键字段通常不能为null，通过在字段上添加@NotNull注解，配合校验框架，可以在数据入库或业务逻辑处理前自动完成校验。
public class User {
@NotNull(message = "用户名不能为空")
private String username;
@NotNull(message = "邮箱不能为空")
private String email;
// getters and setters
}
方法参数校验
在服务层方法中,方法参数的校验同样重要，修改用户信息时，传入的用户ID不能为null，通过在方法参数上添加@NotNull，可以确保调用方必须提供有效参数。
public void updateUser(@NotNull(message = "用户ID不能为空") Long userId, UserUpdateDTO updateDTO) {
// 业务逻辑
}
返回值校验
对于某些关键业务方法,返回值也不能为null，查询用户信息时，若用户不存在，应抛出异常而非返回null，通过在返回值上添加@NotNull，可以强制调用方处理异常情况。
@NotNull
public User getUserById(Long userId) {
// 查询逻辑
}
@NotNull的校验机制与实现
校验触发方式
@NotNull的校验需要通过校验器手动触发或结合框架自动触发，常见的触发方式包括：
- 手动校验：使用
Validator接口的validate方法。 - 自动校验：通过Spring框架的
@Validated注解或方法参数上的@Valid注解自动触发。
手动校验示例
ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
Validator validator = factory.getValidator();
Set<ConstraintViolation<User>> violations = validator.validate(user);
if (!violations.isEmpty()) {
violations.forEach(v -> System.out.println(v.getMessage()));
}
Spring Boot中的自动校验
在Spring Boot中，只需在类或方法上添加@Validated注解，即可自动触发校验。
@Service
@Validated
public class UserService {
public void createUser(@Valid User user) {
// 业务逻辑
}
}
@NotNull的高级用法与注意事项
分组校验
在实际业务中,不同场景可能需要不同的校验规则，用户注册时需要校验密码，而更新用户信息时可能不需要，通过分组校验，可以为@NotNull指定不同的校验组。
public interface CreateGroup {}
public interface UpdateGroup {}
public class User {
@NotNull(groups = CreateGroup.class, message = "注册时用户名不能为空")
private String username;
@NotNull(groups = UpdateGroup.class, message = "更新时邮箱不能为空")
private String email;
}
嵌套校验
当对象中包含其他对象时,可以使用@Valid注解触发嵌套对象的校验。
public class Order {
@NotNull
private User user;
@Valid
@NotNull
private List<OrderItem> items;
}
自定义校验逻辑
如果@NotNull无法满足复杂校验需求，可以通过实现ConstraintValidator接口自定义校验逻辑，校验字符串是否包含特定字符。
注意事项
- 与@Null的区别：
@Null要求元素必须为null，而@NotNull要求不能为null，两者不可同时使用。 - 与基本类型的兼容性：基本类型（如
int、boolean）不能为null，因此无需使用@NotNull。 - 性能影响：频繁的校验可能会影响性能，建议在关键业务场景中使用，并避免过度校验。
@NotNull的最佳实践
明确校验消息
为@NotNull提供清晰的message属性值，便于前端或调用方快速定位问题。
@NotNull(message = "订单ID不能为空，请检查请求参数") private Long orderId;
结合其他注解使用
根据业务需求,@NotNull可以与@Size、@Pattern等注解结合使用，形成完整的校验规则。
@NotNull(message = "手机号不能为空") @Size(min = 11, max = 11, message = "手机号长度必须为11位") private String phoneNumber;
统一异常处理
在Spring Boot中，可以通过@ControllerAdvice和@ExceptionHandler统一处理校验异常，返回友好的错误信息。
@ControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(ConstraintViolationException.class)
public ResponseEntity<String> handleValidationException(ConstraintViolationException ex) {
return ResponseEntity.badRequest().body(ex.getMessage());
}
}
避免过度校验
并非所有字段都需要校验,应根据业务重要性合理使用@NotNull，可选字段或内部使用的临时字段可以不添加校验注解。
@NotNull作为Java校验框架中的基础注解，通过声明式的方式简化了null检查的代码编写，提高了代码的可读性和维护性，在实际开发中，合理使用@NotNull并结合分组校验、嵌套校验等高级功能，可以构建健壮的参数校验机制，需要注意校验的性能影响和异常处理，确保校验逻辑既全面又高效，通过遵循最佳实践，开发者能够充分发挥@NotNull的作用，为应用程序的稳定性提供有力保障。
