spring 注解验证@NotNull等使用方法

本文详细介绍了在Java中如何使用注解进行数据校验,包括@Null、@NotNull、@AssertTrue等常用标签的使用,以及如何通过分组(GroupInterface)实现不同场景下的字段验证。同时,提供了具体的代码示例,展示了如何在Controller和VO中应用这些注解。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

常用标签

@Null  被注释的元素必须为null
@NotNull  被注释的元素不能为null
@AssertTrue  被注释的元素必须为true
@AssertFalse  被注释的元素必须为false
@Min(value)  被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@Max(value)  被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@DecimalMin(value)  被注释的元素必须是一个数字,其值必须大于等于指定的最小值
@DecimalMax(value)  被注释的元素必须是一个数字,其值必须小于等于指定的最大值
@Size(max,min)  被注释的元素的大小必须在指定的范围内。
@Digits(integer,fraction)  被注释的元素必须是一个数字,其值必须在可接受的范围内
@Past  被注释的元素必须是一个过去的日期
@Future  被注释的元素必须是一个将来的日期
@Pattern(value) 被注释的元素必须符合指定的正则表达式。
@Email 被注释的元素必须是电子邮件地址
@Length 被注释的字符串的大小必须在指定的范围内
@NotEmpty  被注释的字符串必须非空
@Range  被注释的元素必须在合适的范围内

example :
vo 页面传过来的数据进行校验
inferface : 只是作为标记一个组别 可以在vo验证的某个字段上面加入多个组别,这样没有加入的组别就不会验证这个字段
controller: 需要 加入 @Validated (GroupInterface1.class) //GroupInterface1.class是定义的分组 GroupInterface2.class 需要校验的字段是不会验证的

VO:

public class User implements Serializable {
    /**
     * 主键
     */
    @NotNull(message = "primary is not null",groups = {GroupInterface1.class})
	private Long id;
	
	@Pattern(regexp = "[0123456789]",groups = {GroupInterface1.class,GroupInterface2.class},message = "hava a error Date")
	private Long maxDiscountAmount;
	

	@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
	private Date createTime;

	@Future(message = "expireTime is not less than now",groups = {GroupInterface1.class,GroupInterface2.class})
	@NotNull(message = "expireTime is not null",groups = {GroupInterface1.class,GroupInterface2.class})
	private Date expireTime;

}

另外一个例子:

import java.util.Date;

import javax.validation.constraints.DecimalMax;
import javax.validation.constraints.DecimalMin;
import javax.validation.constraints.Email;
import javax.validation.constraints.Future;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

import org.hibernate.validator.constraints.Range;
import org.springframework.format.annotation.DateTimeFormat;

/**** imports ****/
public class ValidatorPojo {

	// 非空判断
	@NotNull(message = "id不能为空")
	private Long id;

	@Future(message = "需要一个将来日期") // 只能是将来的日期
	// @Past //只能去过去的日期
	@DateTimeFormat(pattern = "yyyy-MM-dd") // 日期格式化转换
	@NotNull // 不能为空
	private Date date;

	@NotNull // 不能为空
	@DecimalMin(value = "0.1") // 最小值0.1元
	@DecimalMax(value = "10000.00") // 最大值10000元
	private Double doubleValue = null;

	@Min(value = 1, message = "最小值为1") // 最小值为1
	@Max(value = 88, message = "最大值为88") // 最大值88
	@NotNull // 不能为空
	private Integer integer;

	@Range(min = 1, max = 888, message = "范围为1至888") // 限定范围
	private Long range;

	// 邮箱验证
	@Email(message = "邮箱格式错误")
	private String email;

	@Size(min = 20, max = 30, message = "字符串长度要求20到30之间。")
	private String size;

	public Long getId() {
		return id;
	}

	public void setId(Long id) {
		this.id = id;
	}

	public Date getDate() {
		return date;
	}

	public void setDate(Date date) {
		this.date = date;
	}

	public Double getDoubleValue() {
		return doubleValue;
	}

	public void setDoubleValue(Double doubleValue) {
		this.doubleValue = doubleValue;
	}

	public Integer getInteger() {
		return integer;
	}

	public void setInteger(Integer integer) {
		this.integer = integer;
	}

	public Long getRange() {
		return range;
	}

	public void setRange(Long range) {
		this.range = range;
	}

	public String getEmail() {
		return email;
	}

	public void setEmail(String email) {
		this.email = email;
	}

	public String getSize() {
		return size;
	}

	public void setSize(String size) {
		this.size = size;
	}

	/**** setter and getter ****/

}

此时controller应该要加上@Valid ,否则不会验证!

/***
	 * 解析验证参数错误
	 * @param vp —— 需要验证的POJO,使用注解@Valid 表示验证
	 * @param errors  错误信息,它由Spring MVC通过验证POJO后自动填充
	 * @return 错误信息Map
	 */
	@RequestMapping(value = "/valid/validate")
	@ResponseBody
	public Map<String, Object> validate(
	        @Valid @RequestBody ValidatorPojo vp, Errors errors) {
	    Map<String, Object> errMap = new HashMap<>();
	    // 获取错误列表
	    List<ObjectError> oes = errors.getAllErrors();
	    for (ObjectError oe : oes) {
	        String key = null;
	        String msg = null;
	        // 字段错误
	        if (oe instanceof FieldError) {
	            FieldError fe = (FieldError) oe;
	            key = fe.getField();// 获取错误验证字段名
	        } else {
	            // 非字段错误
	            key = oe.getObjectName();// 获取验证对象名称
	        }
	        // 错误信息
	        msg = oe.getDefaultMessage();
	        errMap.put(key, msg);
	    }
	    return errMap;
	}

GROUP interface(分组)

@NotNull 和 @NotEmpty 和@NotBlank 区别

@NotEmpty 用在集合类上面
@NotBlank 用在String上面
@NotNull    用在基本类型上

<think>好的,用户想了解Java中的@NotNull注解的用法或相关技术问题的解决方案。首先,我需要确认用户的具体需求。他们可能是在开发过程中遇到了空指针异常,想通过注解来预防这类问题,或者是在代码审查中发现需要更明确的空值约束,想了解如何正确使用@NotNull。 接下来,我需要回顾@NotNull注解的基本作用。它通常用于标记方法参数、返回值或字段,表示这些元素不能为null。这样可以在编译时或运行时进行校验,避免空指针异常。但要注意,不同的框架和工具可能有不同的实现,比如JetBrains的@NotNull和JSR 305的@Nonnull,还有Jakarta Validation的@NotNull,它们的用法和效果可能略有不同。 然后,用户可能需要知道具体的使用场景和示例。比如在方法参数中使用@NotNull,让调用者明确不能传入null;在返回值中使用,确保方法不会返回null;或者在实体类字段上使用,结合校验框架进行数据验证。需要给出具体的代码示例,说明如何在不同位置应用注解。 还需要考虑如何集成校验框架,比如Hibernate Validator,以及如何在Spring的Controller层使用@Validated进行参数校验。同时,要提到相关的依赖配置,比如Maven的依赖项,确保用户能够正确配置环境。 此外,用户可能会遇到注解不生效的问题,需要提供常见解决方案。比如检查依赖是否正确引入、是否在需要校验的地方添加了@Valid或@Validated注解,或者确认注解的来源是否与使用的框架匹配。还要提到IDE的静态分析工具,如IntelliJ IDEA的支持,帮助用户在编码时发现问题。 最后,要区分不同注解的来源和适用场景,避免混淆。例如,JetBrains的注解主要用于IDE提示,而Jakarta的注解用于运行时校验。可能还需要引用站内的参考资料,比如引用[1]和[2],说明父类与子类方法@NotNull和@Nullable的继承关系,以及@Nullable的用法对比。 总结下来,回答需要涵盖@NotNull的作用、使用场景、示例代码、框架集成、常见问题解决和不同注解的区别,确保用户能够全面理解并正确应用该注解。</think>### Java @NotNull 注解使用说明及解决方案 #### 一、@NotNull 注解的作用 `@NotNull` 是用于标记方法参数、返回值或字段**不可为 null** 的注解,主要帮助开发者在以下场景中避免空指针异常: 1. **编译时静态检查**:IDE(如 IntelliJ IDEA)或静态分析工具(如 Checker Framework)会基于注解提示潜在的空指针风险[^1]。 2. **运行时校验**:结合校验框架(如 Hibernate Validator)在方法调用或数据传输时验证非空约束[^3]。 --- #### 二、使用场景与示例 ##### 1. 方法参数校验 ```java public void processUser(@NotNull String username) { // 若传入 null,校验框架或 IDE 会抛出异常/警告 System.out.println(username.length()); } ``` ##### 2. 返回值校验 ```java public @NotNull String getUserName() { // 若返回 null,编译工具或运行时校验会报错 return "Alice"; } ``` ##### 3. 实体类字段校验 ```java public class User { @NotNull(message = "用户ID不能为空") private Long id; // Getter/Setter } ``` ##### 4. Controller 层参数校验(Spring) ```java @PostMapping("/create") public ResponseEntity<?> createUser(@RequestBody @Valid User user) { // 自动触发 @NotNull 校验,失败时返回 message } ``` --- #### 三、依赖配置(以 Hibernate Validator 为例) ```xml <!-- Maven 依赖 --> <dependency> <groupId>org.hibernate.validator</groupId> <artifactId>hibernate-validator</artifactId> <version>8.0.1.Final</version> </dependency> ``` --- #### 四、常见问题与解决 ##### 问题1:注解不生效 - **原因**:未启用校验框架或缺少 `@Valid` 注解。 - **解决**: ```java // Spring 中需在 Controller 方法参数前添加 @Valid public ResponseEntity<?> save(@RequestBody @Valid User user) { ... } ``` ##### 问题2:IDE 不提示警告 - **原因**:未启用注解的静态分析功能。 - **解决**:在 IntelliJ IDEA 中,开启 `Annotations -> Configure Annotations`,绑定 `@NotNull` 到 `javax.validation.constraints.NotNull`[^2]。 ##### 问题3:与父类方法冲突 - **规则**:子类重写父类方法时,若父类方法参数有 `@Nullable`,子类可标记为 `@NotNull`;反之若父类为 `@NotNull`,子类必须保持相同或更严格约束[^1]。 --- #### 五、注解对比 | 注解来源 | 适用场景 | 典型框架 | |----------------------|----------------------------|--------------------| | `javax.validation.NotNull` | 运行时校验 | Hibernate Validator| | `org.jetbrains.annotations.NotNull` | IDE 静态检查 | IntelliJ IDEA | | `jakarta.annotation.Nonnull` | JAX-RS/Jakarta EE | Jakarta EE | ---
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值