SpringBoot使用@NotEmpty、@NotBlank、@NotNull注解进行参数校验

 更新时间:2024年08月18日 14:42:51   作者:CodeDunkster  
我们经常需要对请求参数进行校验,本文主要介绍了SpringBoot使用@NotEmpty、@NotBlank、@NotNull注解进行参数校验,具有一定的参考价值,感兴趣的可以了解一下

在 Spring Boot 项目中,我们经常需要对请求参数进行校验,以确保其符合预期的格式和内容。Spring 提供了一些注解来简化参数校验的工作,其中包括 @NotEmpty@NotBlank 和 @NotNull。在本文中,我们将学习如何使用这些注解来进行参数校验,并解释为什么要使用它们。

1. 导入依赖

首先,在 pom.xml 文件中添加以下 Maven 依赖:

xmlCopy code
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

这将导入 Spring Boot 提供的参数校验功能所需的依赖。

2. 使用 @NotEmpty、@NotBlank、@NotNull

  • @NotEmpty:用于检查集合或数组等对象是否为 null 或空。该注解通常用于检查字符串是否为空,集合是否为空等情况。
  • @NotBlank:用于检查字符串是否不为空,并且去除首尾空格后长度大于 0。该注解通常用于检查用户输入的字符串是否为有效值。
  • @NotNull:用于检查对象(包装类:Integer、Boolean等)是否不为 null。该注解通常用于检查对象是否已经被初始化。

3. 增加 @Validated 注解

为了让参数校验注解生效,我们需要在 Controller 或 Service 类上添加 @Validated 注解。

4. 示例

假设我们有一个简单的 Controller 处理器,用于接收用户的注册请求,并需要对用户名和密码进行校验:

import javax.validation.Valid;
import javax.validation.constraints.NotBlank;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Validated
public class UserController {

    @PostMapping("/register")
    public String registerUser(@Valid @RequestBody UserDTO userDTO) {
        // 处理用户注册逻辑
        return "User registered successfully!";
    }

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

        @NotBlank(message = "密码不能为空")
        private String password;

        // 省略 getter 和 setter 方法
    }
}

在上面的示例中,我们定义了一个 UserDTO 类用于接收用户注册的请求参数。通过在 username 和 password 字段上添加 @NotBlank 注解,我们要求这两个字段不能为空,并且不允许只包含空格。同时,在 UserController 类上添加了 @Validated 注解,以确保参数校验生效。

5. 为什么使用 @NotEmpty、@NotBlank、@NotNull

  • 提高代码健壮性:通过对参数进行校验,可以有效地防止空指针异常或无效输入带来的问题,提高系统的稳定性和安全性。
  • 提升开发效率:使用这些注解可以减少手动编写参数校验逻辑的工作量,提高开发效率,同时使代码更加清晰易读。
  • 统一规范:采用注解方式进行参数校验可以使代码规范化,降低维护成本,并且有利于团队间的协作与交流。

6.全局异常处理器

在 Spring Boot 中,如果参数校验失败,将会抛出 MethodArgumentNotValidException 异常或 ConstraintViolationException 异常。为了统一处理这些异常,可以定义一个全局异常处理器。

下面是一个简单的全局异常处理器示例:

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.MethodArgumentNotValidException;

@ControllerAdvice
public class GlobalExceptionHandler {

	@ExceptionHandler(MethodArgumentNotValidException.class)
	public ResponseEntity<String> handleValidationExceptions(MethodArgumentNotValidException ex) {
    return new ResponseEntity<>("Invalid request: " + ex.getMessage(), HttpStatus.BAD_REQUEST);
  }

// 可以添加其他异常处理方法
}

在上面的示例中,handleValidationExceptions 方法用于处理参数校验异常 MethodArgumentNotValidException,并返回一个包含错误信息的 ResponseEntity 对象。

通过定义全局异常处理器,可以集中处理所有控制器中抛出的参数校验异常,并向客户端返回统一的错误信息,提高了代码的可维护性和可重用性。

总结

在 Spring Boot 中使用参数校验注解可以方便地对用户传入的参数进行校验,保证数据的有效性和安全性。同时,通过定义全局异常处理器,可以统一处理所有的参数校验异常,提高了代码的健壮性和可维护性。

到此这篇关于SpringBoot使用@NotEmpty、@NotBlank、@NotNull注解进行参数校验的文章就介绍到这了,更多相关SpringBoot注解参数校验内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java读取txt文件中的数据赋给String变量方法

    Java读取txt文件中的数据赋给String变量方法

    今天小编就为大家分享一篇Java读取txt文件中的数据赋给String变量方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-07-07
  • Spring Java-based容器配置详解

    Spring Java-based容器配置详解

    这篇文章主要介绍了Spring Java-based容器配置详解,涉及注解和@Configuration类以及@Beans的相关知识,具有一定参考价值,需要的朋友可以了解。
    2017-10-10
  • 你了解Java中的Object类吗

    你了解Java中的Object类吗

    Object类是所有Java类的祖先。每个类都使用 Object 作为超类。所有对象(包括数组)都实现这个类的方法。可以使用类型为Object的变量指向任意类型的对象,跟着小编来具体了解吧
    2021-09-09
  • win10下配置java环境变量的方法

    win10下配置java环境变量的方法

    这篇文章主要介绍了win10下配置java环境变量的方法,本文图文并茂给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-02-02
  • 如何通过Java打印Word文档

    如何通过Java打印Word文档

    这篇文章主要介绍了如何通过Java打印Word文档,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-02-02
  • servlet之cookie简介_动力节点Java学院整理

    servlet之cookie简介_动力节点Java学院整理

    Cookie技术诞生以来,它就成了广大网络用户和Web开发人员争论的一个焦点。下面这篇文章主要给大家介绍了关于servlet之cookie简介的相关资料,文中介绍的非常详细,需要的朋友可以参考借鉴,下面来一起看看吧。
    2017-07-07
  • restTemplate发送get与post请求并且带参数问题

    restTemplate发送get与post请求并且带参数问题

    这篇文章主要介绍了restTemplate发送get与post请求并且带参数问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-07-07
  • Idea springboot springCloud热加载热调试两种常用方式

    Idea springboot springCloud热加载热调试两种常用方式

    这篇文章主要介绍了Idea springboot springCloud热加载热调试常用的两种方式,在项目开发的过程中,需要修改调试的时候偶每次都需要重启项目浪费时间,下面是我整理的两种常用的两种方式,需要的朋友可以参考下
    2023-04-04
  • 使用Spring自定义命名空间

    使用Spring自定义命名空间

    这篇文章主要介绍了使用Spring自定义命名空间方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • 如何解决 Java 中的 IndexOutOfBoundsException 异常(最新推荐)

    如何解决 Java 中的 IndexOutOfBoundsException 异

    当我们在 Java 中使用 List 的时候,有时候会出现向 List 中不存在的位置设置新元素的情况,从而导致 IndexOutOfBoundsException 异常,本文将会介绍这个问题的产生原因以及解决方案
    2023-10-10

最新评论