validator参数校验

2024-06-14 06:52
文章标签 参数 校验 validator

本文主要是介绍validator参数校验,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

1. validator 校验机制

开发中经常需要校验前端传递的参数: 代码比较臃肿

@GetMapping("/test")
public String test0( Integer id){if(id==null){return "error";}return "success";
}

如何解决上述问题呢

JSR303 是一套JavaBean参数校验的标准,它定义了很多常用的校验注解,我们可以直接将这些注解加在我们JavaBean的属性上面(面向注解编程的时代),就可以在需要校验的时候进行校验了,在SpringBoot中已经包含在starter-web中,在其他项目中可以引用依赖,并自行调整版本:

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-validation</artifactId>
</dependency>

2. 校验方式

  • 直接在controller的方法中的参数前加上@NotNull,@Min等注解。

这种方式必须在controller上加@Validated注解.
如果校验不通过会产生org.springframework.web.bind.MethodArgumentNotValidException异常

  • 在实体类中需要进行校验的参数上方加@NotNull,@Min等注解。

这种方式必须在controller方法中需要校验的参数前加上@Validated注解(也可以用@Valid)
如果校验不通过会产生javax.validation.ConstraintViolationException;异常

TestValController

import com.gzdemo.springbootdemo.pojos.UserDto;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;@RestController
@RequestMapping("/user")
@Validated
public class TestValController {@GetMapping("/test")public String test0(Integer id){if(id==null){throw  new RuntimeException("参数异常");}return "success";}// 方式一@GetMapping("/test2")public String test2(@NotNull(message = "id不能为空") Integer id,@Min(value = 0,message = "age必须>=0") @Max(value = 100,message = "age必须<=100") Integer age){return "success";}// 方式二@PostMapping("/test3")public String test3(@Validated @RequestBody UserDto userDto){return "success";}

UserDto

import io.swagger.annotations.ApiModelProperty;
import lombok.Data;import javax.validation.constraints.*;@Data
public class UserDto {@ApiModelProperty(value="id",required = true)@NotNull(message = "id不能为Null")private Integer id;@ApiModelProperty(value="姓名",required = true)@NotBlank(message = "name不能为空")private String name;@ApiModelProperty(value="手机号",required = true)@Pattern(regexp = "^((13[0-9])|(14[5,7])|(15[0-3,5-9])|(17[0,3,5-8])|(18[0-9])|166|198|199|(147))\\d{8}$",message = "手机号格式不正确")private String phone;@ApiModelProperty(value="年龄",required = true)@Max(value = 100,message = "age不能超过100")@Min(value = 0,message = "age不能小于0")private Integer age;@ApiModelProperty(value="邮箱",required = true)@Pattern(regexp = "^[A-Za-z0-9\\u4e00-\\u9fa5]+@[a-zA-Z0-9_-]+(.[a-zA-Z0-9_-]+)+$",message = "邮箱格式不正确")private String email;
}

其他注解请参考文章:

https://blog.csdn.net/tianzhonghaoqing/article/details/116978091

3. 定义全局异常处理器

可以通过捕获参数校验产生的异常,直接返回前端校验信息。

package com.gzdemo.springbootdemo.advice;import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.validation.BindException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.validation.ObjectError;import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import java.util.HashMap;
import java.util.Map;
import java.util.stream.Collectors;@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {@ExceptionHandler(MethodArgumentNotValidException.class)public Object handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {String msg = e.getBindingResult().getAllErrors().stream().map(ObjectError::getDefaultMessage).collect(Collectors.joining("|"));log.error("请求参数校验异常 -> MethodArgumentNotValidException, {}", msg);log.debug("", e);return RespResult(400, 400, msg);}@ExceptionHandler(ConstraintViolationException.class)public Object handViolationException(ConstraintViolationException e) {String msg = e.getConstraintViolations().stream().map(ConstraintViolation::getMessage).distinct().collect(Collectors.joining("|"));log.error("请求参数异常 -> ConstraintViolationException, {}", e.getMessage());return RespResult( HttpStatus.OK.value(), HttpStatus.BAD_REQUEST.value(),msg);}@ExceptionHandler(BindException.class)public Object handleBindException(BindException e) {log.error("请求参数绑定异常 ->BindException, {}", e.getMessage());log.debug("", e);return RespResult(400, 400, "请求参数格式错误");}public Object RespResult(int status, int code, String msg){Map resultMap = new HashMap<String,Object>();resultMap.put("status",status);resultMap.put("code",code);resultMap.put("msg",msg);return resultMap;}
}

4. 测试

  • 测试第一种方式参数校验

在这里插入图片描述

  • 测试RequestBody参数校验

在这里插入图片描述

5. 分组校验

这篇关于validator参数校验的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1059685

相关文章

SpringBoot请求参数接收控制指南分享

《SpringBoot请求参数接收控制指南分享》:本文主要介绍SpringBoot请求参数接收控制指南,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Spring Boot 请求参数接收控制指南1. 概述2. 有注解时参数接收方式对比3. 无注解时接收参数默认位置

Python使用getopt处理命令行参数示例解析(最佳实践)

《Python使用getopt处理命令行参数示例解析(最佳实践)》getopt模块是Python标准库中一个简单但强大的命令行参数处理工具,它特别适合那些需要快速实现基本命令行参数解析的场景,或者需要... 目录为什么需要处理命令行参数?getopt模块基础实际应用示例与其他参数处理方式的比较常见问http

Java使用ANTLR4对Lua脚本语法校验详解

《Java使用ANTLR4对Lua脚本语法校验详解》ANTLR是一个强大的解析器生成器,用于读取、处理、执行或翻译结构化文本或二进制文件,下面就跟随小编一起看看Java如何使用ANTLR4对Lua脚本... 目录什么是ANTLR?第一个例子ANTLR4 的工作流程Lua脚本语法校验准备一个Lua Gramm

Linux内核参数配置与验证详细指南

《Linux内核参数配置与验证详细指南》在Linux系统运维和性能优化中,内核参数(sysctl)的配置至关重要,本文主要来聊聊如何配置与验证这些Linux内核参数,希望对大家有一定的帮助... 目录1. 引言2. 内核参数的作用3. 如何设置内核参数3.1 临时设置(重启失效)3.2 永久设置(重启仍生效

SpringMVC获取请求参数的方法

《SpringMVC获取请求参数的方法》:本文主要介绍SpringMVC获取请求参数的方法,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下... 目录1、通过ServletAPI获取2、通过控制器方法的形参获取请求参数3、@RequestParam4、@

SpringValidation数据校验之约束注解与分组校验方式

《SpringValidation数据校验之约束注解与分组校验方式》本文将深入探讨SpringValidation的核心功能,帮助开发者掌握约束注解的使用技巧和分组校验的高级应用,从而构建更加健壮和可... 目录引言一、Spring Validation基础架构1.1 jsR-380标准与Spring整合1

Spring Boot项目部署命令java -jar的各种参数及作用详解

《SpringBoot项目部署命令java-jar的各种参数及作用详解》:本文主要介绍SpringBoot项目部署命令java-jar的各种参数及作用的相关资料,包括设置内存大小、垃圾回收... 目录前言一、基础命令结构二、常见的 Java 命令参数1. 设置内存大小2. 配置垃圾回收器3. 配置线程栈大小

SpringBoot利用@Validated注解优雅实现参数校验

《SpringBoot利用@Validated注解优雅实现参数校验》在开发Web应用时,用户输入的合法性校验是保障系统稳定性的基础,​SpringBoot的@Validated注解提供了一种更优雅的解... 目录​一、为什么需要参数校验二、Validated 的核心用法​1. 基础校验2. php分组校验3

Pydantic中model_validator的实现

《Pydantic中model_validator的实现》本文主要介绍了Pydantic中model_validator的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价... 目录引言基础知识创建 Pydantic 模型使用 model_validator 装饰器高级用法mo

Java进行文件格式校验的方案详解

《Java进行文件格式校验的方案详解》这篇文章主要为大家详细介绍了Java中进行文件格式校验的相关方案,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录一、背景异常现象原因排查用户的无心之过二、解决方案Magandroidic Number判断主流检测库对比Tika的使用区分zip