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

相关文章

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

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

一文带你了解SpringBoot中启动参数的各种用法

《一文带你了解SpringBoot中启动参数的各种用法》在使用SpringBoot开发应用时,我们通常需要根据不同的环境或特定需求调整启动参数,那么,SpringBoot提供了哪些方式来配置这些启动参... 目录一、启动参数的常见传递方式二、通过命令行参数传递启动参数三、使用 application.pro

基于@RequestParam注解之Spring MVC参数绑定的利器

《基于@RequestParam注解之SpringMVC参数绑定的利器》:本文主要介绍基于@RequestParam注解之SpringMVC参数绑定的利器,具有很好的参考价值,希望对大家有所帮助... 目录@RequestParam注解:Spring MVC参数绑定的利器什么是@RequestParam?@

SpringBoot接收JSON类型的参数方式

《SpringBoot接收JSON类型的参数方式》:本文主要介绍SpringBoot接收JSON类型的参数方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、jsON二、代码准备三、Apifox操作总结一、JSON在学习前端技术时,我们有讲到过JSON,而在

JAVA虚拟机中 -D, -X, -XX ,-server参数使用

《JAVA虚拟机中-D,-X,-XX,-server参数使用》本文主要介绍了JAVA虚拟机中-D,-X,-XX,-server参数使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有... 目录一、-D参数二、-X参数三、-XX参数总结:在Java开发过程中,对Java虚拟机(JVM)的启动参数进

Java中使用注解校验手机号格式的详细指南

《Java中使用注解校验手机号格式的详细指南》在现代的Web应用开发中,数据校验是一个非常重要的环节,本文将详细介绍如何在Java中使用注解对手机号格式进行校验,感兴趣的小伙伴可以了解下... 目录1. 引言2. 数据校验的重要性3. Java中的数据校验框架4. 使用注解校验手机号格式4.1 @NotBl

解读docker运行时-itd参数是什么意思

《解读docker运行时-itd参数是什么意思》在Docker中,-itd参数组合用于在后台运行一个交互式容器,同时保持标准输入和分配伪终端,这种方式适合需要在后台运行容器并保持交互能力的场景... 目录docker运行时-itd参数是什么意思1. -i(或 --interactive)2. -t(或 --

Java通过反射获取方法参数名的方式小结

《Java通过反射获取方法参数名的方式小结》这篇文章主要为大家详细介绍了Java如何通过反射获取方法参数名的方式,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1、前言2、解决方式方式2.1: 添加编译参数配置 -parameters方式2.2: 使用Spring的内部工具类 -

Python调用另一个py文件并传递参数常见的方法及其应用场景

《Python调用另一个py文件并传递参数常见的方法及其应用场景》:本文主要介绍在Python中调用另一个py文件并传递参数的几种常见方法,包括使用import语句、exec函数、subproce... 目录前言1. 使用import语句1.1 基本用法1.2 导入特定函数1.3 处理文件路径2. 使用ex

MySQL中时区参数time_zone解读

《MySQL中时区参数time_zone解读》MySQL时区参数time_zone用于控制系统函数和字段的DEFAULTCURRENT_TIMESTAMP属性,修改时区可能会影响timestamp类型... 目录前言1.时区参数影响2.如何设置3.字段类型选择总结前言mysql 时区参数 time_zon