脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → SpringBoot @RequestBody数据校验

SpringBoot如何使用@RequestBody进行数据校验

 更新时间：2023年06月26日 09:22:07   作者：程序媛徐师姐  
在Web开发中，前台向后台发送数据是非常常见的场景，而在SpringBoot框架中，我们通常使用@RequestBody注解来接收前台发送的 JSON数据，并将其转化为Java对象，本文将介绍如何在 SpringBoot 中使用 @RequestBody 进行数据校验

SpringBoot 如何使用 @RequestBody 进行数据校验

什么是 @RequestBody

@RequestBody 注解用于接收前台发送的 JSON 数据，并将其转化为 Java 对象。它的作用是将 HTTP 请求正文中的 JSON 字符串绑定到相应的 Java 对象上。在 SpringBoot 中，我们通常使用 @RequestBody 注解来接收前台发送的 JSON 数据，并将其转化为 Java 对象。

如何使用 @RequestBody 进行数据校验

在 SpringBoot 中，我们可以使用 JSR-303 规范提供的注解来对 Java 对象进行数据校验。JSR-303 是 Java EE 6 中引入的 Bean Validation 规范，它提供了一套用于数据校验的注解。

在 SpringBoot 中使用 JSR-303 注解进行数据校验的步骤如下：

  1. 引入相关依赖

在 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>
  • 在 Java Bean 中添加校验注解

在 Java Bean 中添加校验注解，例如：

public class User {
    @NotNull(message = "用户名不能为空")
    private String username;
    @NotNull(message = "密码不能为空")
    @Size(min = 6, message = "密码长度不能小于 6 位")
    private String password;
    // 省略 getter 和 setter 方法
}
  • 在 Controller 方法中添加 @Validated 和 @RequestBody 注解

在 Controller 方法中添加 @Validated 和 @RequestBody 注解，例如：

@RestController
@RequestMapping("/user")
public class UserController {
    @PostMapping("/add")
    public Result addUser(@Validated @RequestBody User user) {
        // 处理添加用户的逻辑
    }
}

在上述代码中，@Validated 注解用于启用数据校验，@RequestBody 注解用于接收前台发送的 JSON 数据，并将其转化为 User 对象。

  1. 处理校验结果

如果数据校验失败，会抛出 MethodArgumentNotValidException 异常。我们可以在 ControllerAdvice 中捕获此异常，并返回校验结果。

@RestControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Result handleValidationException(MethodArgumentNotValidException e) {
        BindingResult bindingResult = e.getBindingResult();
        List<ObjectError> allErrors = bindingResult.getAllErrors();
        List<String> errorMessages = new ArrayList<>();
        for (ObjectError error : allErrors) {
            errorMessages.add(error.getDefaultMessage());
        }
        return Result.error(String.join(",", errorMessages));
    }
}

在上述代码中，我们使用 @RestControllerAdvice 注解声明一个全局异常处理类，其中 @ExceptionHandler 注解用于捕获 MethodArgumentNotValidException 异常，并处理校验结果，最终返回一个 Result 对象。

完整代码示例

@Data
public class User {
    @NotNull(message = "用户名不能为空")
    private String username;
    @NotNull(message = "密码不能为空")
    @Size(min = 6, message = "密码长度不能小于 6 位")
    private String password;
}
@RestController
@RequestMapping("/user")
public class UserController {
    @PostMapping("/add")
    public Result addUser(@Validated @RequestBody User user) {
        // 处理添加用户的逻辑
    }
}
@RestControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Result handleValidationException(MethodArgumentNotValidException e) {
        BindingResult bindingResult = e.getBindingResult();
        List<ObjectError> allErrors = bindingResult.getAllErrors();
        List<String> errorMessages = new ArrayList<>();
        for (ObjectError error : allErrors) {
            errorMessages.add(error.getDefaultMessage());
        }
        return Result.error以上示例代码可能有些不完整，我们来完整展示一下如何使用 @RequestBody 进行数据校验的完整代码示例。
### 引入依赖
在 pom.xml 文件中添加以下依赖：
```xml
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

编写实体类

@Data
public class User {
    @NotNull(message = "用户名不能为空")
    private String username;
    @NotNull(message = "密码不能为空")
    @Size(min = 6, message = "密码长度不能小于 6 位")
    private String password;
}

编写 Controller

@RestController
@RequestMapping("/user")
public class UserController {
    @PostMapping("/add")
    public Result addUser(@Validated @RequestBody User user) {
        // 处理添加用户的逻辑
    }
}

在上述代码中，@Validated 注解用于启用数据校验，@RequestBody 注解用于接收前台发送的 JSON 数据，并将其转化为 User 对象。

编写全局异常处理类

如果数据校验失败，会抛出 MethodArgumentNotValidException 异常。我们可以在 ControllerAdvice 中捕获此异常，并返回校验结果。

@RestControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Result handleValidationException(MethodArgumentNotValidException e) {
        BindingResult bindingResult = e.getBindingResult();
        List<ObjectError> allErrors = bindingResult.getAllErrors();
        List<String> errorMessages = new ArrayList<>();
        for (ObjectError error : allErrors) {
            errorMessages.add(error.getDefaultMessage());
        }
        return Result.error(String.join(",", errorMessages));
    }
}

在上述代码中，我们使用 @RestControllerAdvice 注解声明一个全局异常处理类，其中 @ExceptionHandler 注解用于捕获 MethodArgumentNotValidException 异常，并处理校验结果，最终返回一个 Result 对象。

编写启动类

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

编写测试类

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class UserControllerTest {
    @Autowired
    private TestRestTemplate restTemplate;
    @Test
    public void addUserTest() {
        User user = new User();
        user.setUsername("test");
        user.setPassword("12345");
        ResponseEntity<Result> responseEntity = restTemplate.postForEntity("/user/add", user, Result.class);
        Assert.assertEquals(HttpStatus.OK, responseEntity.getStatusCode());
        Result result = responseEntity.getBody();
        Assert.assertEquals(ResultStatus.FAIL.getCode(), result.getStatus());
        Assert.assertEquals("密码长度不能小于 6 位", result.getMessage());
    }
}

在上述代码中，我们使用 SpringBoot 自带的 TestRestTemplate 对象来模拟发送 POST 请求，并验证数据校验的结果是否符合预期。

总结

在 SpringBoot 中使用 @RequestBody 进行数据校验，可以有效地提高代码的健壮性和可靠性。通过 JSR-303 提供的注解，我们可以轻松地对 Java 对象进行数据校验，并在数据校验失败时返回相应的错误信息。希望本文能够对大家在 SpringBoot 中使用 @RequestBody 进行数据校验有所帮助。

以上就是SpringBoot 如何使用 @RequestBody 进行数据校验的详细内容，更多关于SpringBoot @RequestBody数据校验的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

相关文章

  • Java 继承原理与用法实例分析

    Java 继承原理与用法实例分析

    这篇文章主要介绍了Java 继承原理与用法,结合实例形式分析了java面向对象程序设计中继承的概念、原理、用法及操作注意事项,需要的朋友可以参考下
    2019-06-06
  • Java之OutputStreamWriter流案例详解

    Java之OutputStreamWriter流案例详解

    这篇文章主要介绍了Java之OutputStreamWriter流案例详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
    2021-08-08
  • Java调用高德地图API根据详细地址获取经纬度详细教程

    Java调用高德地图API根据详细地址获取经纬度详细教程

    写了一个经纬度相关的工具,分享给有需求的小伙伴们,下面这篇文章主要给大家介绍了关于Java调用高德地图API根据详细地址获取经纬度,文中通过图文以及代码介绍的非常详细,需要的朋友可以参考下
    2024-04-04
  • SpringBoot的跨域注解@CrossOrigin解析

    SpringBoot的跨域注解@CrossOrigin解析

    这篇文章主要介绍了SpringBoot的跨域注解@CrossOrigin解析,Spring Framework 4.2 GA为CORS提供了第一类支持,使您比通常的基于过滤器的解决方案更容易和更强大地配置它,所以springMVC的版本要在4.2或以上版本才支持@CrossOrigin,需要的朋友可以参考下
    2023-12-12
  • 利用微信小程序+JAVA实现微信支付的全过程

    利用微信小程序+JAVA实现微信支付的全过程

    微信支付是一种在线支付解决方案,允许用户通过微信内的支付功能进行付款,下面这篇文章主要给大家介绍了关于利用微信小程序+JAVA实现微信支付的相关资料,需要的朋友可以参考下
    2024-08-08
  • MyBatis配置文件元素示例详解

    MyBatis配置文件元素示例详解

    在MyBatis框架的核心配置文件中，<configuration>元素是配置文件的根元素，其他元素都要在<contiguration>元素内配置，这篇文章主要介绍了MyBatis配置文件元素,需要的朋友可以参考下
    2023-06-06
  • Java 将文件转为字节数组知识总结及实例详解

    Java 将文件转为字节数组知识总结及实例详解

    这篇文章主要介绍了Java 将文件转为字节数组实例详解的相关资料,需要的朋友可以参考下
    2016-12-12
  • elasticsearch java客户端action的实现简单分析

    elasticsearch java客户端action的实现简单分析

    这篇文章主要为大家介绍了elasticsearch java客户端action的实现简单分析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
    2022-04-04
  • Java中Boolean和boolean的区别详析

    Java中Boolean和boolean的区别详析

    boolean是基本数据类型Boolean是它的封装类,和其他类一样,有属性有方法,可以new,下面这篇文章主要给大家介绍了关于Java中Boolean和boolean区别的相关资料,需要的朋友可以参考下
    2022-07-07
  • Java如何实现实体类转Map、Map转实体类

    Java如何实现实体类转Map、Map转实体类

    这篇文章主要介绍了Java 实现实体类转Map、Map转实体类的操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2021-08-08

最新评论