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

点击链接加入群聊【java菜鸟学习】:https://jq.qq.com/?_wv=1027&k=5afU7nS
群号:124569404
常用标签

@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(分组)

<think>好的,用户想了解Java中的@NotNull注解的用法和含义。我需要先整理相关的信息,确保回答准确且符合用户需求。首先,根据提供的引用内容,@NotNull是用于标记方法参数、字段或返回值不能为null的注解,帮助在编译时或运行时捕获空指针异常。 接下来要分几个部分来讲解。首先是基本概念,解释@NotNull的作用和目的。然后需要说明它的适用场景,比如参数校验、返回值保证等。接着要提到不同的实现框架,比如Jakarta Validation和JetBrains的注解,因为用户可能对不同的库有疑问。 还要注意使用注意事项,比如需要配合校验框架,处理运行时异常,以及命名规范的问题,比如引用4提到的参数命名不规范导致的问题。这部分需要提醒用户注意字段命名与实际使用的一致性。 另外,用户可能不清楚@NotNull与其他注解如@NotEmpty、@NotBlank的区别,需要简要对比,但根据问题,主要聚焦在@NotNull上。不过可以提到这些区别,引用3有相关内容,可以作为补充信息。 最后,生成相关问题,帮助用户进一步学习。需要确保问题相关且有引导性,比如与其他注解的区别、实际应用中的问题、如何配置校验框架等。 需要确保回答结构清晰,使用中文,避免使用Markdown,行内公式用$...$,独立公式用$$...$$,但根据用户的问题,可能数学公式较少,不过如果有涉及的地方要正确应用。同时检查引用标注,确保正确对应引用内容,如引用1、2、3、4中的相关信息。 现在组织回答内容,分点说明,保持语言简洁明了,符合用户的需求。</think>关于Java中@NotNull注解的用法和含义,以下是详细说明: ### 一、基本概念 $@NotNull$是Java中用于标记方法参数、字段或返回值不能为$null$的注解。它的核心作用是: 1. **编译时检查**:部分工具(如IDEA)会在编码阶段提示潜在的空指针异常 2. **运行时验证**:配合校验框架(如Hibernate Validator)实现参数校验 3. **文档说明**:明确标识变量不可为空,增强代码可读性[^2] ### 二、适用场景 1. **方法参数校验**: ```java public void processOrder(@NotNull Order order) { // 方法体 } ``` 2. **返回值约束**: ```java public @NotNull String getRequiredData() { // 必须返回非null值 } ``` 3. **字段校验**: ```java public class User { @NotNull private String username; } ``` ### 三、实现框架对比 | 实现方案 | 特点 | |----------------------|--------------------------------------------------------------------| | Jakarta Validation | 标准规范,需配合校验框架使用,如:`javax.validation.constraints.NotNull` | | JetBrains注解 | IDEA专用,仅提供编译时检查,`org.jetbrains.annotations.NotNull` | | Lombok | 通过注解处理器生成非空检查代码 | ### 四、使用注意事项 1. **必须配合校验框架**才能触发运行时检查(如Spring的@Valid注解) 2. **异常处理**:校验失败会抛出`ConstraintViolationException`,需统一处理[^1] 3. **命名规范**:字段命名需与实际业务含义一致(参见引用[4]GPS字段的案例) 4. **组合使用**:常与@Size、@Pattern等注解配合进行复杂校验 ### 五、与其他注解对比 | 注解 | 校验规则 | 示例 | |------------|---------------------------------|--------------------| | @NotNull | 值不为null | null → 失败 | | @NotEmpty | 非null且非空(容器/字符串) | "" → 失败 | | @NotBlank | 非null且包含非空白字符 | " " → 失败 | ### 六、配置示例(Spring Boot) ```properties # 启用参数校验 spring.mvc.throw-exception-if-no-handler-found=true spring.resources.add-mappings=false ```
评论 17
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值