SpringBoot 中使用 @Valid 注解 + Exception 全局处理器优雅处理参数验证

本文介绍了如何在 SpringBoot 中利用 @Valid 注解进行参数验证,并结合全局异常处理器提升代码的优雅性。通过在实体类中添加 @Valid 相关注解,接口方法中使用 @Valid,配合自定义的全局异常处理器,可以简洁地处理参数验证。文章还提供了具体的代码示例,包括 Maven 依赖、自定义异常类、响应枚举类、响应对象类等。
摘要由CSDN通过智能技术生成

三、@Valid 的相关注解

四、使用 @Valid 进行参数效验步骤

  • 实体类中添加 @Valid 相关注解

  • 接口类中添加 @Valid 注解

  • 全局异常处理类中处理 @Valid 抛出的异常

五、SpringBoot 中使用 @Valid 示例

  • Maven 引入相关依赖

  • 自定义个异常类

  • 自定义响应枚举类

  • 自定义响应对象类

  • 自定义实体类中添加 @Valid 相关注解

  • Controller 中添加 @Valid 注解

  • 全局异常处理

  • 启动类

  • 示例测试

相关地址:

Spring Servlet 文档:https://docs.spring.io/spring-boot/docs/current/api/org/springframework/boot/web/servlet

示例项目 Github:https://github.com/my-dlq/blog-example/tree/master/springboot/springboot-filter-example

系统环境:

Jdk 版本:jdk 8

SpringBoot 版本:2.2.1.RELEASE

一、为什么使用 @Valid 来验证参数


在平常通过 Spring 框架写代码时候,会经常写接口类,相信大家对该类的写法非常熟悉。在写接口时经常要写效验请求参数逻辑,这时候我们会常用做法是写大量的 if 与 if else 类似这样的代码来做判断,如下:

@RestController

public class TestController {

@PostMapping(“/user”)

public String addUserInfo(@RequestBody User user) {

if (user.getName() == null || “”.equals(user.getName()) {

} else if(user.getSex() == null || “”.equals(user.getSex())) {

} else if(user.getUsername() == null || “”.equals(user.getUsername())) {

} else {

}

}

}

这样的代码如果按正常代码逻辑来说,是没有什么问题的,不过按优雅来说,简直糟糕透了。不仅不优雅,而且如果存在大量的验证逻辑,这会使代码看起来乱糟糟,大大降低代码可读性,那么有没有更好的方法能够简化这个过程呢?

答案当然是有,推荐的是使用 @Valid 注解来帮助我们简化验证逻辑。

二、@Valid 注解的作用


注解 @Valid

  • 1
    点赞
  • 13
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
在Spring Boot,可以使用 Hibernate Validator(javax.validation)库来对字段进行验证,其包括使用 @Email 注解验证电子邮件地址的有效性。 首先,确保在项目的依赖添加了 Hibernate Validator 的相关库。可以在 Maven 添加以下依赖: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency> ``` 然后,在需要进行验证的实体类使用 @Email 注解来标记需要验证的字段。例如: ```java import javax.validation.constraints.Email; import javax.validation.constraints.NotBlank; public class User { @NotBlank(message = "邮箱不能为空") @Email(message = "请输入有效的电子邮件地址") private String email; // 其他字段和方法... } ``` 在上面的示例,@NotBlank 注解用来验证邮箱字段不能为空,@Email 注解用来验证邮箱地址的有效性。 接下来,在需要进行验证的地方(例如控制器方法),使用 @Valid 注解对实体类进行验证。例如: ```java 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("/users") public String createUser(@RequestBody @Valid User user) { // 处理创建用户的逻辑 return "User created successfully"; } } ``` 在上面的示例,@Validated 注解用来启用验证功能,@Valid 注解用来验证传入的 User 对象。 如果传入的邮箱地址不符合有效的电子邮件格式,验证将失败,并返回相应的错误消息。 请注意,以上示例仅为演示目的,实际使用可能会有其他配置和处理方式。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值