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 注解进行数据校验的步骤如下：
- 引入相关依赖
在 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 对象。
- 处理校验结果
如果数据校验失败，会抛出 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数据校验的资料请关注脚本之家其它相关文章！
相关文章
这篇文章主要介绍了如何基于FTP4J实现FTPS连接过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2020-10-10
SpringBoot框架aop切面的execution表达式解读
这篇文章主要介绍了SpringBoot框架aop切面的execution表达式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2024-05-05
这篇文章主要给大家介绍了关于使用javaweb项目对数据库增、删、改、查操作的实现方法,avaWeb是指使用Java语言进行Web应用程序开发的技术,可以利用Java编写一些动态网页、交互式网页、企业级应用程序等,需要的朋友可以参考下2023-07-07
包是组织类的一种方式，继承顾名思义，比如谁继承了长辈的产业，其实这里的继承和我们生活中的继承很类似，下面文字将为大家详细介绍Java的包和继承2021-09-09
spring boot实现阿里云视频点播上传视频功能（复制粘贴即可）
这篇文章主要介绍了spring boot实现阿里云视频点播上传视频功能（复制粘贴即可）,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2020-12-12
这篇文章主要介绍了Java反射机制的相关内容，涉及了class类的动态加载，获取成员变量、构造函数信息等信息，需要的朋友可以参考下，希望对你有所帮助2021-07-07
这篇文章主要介绍了Feign调用全局异常处理解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2021-06-06
这篇文章主要介绍了Java ResourceBundle案例详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下2021-08-08
下面小编就为大家带来一篇JavaBean和Map转换封装类的方法。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧2016-10-10
这篇文章主要介绍了java生成随机数(字符串)示例分享,需要的朋友可以参考下2014-03-03
最新评论