如何在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参数校验内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Spring IOC 和 AOP 从入门到精通

    Spring IOC 和 AOP 从入门到精通

    本文将深入浅出地讲解Spring框架的两大核心特性——IOC(控制反转)和AOP(面向切面编程),本文结合实例代码给大家介绍的非常详细,感兴趣的朋友跟随小编一起看看吧
    2026-03-03
  • Java中将byte[]转MultipartFile的具体实现方式

    Java中将byte[]转MultipartFile的具体实现方式

    将 byte[]转换为 MultipartFile在处理文件上传、微服务间数据传输或格式转换等场景中非常有用,下面为您是几种几种主流的实现方式、代码示例以及关键注意事项,需要的朋友可以参考下
    2025-11-11
  • Spring Batch实战示例

    Spring Batch实战示例

    批量数据处理是一个非常常见的需求,比如月底的工资代发、银行对账、数据报表生成等,当数据量达到几十万甚至上百万时,可以高效的完成,感兴趣的可以了解一下
    2026-02-02
  • springboot项目之相互依赖报错问题(基于idea)

    springboot项目之相互依赖报错问题(基于idea)

    这篇文章主要介绍了springboot项目之相互依赖报错问题(基于idea),具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-02-02
  • Java 多线程死锁的产生以及如何避免死锁

    Java 多线程死锁的产生以及如何避免死锁

    这篇文章主要介绍了Java 多线程死锁的产生以及如何避免死锁,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-09-09
  • Java中try-catch的使用及注意细节

    Java中try-catch的使用及注意细节

    现在有很多的语言都支持try-catch,比如常见的就是c++,java等,这篇文章主要给大家介绍了关于Java中try-catch的使用及注意细节的相关资料,文中通过图文以及实例代码介绍的非常详细,需要的朋友可以参考下
    2023-06-06
  • Java多线程下解决数据安全问题

    Java多线程下解决数据安全问题

    这篇文章主要介绍了Java多线程下解决数据安全问题,本文使用代码进行讲解,可供大家学习参考
    2021-08-08
  • SpringMvc获取页面中的参数方法详解

    SpringMvc获取页面中的参数方法详解

    这篇文章主要介绍了SpringMvc获取页面中的参数方法详解,获取页面的参数通常都是让类实现设置HttpServletRequest request接口然后重写接口中的方法的办法来得到参数,但是在Springmvc中有其他的获取方法,需要的朋友可以参考下
    2023-10-10
  • Java -jar运行jar包时可添加参数示例详解

    Java -jar运行jar包时可添加参数示例详解

    这篇文章主要给大家介绍了Java -jar运行jar包时可添加参数的相关资料,包括设置JAR文件、系统属性、JVM参数、Spring Profiles、配置文件位置和名称,以及传递给应用程序的参数,需要的朋友可以参考下
    2025-05-05
  • Java项目有中多个线程如何查找死锁

    Java项目有中多个线程如何查找死锁

    这篇文章主要介绍了Java项目有中多个线程如何查找死锁,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-05-05

最新评论