Spring Validation

最新推荐文章于 2024-08-13 10:43:31 发布

h1090637222

最新推荐文章于 2024-08-13 10:43:31 发布

阅读量89

点赞数

分类专栏：框架基础文章标签： spring java 后端

本文链接：https://blog.csdn.net/h1090637222/article/details/125371277

版权

框架基础专栏收录该内容

16 篇文章 0 订阅

订阅专栏

本文介绍了如何在Spring Boot应用中使用Validation框架进行参数验证，并展示了如何添加依赖、在控制器中添加@Validated注解、POJO中的注解设置以及在全局异常处理器中处理BindException。

摘要由CSDN通过智能技术生成

关于Validation框架的基本使用：
- 添加依赖
- 在控制器类中处理请求的方法的被验证的参数（封装的对象）之前添加@Validated / @Valid
- 在参数的类型（封装的类型）的属性之前添加验证注解
- 在统一处理异常的类中对BindException进行处理
添加依赖

<!-- Spring Boot Validation：验证请求参数的基本格式 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

在CategoryController处理请求的方法的参数之前添加@Validated / @Valid注解：

@PostMapping("/add-new")
// ===== 在以下方法的参数前添加@Validated / @Valid注解 =====
public JsonResult<Void> addNew(@Validated CategoryAddNewDTO categoryAddNewDTO) {
    categoryService.addNew(categoryAddNewDTO);
    return JsonResult.ok();
}

在pojo中的，要在此类中添加@NotNull等注解

@Data
public class CategoryAddNewDTO implements Serializable {
    @NotNull(message = "添加类别失败，必须填写类别名称！") // 新增
    private String name;
    
    // ===== 其它原有代码 =====
}

在State中添加对应“请求参数格式错误”的枚举值：

public enum State {
    OK(20000),
    // ===== 下行为新增 ======
    ERR_BAD_REQUEST(40000), // 客户端引起的--请求参数格式错误
    // ===== 其它原有代码 =====
}

在GlobalExceptionHandler中添加新的处理异常的方法：

@ExceptionHandler(BindException.class)
public JsonResult<Void> handleBindException(BindException ex) {
    List<FieldError> fieldErrors = ex.getBindingResult().getFieldErrors();
    StringBuilder stringBuilder = new StringBuilder();
    for (FieldError fieldError : fieldErrors) {
        stringBuilder.append("；");
        stringBuilder.append(fieldError.getDefaultMessage());
    }
    String message = stringBuilder.substring(1);
    return JsonResult.fail(State.ERR_BAD_REQUEST, message);
}