Spring Boot 系列教程19-后台验证-Hibernate Validation

本文介绍如何利用JSR303规范及Hibernate Validator实现前后端数据校验,包括配置依赖、实体类注解及异常处理,并提供了一个具体的示例。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

后台验证

  • 开发项目过程中,后台在很多地方需要进行校验操作,比如:前台表单提交,调用系统接口,数据传输等。而现在多数项目都采用MVC分层式设计,每层都需要进行相应地校验。
  • 针对这个问题, JCP 出台一个 JSR 303-Bean Validation规范 ,而Hibernate Validator 作为Bean Validation的参考实现,提供了JSR 303规范中所有内置constraint的实现,除此之外还有一些附加的constraint。
  • Hibernate Validation的使用非常简单,只用在相应的实体类中加上注解,再调用对应的校验API方法即可。

验证效果

这里写图片描述

pom.xml

<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
</dependency>

User

import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.Size;

  @Id
  @GeneratedValue
  private Long id;
  @Size(min = 5, max = 30)
  private String name;
  @Min(18)
  @Max(60)
  private Integer age;

CommonExceptionAdvice

/**
   * 400 - Bad Request
   */
  @ResponseStatus(HttpStatus.BAD_REQUEST)
  @ExceptionHandler(ConstraintViolationException.class)
  public AjaxResult handleServiceException(ConstraintViolationException e) {
    logger.error("参数验证失败", e);
    Set<ConstraintViolation<?>> violations = e.getConstraintViolations();
    ConstraintViolation<?> violation = violations.iterator().next();
    String message = violation.getMessage();
    return new AjaxResult().failure("parameter:" + message);
  }
  /**
   * 500 - Internal Server Error
   */
  @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
  @ExceptionHandler(Exception.class)
  public AjaxResult handleException(Exception e) {
    logger.error("通用异常", e);
    return new AjaxResult().failure("通用异常:" + e.getMessage());
  }

user.jsp

<table align="center">
    <tr>
        <td>名称:</td>
        <td><input class='easyui-textbox' type='text' name='name'></input></td>
    </tr>
    <tr>
        <td>年龄:</td>
        <td><input class='easyui-numberbox'  type='text' name='age'></input></td>
    </tr>
</table>

其他关联项目

源码地址

https://github.com/je-ge/spring-boot

如果觉得我的文章或者代码对您有帮助,可以请我喝杯咖啡。您的支持将鼓励我继续创作!谢谢!
微信打赏
支付宝打赏

<script type="text/javascript"> $(function () { $('pre.prettyprint code').each(function () { var lines = $(this).text().split('\n').length; var $numbering = $('<ul/>').addClass('pre-numbering').hide(); $(this).addClass('has-numbering').parent().append($numbering); for (i = 1; i <= lines; i++) { $numbering.append($('<li/>').text(i)); }; $numbering.fadeIn(1700); }); }); </script>
### spring-boot-starter-validation 是什么? `spring-boot-starter-validation` 是 Spring Boot 提供的一个启动器依赖,用于简化 Java Bean Validation 的集成。它基于 Jakarta Bean Validation(JSR 380)规范,允许开发者通过注解的方式对 Java Bean 的属性进行校验,从而减少手动编写验证逻辑的代码量。 该启动器默认引入了 Jakarta Validation API 和 Hibernate Validator 实现,使得诸如 `@NotNull`、`@NotBlank`、`@Email`、`@Pattern` 等注解可以直接在项目中使用[^1]。开发者无需额外配置即可直接使用 `@Valid` 或 `@Validated` 注解来触发参数校验逻辑,尤其是在控制器方法中接收请求参数时非常常见。 例如,在一个 Spring MVC 控制器中可以这样使用: ```java @RestController public class UserController { @PostMapping("/users") public ResponseEntity<String> createUser(@Valid @RequestBody User user) { return ResponseEntity.ok("User is valid"); } } ``` ### 包含 spring-boot-starter-validationSpring Boot 依赖包 `spring-boot-starter-validation` 被包含在 Spring Boot 官方提供的多个 starter 模块中,尤其是那些涉及 Web 功能的模块。最常见的是: - **spring-boot-starter-web**:这是构建 Web 应用程序的核心启动器,内部默认引入了 `spring-boot-starter-validation`,因此只要项目中使用了 Web 模块,就不需要再单独添加 Validation 启动器[^2]。 ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> ``` - **spring-boot-starter-thymeleaf**、**spring-boot-starter-data-rest** 等其他依赖也可能间接引入该模块,但主要依赖关系仍然来自 `spring-boot-starter-web`。 如果项目不使用 Web 模块但仍需要启用 Bean Validation 功能,则应显式添加 `spring-boot-starter-validation` 依赖[^3]: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency> ``` ### 参数校验使用概要 Spring Boot 支持两种常用的参数校验方式:`@Valid` 和 `@Validated`。它们的区别在于: - `@Valid`:是标准的 Jakarta Bean Validation 注解,适用于方法参数级别的校验,常用于 Controller 层的方法入参校验。 - `@Validated`:是 Spring 提供的注解,支持类级别校验,并且可以在非 Controller 场景中使用,例如 Service 层或通过 AOP 实现校验。 在校验失败时,可以通过 `@ExceptionHandler` 或 `@ControllerAdvice` 捕获 `MethodArgumentNotValidException` 异常并返回统一的错误响应格式。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值