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

如何在springboot中引入参数校验

 更新时间：2023年12月09日 10:38:41   作者：grin : (0~.~0)  
一般我们判断前端传过来的参数,需要对某些值进行判断,是否满足条件,而springboot相关的参数校验注解,可以解决我们这个问题,本文给大家介绍如何在springboot中引入参数校验,感兴趣的朋友一起看看吧

一、概要

一般我们判断前端传过来的参数，需要对某些值进行判断，是否满足条件。

而springboot相关的参数校验注解，可以解决我们这个问题。

二、快速开始

首先，我用的springboot版本是  3.1.5 

引入参数校验相关依赖

<!--1.导入JSR303规范-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>

定义实体类，并在实体类上加入相关注解。

public class Dept {
    private Integer id; //ID
    @NotNull
    private String name; //部门名称
    private LocalDateTime createTime; //创建时间
    private LocalDateTime updateTime; //修改时间
}

在controller层  给需要校验的参数加上 @ Validated

  @PostMapping("/depts")
    public Result addDept( @RequestBody @Validated Dept dept){
        //这里应该判断是否返回成功
        deptService.addDept(dept);
        return Result.success();
    }

此时如果再进行传入参数，如果name为null 就会报错。

三、额外补充

在前面我们谈到了校验的基本用法，但在开发中，我需要对这些异常进行统一处理，并返回符合相应规则的返回值。

因此，需要用到全局异常处理。

让gpt解答一下：

@RestControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<ErrorResponse> handleValidationException(MethodArgumentNotValidException ex) {
        BindingResult bindingResult = ex.getBindingResult();
        List<String> errors = bindingResult.getFieldErrors().stream()
                .map(FieldError::getDefaultMessage)
                .collect(Collectors.toList());
        ErrorResponse response = new ErrorResponse("Validation Failed", errors);
        return ResponseEntity.badRequest().body(response);
    }
}

bindingResult.getAllErrors(); getFieldErrors（） 有什么区别？

@RestController
@RequestMapping("/users")
public class UserController {
    @PostMapping
    public ResponseEntity<String> createUser(@Validated @RequestBody User user, BindingResult result) {
        if (result.hasErrors()) {
            // 获取字段错误列表
            List<FieldError> fieldErrors = result.getFieldErrors();
            // 遍历字段错误列表，输出错误信息
            for (FieldError error : fieldErrors) {
                String fieldName = error.getField();
                String errorMessage = error.getDefaultMessage();
                System.out.println("字段名：" + fieldName + "，错误信息：" + errorMessage);
            }
            return ResponseEntity.badRequest().body("参数校验失败");
        }
        // 校验通过，处理创建用户的逻辑
        return ResponseEntity.ok("用户创建成功");
    }
}

到此这篇关于如何在springboot中引入参数校验的文章就介绍到这了,更多相关springboot参数校验内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

最新评论