spring-boot-starter-validation 校验参数的实现

2024-04-02 19:04:59 510人浏览薄情痞子

Python 官方文档：入门教程 => 点击学习

摘要

目录一、前言二、常用注解三、定义分组四、定义需要校验的对象五、在handler 即 Controller中校验六、定义全局异常处理类七、测试效果八、嵌套对象的校验九、自定义注解（自

一、前言

本章介绍使用spring-boot-starter-validation 校验 springMVC 的入参。

	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.5.2</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-validation</artifactId>
		</dependency>

二、常用注解

三、定义分组

用于分组校验。
使用场景，对同一个对象例如User(username , id) 在不同的接口时需要的校验规则不同。
例如，访问一个接口需要 username 不为null且长度大于0 ，id>=0 ；访问另一个接口需要 username 参数的长度在 [1,3]之间。

public class ValidateGroup {
    public interface FirstGroup {
    }

    public interface SecondeGroup {
    }

    public interface ThirdGroup {
    }
}

四、定义需要校验的对象

import javax.validation.constraints.Min;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.Size;
import lombok.Data;

@Data
public class User {
	@NotEmpty(message = "用户名不能为空")
	@Size(message = "用户名长度 [1-3] ", min = 1, max = 3,groups = ValidateGroup.FirstGroup.class)
	private String username;
	@Min(message = "id不得小于0", value = 0)
	private Integer id;

}

五、在handler 即 Controller中校验

import org.springframework.WEB.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import com.nbpicc.controller.ValidateGroup.FirstGroup;

@RestController
@RequestMapping("/")
public class TestController {

	@PostMapping("test3")
	public User test3(@RequestBody @Validated({ FirstGroup.class }) User u) {
		System.out.println(u);
		return u;
	}

	@PostMapping("test4")
	public User test4(@Validated User u) {
		System.out.println(u);
		return u;
	}

}

校验失败，会直接抛出异常。这样不太友好，可以使用@ControllerAdvice处理全局异常。

六、定义全局异常处理类

import java.util.List;
import org.springframework.validation.BindException;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import lombok.extern.slf4j.Slf4j;

@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {

	@ExceptionHandler(value = BindException.class)
	public JSONResult exceptionHandle(BindException exception) {

		BindingResult result = exception.getBindingResult();
		StringBuilder errORMsg = new StringBuilder();

		List<FieldError> fieldErrors = result.getFieldErrors();
		fieldErrors.forEach(error -> {
			log.error("field: " + error.getField() + ", msg:" + error.getDefaultMessage());
			errorMsg.append(error.getDefaultMessage()).append("!");
		});
		return jsonResult.fail(errorMsg.toString());
	}

	@ExceptionHandler(value = MethodArgumentNotValidException.class)
	public JsonResult MyExceptionHandle(MethodArgumentNotValidException exception) {

		BindingResult result = exception.getBindingResult();
		StringBuilder errorMsg = new StringBuilder();

		List<FieldError> fieldErrors = result.getFieldErrors();
		fieldErrors.forEach(error -> {
			log.error("field: " + error.getField() + ", msg:" + error.getDefaultMessage());
			errorMsg.append(error.getDefaultMessage()).append("!");
		});

		return JsonResult.fail(errorMsg.toString());
	}

	// 处理运行时异常
	@ExceptionHandler(RuntimeException.class)
	public JsonResult doHandleRuntimeException(RuntimeException e) {
		log.error(e.getMessage(), e);
		e.printStackTrace();
		return JsonResult.fail(e.getMessage());
	}
}

另外JsonResult.java用于接口返回统一个json格式


import com.fasterxml.jackson.annotation.JsonInclude;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;



@Data
@Accessors(chain = true)
@NoArgsConstructor
@AllArgsConstructor 
@JsonInclude(JsonInclude.Include.NON_NULL)
public class JsonResult<T>  {
			
		public static final int SUCCESS=200;
		
		public static final int FAIL=500;
	    
	    public static final int NOT_LOGIN = 400;
	    
	    public static final int EXCEPTION = 401;
	    
	    public static final int SYS_ERROR = 402;
	    
	    public static final int PARAMS_ERROR = 403;
	    
	    public static final int NOT_SUPPORTED = 410;
	    
	    public static final int INVALID_AUTHCODE = 444;
	    
	    public static final int TOO_FREQUENT = 445;
	    
	    public static final int UNKNOWN_ERROR = 499;
		
		private Integer code;  
        private String msg;
        private T data;
        
        public static JsonResult fail() {
            return new JsonResult(FAIL, "请求处理失败",null);
        }
        public static JsonResult fail(String msg) {
            return new JsonResult(FAIL, msg,null);
        }
        public static JsonResult fail(Integer code,String msg) {
            return new JsonResult(code, msg,null);
        }
        public static JsonResult success() {
            return new JsonResult(SUCCESS,"请求处理成功",null);
        }
        public static JsonResult success(String msg) {
            return new JsonResult(SUCCESS,msg,null);
        }
        public static <T> JsonResult success(T data) {
            return new JsonResult<T> (SUCCESS,"请求处理成功",data);
        }
        public static <T>  JsonResult success(String msg,T data) {
            return new JsonResult<T>(SUCCESS, msg,data);
        }
        

        
        public static JsonResult err() {
            return build(EXCEPTION);
        }
        public static JsonResult err(String msg) {
            return build(EXCEPTION, msg);
        }
        
	
        public JsonResult<T> code(int code) {
            this.code = code;
            return this;
        }
        public JsonResult<T> msg(String msg) {
            this.msg = msg;
            return this;
        }
        public JsonResult<T> data(T data) {
            this.data = data;
            return this;
        }
        
        
        public static JsonResult build() {
            return new JsonResult();
        }
        public static JsonResult build(int code) {
            return new JsonResult().code(code);
        }
        public static JsonResult build(int code, String msg) {
            return new JsonResult<String>().code(code).msg(msg);
        }
        public static <T> JsonResult<T> build(int code, T data) {
            return new JsonResult<T>().code(code).data(data);
        }
        public static <T> JsonResult<T> build(int code, String msg, T data) {
            return new JsonResult<T>().code(code).msg(msg).data(data);
        }
        
        
}

当然还有其他异常处理方式可以参考：https://www.jb51.net/article/244379.htm

七、测试效果

八、嵌套对象的校验


import lombok.Data;

import javax.validation.Valid;
import javax.validation.constraints.*;

@Data
public class User {
    @NotEmpty(message = "用户名不能为空")
    @Size(message = "长度 [1-3] ", min = 1, max = 3, groups = ValidateGroup.FirstGroup.class)
    private String username;

    @Min(message = "id不得小于0", value = 0)
    private Integer id;
    
    @NotBlank(message = "地址不能为空", groups = {ValidateGroup.ThirdGroup.class, ValidateGroup.SecondeGroup.class})
    private String address;

    //在内部属性是自定义对象的时候添加 @Valid 注解 ，即可开启对In对象的校验。 
    //记得添加@NotNull注解，否则该对象可以为null，并且此时In对象的校验规则也不会抛出异常 。
    @Valid
    @NotNull(message = "In 对象不能为null ", groups = {ValidateGroup.ThirdGroup.class, ValidateGroup.SecondeGroup.class})
    private In in;
}


@Data
public class In {

    @NotBlank(message = "str不能为空", groups = {ValidateGroup.ThirdGroup.class, ValidateGroup.SecondeGroup.class})
    private String str;
}

九、自定义注解（自定义校验规则）

9.1 实现ConstraintValidator接口

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class WordConstraintValidator implements ConstraintValidator<CustomValidaor, Object> {
	@Override
	public boolean isValid(Object value, ConstraintValidatorContext context) {
		// 具体的校验规则
		return value.toString().length() == 10;
	}
}

9.2 自定义注解

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import javax.validation.Constraint;
import javax.validation.Payload;

@Target({ ElementType.METHOD, ElementType.FIELD })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = WordConstraintValidator.class)
public @interface CustomValidaor {

	String message();

	// groups 和 payload 这两个parameter 必须包含,不然会报错
	Class<?>[] groups() default {};

	Class<? extends Payload>[] payload() default {};

}

9.3 使用

@Data
public class Inner {
	@NotBlank(message = "str不能为空", groups = { ValidateGroup.ThirdGroup.class, ValidateGroup.SecondeGroup.class })
	@CustomValidaor(message = "长度必须为10", groups = { ValidateGroup.ThirdGroup.class, ValidateGroup.SecondeGroup.class })
	private String str;
}

9.4测试

访问接口

@PostMapping("test6")
public User test6(@Validated({ValidateGroup.SecondeGroup.class}) @RequestBody User u) {
System.out.println(u);
return u;
}

到此这篇关于spring-boot-starter-validation 校验参数的实现的文章就介绍到这了,更多相关spring-boot-starter-validation 校验参数内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网！

您可能感兴趣的文档:

点击免费下载>>软考高级考试备考技巧/历年真题/备考精华资料

--结束END--

本文标题: spring-boot-starter-validation 校验参数的实现

本文链接: https://www.lsjlt.com/news/145893.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑，方便收藏和打印～

下载Word文档

去做题

猜你喜欢

spring-boot-starter-validation 校验参数的实现

目录一、前言二、常用注解三、定义分组四、定义需要校验的对象五、在handler 即 Controller中校验六、定义全局异常处理类七、测试效果八、嵌套对象的校验九、自定义注解（自...

99+

2022-11-13
spring boot输入数据校验(validation)的实现过程

项目内容实现一个简单的用户注册接口，演示怎样进行数据校验。要求 JDK1.8或更新版本 Eclipse开发环境如没有开发环境，可参考 [spring boo...

99+

2022-11-12
Spring Boot怎么实现请求参数校验

这篇文章主要介绍了Spring Boot怎么实现请求参数校验的相关知识，内容详细易懂，操作简单快捷，具有一定借鉴价值，相信大家阅读完这篇Spring Boot怎么实现请求参数校验文章都会有所收获，下面我们一...

99+

2022-10-19
Spring Validation怎么实现数据校验

这篇文章主要讲解了“Spring Validation怎么实现数据校验”，文中的讲解内容简单清晰，易于学习与理解，下面请大家跟着小编的思路慢慢深入，一起来研究和学习“Spring Validation怎么实现数据校验”吧...

99+

2023-07-05
Spring Validation实现数据校验的示例

目录一、什么是 Spring Validation二、实现数据校验准备相关jar包⚪Validator接口方式⚪基于注解方式（Bean Validation）⚪基于方法的方式⚪自定义...

99+

2023-03-06

Spring Validation 数据校验 Spring 数据校验
Spring/Spring Boot 中优雅地做参数校验拒绝 if/else 参数校验

数据的校验的重要性就不用说了，即使在前端对数据进行校验的情况下，我们还是要对传入后端的数据再进行一遍校验，避免用户绕过浏览器直接通过一些 HTTP 工具直接向后端请求一些违法数据。 ...

99+

2022-11-12
SpringBoot利用validation实现优雅的校验参数

目录1、前言2、常用校验3、spring boot的数据自动校验功能3.1 引入依赖3.2 构建启动类3.3 创建需要被校验的实体类3.4 在Controller中校验数据3.5 统...

99+

2022-11-13
Spring Boot使用 Hibernate-Validator校验参数时的长度校验

今天在使用Validator框架数据验证的时候碰到了三个类似的注解，都是用来限制长度，但是用法上有区别： 1，@Size和@Length @Datapublic class LoginVo { @Length(min = 5, ma...

99+

2023-09-26

spring boot hibernate java
Spring Boot参数校验及分组校验的使用教程

目录一前言1 什么是validator二注解介绍1 validator内置注解三使用1 单参数校验2&n...

99+

2022-11-12
SpringBoot使用validation做参数校验的实现步骤

1.添加依赖直接添加 hibernate-validator <dependency> <groupId>org.hibern...

99+

2022-11-12
SpringBoot如何利用validation实现优雅的校验参数

这篇“SpringBoot如何利用validation实现优雅的校验参数”文章的知识点大部分人都不太理解，所以小编给大家总结了以下内容，内容详细，步骤清晰，具有一定的借鉴价值，希望大家阅读完这篇文章能有所收获，下面我们一起来看看这篇“Spr...

99+

2023-07-02
Spring Boot项目传参校验的方法

这篇文章主要讲解了“Spring Boot项目传参校验的方法”，文中的讲解内容简单清晰，易于学习与理解，下面请大家跟着小编的思路慢慢深入，一起来研究和学习“Spring Boot项目传参校验的方法”吧！场景还原简单业务场...

99+

2023-06-29
vue+spring boot实现校验码功能

本文实例为大家分享了vue+spring boot实现校验码功能的具体代码，供大家参考，具体内容如下用vue写了一个校验码来玩玩，样子如下： 1.img标签 <img ...

99+

2022-11-12
Spring Boot项目传参校验的最佳实践指南

目录场景还原神注解加持数据异常统一拦截总结场景还原简单业务场景模拟：假如你现在在做一个成绩录入系统，你愉快地用Spring Boot框架写了一个后台接口，用于接收前台浏览器传过来...

99+

2022-11-13
详解如何在Spring Boot项目使用参数校验

开发web项目有时候我们需要对controller层传过来的参数进行一些基本的校验，比如非空，非null，整数值的范围，字符串的个数，日期，邮箱等等。最常见的就是我们直接写代码校验，这样以后比较繁琐，而且不够灵活。Bean Validati...

99+

2023-05-31

spring boot 参数校验
Spring WebFlux实现参数校验的示例代码

请求参数校验，在实际的应用中很常见，网上的文章大部分提供的使用注解的方式做参数校验。本文主要介绍 Spring Webflux Function Endpoint 使用 Spring...

99+

2022-11-12
SpringBoot 中使用 Validation 校验参数的方法详解

目录1. Validation 介绍1.1 Validation 注解1.2 @valid 和 @validated的区别2. SpringBoot 中使用 Validator 校验...

99+

2022-11-13
SpringBoot集成Validation参数校验的方法是什么

这篇“SpringBoot集成Validation参数校验的方法是什么”文章的知识点大部分人都不太理解，所以小编给大家总结了以下内容，内容详细，步骤清晰，具有一定的借鉴价值，希望大家阅读完这篇文章能有所收获，下面我们一起来看看这篇“Spri...

99+

2023-06-26
vue+spring boot如何实现校验码功能

这篇文章将为大家详细讲解有关vue+spring boot如何实现校验码功能，小编觉得挺实用的，因此分享给大家做个参考，希望大家阅读完这篇文章后可以有所收获。用vue写了一个校验码来玩玩，样子如下：img标签<img &nb...

99+

2023-06-15
spring boot 自定义starter的实现教程

spring boot 使用 starter 解决了很多配置问题, 但是, 他是怎么来解决这些问题的呢?这里通过一个简单的例子, 来看一下, starter是怎么来设置默认配置的.一. 建 starter 项目自定义的starter...

99+

2023-05-30

spring boot 自定义