Springboot 参数校验@Valid @Validated（最新最全）

置顶 已于 2022-10-29 21:47:03 修改
阅读量870 收藏 5
点赞数 1
文章标签： spring boot 后端
于 2022-10-29 21:45:12 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xiejianweifdd/article/details/127592012
版权

Springboot 参数校验@Valid @Validated（最新最全）

提示：统一参数校验，异常处理

文章目录

前言

表单提交，后端做数据校验

一、统一参数校验(普通)

1.引入依赖

提示：实操过程发现，引入validation-api 不好使，需要引入hibernate-validator

依赖如下：

       <!-- 自定义注解
         <dependency>
            <groupId>javax.validation</groupId>
            <artifactId>validation-api</artifactId>
        </dependency>
         -->
        <dependency>
            <groupId>org.hibernate.validator</groupId>
            <artifactId>hibernate-validator</artifactId>
        </dependency>

2.创建Control

如下：

package com.xjw.mytest.control;

import com.alibaba.fastjson.JSONObject;
import org.springframework.validation.annotation.Validated;
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 javax.validation.Valid;

@RestController
@RequestMapping("/user")
public class UserControl {

    @PostMapping("/add")
    public R add(@Valid @RequestBody UserDto data) {
        System.out.println("data is "+ JSONObject.toJSONString(data));
        return R.ok();
    }

}

2.创建Advice

如下：

package com.xjw.mytest.control;

import org.springframework.validation.BindingResult;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import java.util.HashMap;
import java.util.Map;

@RestControllerAdvice(basePackages = "com.xjw")
public class ExceptionControllerAdvice {

    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public R handleVaildException(MethodArgumentNotValidException e) {

        BindingResult bindingResult = e.getBindingResult();

        Map<String, String> errorMap = new HashMap<>();

        bindingResult.getFieldErrors().forEach(bean->{
            errorMap.put(bean.getField(), bean.getDefaultMessage());
        });

        return  R.error("400", "数据校验问题").put("data",errorMap);
    }

    @ExceptionHandler(value = Exception.class)
    public R handleVaildException(Exception e) {
        return  R.error("500", "系统内部错误");
    }
}

3.统一返回参数

如下：


package com.xjw.mytest.control;

import java.util.HashMap;
import java.util.Map;


import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.TypeReference;

/**
 * 返回数据
 */
public class R extends HashMap<String, Object> {

	/** 未知异常 **/
	public static final String UN_KNOW_ERROR = "-1";
	
	public static final String SUCCESS_CODE = "200";// 成功
	
	public static final String ERROR_CODE = "500";// 失败


	public static final String MSG_SUCESS = "success";
	public static final String MSG_ERROR = "error";

	public static final String DATA = "data";
	public static final String DATAS = "datas";
	public static final String CODE = "code";
	public static final String MSG = "message";
	private static final long serialVersionUID = 1L;

	public <T> T getData(String key, TypeReference<T> typeReference) {
		Object data = get(key);
		String s = JSON.toJSONString(data);
		return JSON.parseObject(s, typeReference);
	}

	public <T> T getData(TypeReference<T> typeReference) {
		Object data = get(DATA);
		String s = JSON.toJSONString(data);
		return JSON.parseObject(s, typeReference);
	}

	public R setData(Object data) {
		put(DATA, data);
		return this;
	}
	
	public R setDatas(Object data) {
		put(DATAS, data);
		return this;
	}

	public R() {
		put(CODE, SUCCESS_CODE);
		put(MSG, MSG_SUCESS);
	}

	public static R error(String code) {
		return error(code, MSG_ERROR);
	}

	public static R error(String code, String msg) {
		R r = new R();
		r.put(CODE, code);
		r.put(MSG, msg);
		return r;
	}

	public static R ok(String msg) {
		R r = new R();
		r.put(CODE, SUCCESS_CODE);
		r.put(MSG, msg);
		return r;
	}

	public static R ok(Map<String, Object> map) {
		R r = new R();
		r.putAll(map);
		return r;
	}

	public static R ok() {
		R r = new R();
		r.put(CODE, SUCCESS_CODE);
		r.put(MSG, MSG_SUCESS);
		return r;
	}

	public R put(String key, Object value) {
		super.put(key, value);
		return this;
	}

	public Integer getCode() {
		return (Integer) this.get(CODE);
	}

	public String getmsg() {
		return (String) this.getOrDefault(MSG, "");
	}

	public String getcode() {
		return (String) this.getOrDefault(CODE, "");
	}

}

4.创建Dto

如下：

package com.xjw.mytest.control;

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Null;

public class UserDto {

    private String id;
    @NotNull(message = "名称不能为空"})
    private String userName;
    @NotNull(message = "年龄不能为空")
    private Integer age;
    private Integer status;
 }

二、统一参数校验(分组)

提示：就是创建两个空接口

1.创建分组接口

代码如下（示例）：

package com.xjw.mytest.control;

public interface AddGroup {
}


package com.xjw.mytest.control;

public interface UpdateGroup {
}

2.创建Control

提示：接口中的注解修改了，修改@Validated(value = {AddGroup.class})
代码如下（示例）：

package com.xjw.mytest.control;

import com.alibaba.fastjson.JSONObject;
import org.springframework.validation.annotation.Validated;
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 javax.validation.Valid;

@RestController
@RequestMapping("/userGroup")
public class UserGroupControl {

    @PostMapping("/add")
    public R add(@Validated(value = {AddGroup.class}) @RequestBody UserDto data) {
        System.out.println("data is "+ JSONObject.toJSONString(data));
        return R.ok();
    }

    @PostMapping("/update")
    public R update(@Validated(value = {UpdateGroup.class}) @RequestBody UserDto data) {
        System.out.println("data is "+ JSONObject.toJSONString(data));
        return R.ok();
    }

}

3.修改Dto

提示：Dto中的注解修改了，增加了Control
代码如下（示例）：

package com.xjw.mytest.control;

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Null;

public class UserDto {

    @NotNull(message = "新增必须为空", groups = {AddGroup.class})
    @Null(message = "更新必须不为空", groups = {UpdateGroup.class})
    private String id;
    @NotNull(message = "名称不能为空", groups = {AddGroup.class, UpdateGroup.class})
    private String userName;
    @NotNull(message = "年龄不能为空",groups = {AddGroup.class, UpdateGroup.class})
    private Integer age;
    private Integer status;
}

二、统一参数校验(自定义注解)

提示：就是创建两个空接口

1.创建注解类

代码如下（示例）：

package com.xjw.mytest.control;


import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

@Documented
@Constraint(validatedBy = {ListValueConstraintValidator.class })
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {

    String message() default "{com.xjw.validation.listValue.message}";

    Class<?>[] groups() default { };

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

    int[] vals() default {};
}

2.创建校验器

提示：接口中的注解修改了，修改@Validated(value = {AddGroup.class})
代码如下（示例）：

package com.xjw.mytest.control;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.HashSet;
import java.util.Set;

public class ListValueConstraintValidator implements ConstraintValidator<ListValue, Integer> {

    private Set<Integer> set = new HashSet<>();

    //初始化方法（设置注解中的只，例如状态（1，2）此时就可以获取注解中的1，2）
    @Override
    public void initialize(ListValue constraintAnnotation) {
        int[] vals = constraintAnnotation.vals();
        for (int val : vals){
            set.add(val);
        }
    }
    // 校验是否成功
    /**
     * value 就是提交上来的数据
     * @param value object to validate
     * @param context context in which the constraint is evaluated
     *
     * @return
     */
    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {
        return set.contains(value);
    }
}

3.添加配置文件

提示：文件名称ValidationMessages.properties ，路径resources下
代码如下（示例）：

com.xjw.validation.listValue.message = 必须提交指定值

3.修改Dto

提示：文件名称ValidationMessages.properties ，路径resources下
代码如下（示例）：

package com.xjw.mytest.control;

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Null;

public class UserDto {

    @NotNull(message = "新增必须为空", groups = {AddGroup.class})
    @Null(message = "更新必须不为空", groups = {UpdateGroup.class})
    private String id;
    @NotNull(message = "名称不能为空", groups = {AddGroup.class, UpdateGroup.class})
    private String userName;
    @NotNull(message = "年龄不能为空",groups = {AddGroup.class, UpdateGroup.class})
    private Integer age;

    @ListValue(vals = {1,2}, groups = {AddGroup.class})
    private Integer status;
}

在这里插入图片描述
提示：如果ValidationMessages.properties 中的提示信息乱码，可以如下处理

在这里插入图片描述

总结

例如：以上三种校验规则基本满足日常开发中的各种表单校验规则

xiejianweifdd
关注
  • 1
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Springboot使用@Validated（优雅的代码）
余生一个帆的博客
10-28 2526
背景 回忆一下我们没用使用过@Validated时： 上图是controller层，新增用户信息接口，为了校验参数合法性，真是费了好多 if else 判断，代码可读性较差，开发效率还很低，想想都很头疼啊！！！ 用什么好的解决办法吗？ 写这么多 if else 我也很烦，很累，很不开心！ 答案是有的，俗话说办法总比困难多，接下来我们就走进 Validation 的世界 。。。 使用注解 @Validated 后我们接口的样子： 有没有感觉清爽很多，说了这么多，大家也对比了，到底这个注解是干嘛的呢，如何
SpringBoot之表单验证@Valid
weixin_33682790的博客
03-27 358
转自：https://www.cnblogs.com/chenlove/p/8708627.html SpringBoot提供了强大的表单验证功能实现，给我们省去了写验证的麻烦；   这里我们给下实例，提交一个有姓名和年龄的表单添加功能， 要求姓名不能为空，年龄必须是不小于18 ；   我们先新建一个Student实体 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15...
springboot@Valid注解用法详解
最新发布
2401_85358306的博客
07-17 340
Java架构学习技术内容包含有：Spring，Dubbo，MyBatis, RPC, 源码分析，高并发、高性能、分布式,性能优化，微服务 高级架构开发等等。还有Java核心知识点+全套架构师学习资料和视频+一线大厂面试宝典+面试简历模板可以领取+阿里美团网易腾讯小米爱奇艺快手哔哩哔哩面试题+Spring源码合集+Java架构实战电子书+2021年最新大厂面试题。
SpringBoot—@Validated
l_010的博客
06-14 904
SpringBoot—@Validated
springboot中注解校验@Valid@Validated(亲测有效)
weixin_43401380的博客
09-01 5477
1.校验步骤说明 1.请求对象上添加注解@RequestBody @Vlid(源自javax.validation.Valid); 2,对象实体类中添加相关校验注解(源于javax.validation.constraints). 2.示例说明 1.请求类 package com.kawaxiaoyu.api.appointCourse.controller; import com.kawaxiaoyu.api.appointCourse.dto.ApplyInfoDto; import c
springboot中@Validated注解
Tang_IT的博客
07-02 793
一般@Validated注解用于数据校验 注意:使用@Email等注解爆红,原因是新版本需要引入validation启动器 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> </dependency> 例如以下实体类Person @Data
Springboot参数校验@Validated和@Valid区别源码
11-22
Springboot参数校验@Validated和@Valid区别源码
Spring Boot技术知识点：如何使用@Valid注解来对邮箱字段进行数据校验
07-04
当在方法参数上使用`@Valid`时，Spring MVC会调用对应的Validator来检查该参数，确保其满足预定义的校验规则。 2. **如何创建验证规则**： 我们可以通过在模型类的属性上添加各种验证注解来定义校验规则。例如，...
springboot validator枚举值校验功能实现
08-25
在 Spring Boot 项目中，校验参数功能是一个非常重要的组件，可以帮助我们确保用户输入的数据是否合法。如果我们想校验枚举值，那么 Spring Boot Validator 就是一个不错的选择。本文将主要介绍如何使用 Spring Boot...
Springboot集成JSR303参数校验的方法实现
10-16
Spring Boot集成JSR303参数校验的方法实现涉及了Java中参数校验的标准规范，即JSR303（Bean Validation）规范，该规范通过在Java对象属性上添加注解来实现数据校验的约束定义。这种方式能够将校验逻辑与业务逻辑分离...
Springboot 自定义校验代码实例
08-25
此外，注解还包含了一些基本的参数，如错误消息、起始字符串、验证组和负载。 ```java @Documented @Constraint(validatedBy = StartWithValidator.class) @Target({METHOD, FIELD}) @Retention(RUNTIME) public @...
Spring Validation最佳实践及其实现原理，参数校验没那么简单！
伍六七
08-03 2851
之前也写过一篇关于Spring Validation使用的文章，不过自我感觉还是浮于表面，本次打算彻底搞懂Spring Validation。本文会详细介绍Spring Validation各种场景下的最佳实践及其实现原理，死磕到底！ 项目源码：spring-validation 简单使用 Java API规范(JSR303)定义了Bean校验的标准validation-api，但没有提供实现。hibernate validation是对这个规范的实现，并增加了校验注解如@Email、@Length等。S
springboot中@Valid使用
Jerry-blog
01-02 7887
日常接口中，我们需要校验字符串是否为空等操作，需要在接口中使用StringUtils.isBlank(str)之类的方法校验，但 是如果过多的字符串，我们需要些大量的校验代码，代码十分臃肿繁琐无味，现在，我们把这项工作交给spring 去做。使用@Valid去校验。 首先我们使用一个实体类接收接口中传入的参数。 实体类如下： public class ResultInput { /** ...
SpringBoot 使用@Validated实现参数校验
一个肥鲇鱼博客
11-17 1747
做Web开发有一点很烦人就是要校验参数，基本上每个接口都要对参数进行校验，比如一些格式的非空校验，规则校验都是必不可少的。如果参数比较少的话还是容易的无伤大雅但参数比较多了的话代码中就会出现大量的if-else
springboot 参数校验之@validated
qq_36090537的博客
07-21 204
@validated使用
SpringBoot使用Validation校验参数
weixin_42495787的博客
07-22 2706
SpringBoot使用Validation校验参数
Spring Boot 利用 @Valid 数据校验
.
06-25 3371
SpringBoot 提供数据校验 通常情况下我们手动的进行判断，这样子很是麻烦，代码量显得很是繁琐，springboot为我们进行简化工作量。 基于 Hibernate Validator 提供了 JSR 规范中所有内置约束注解的实现，以及一些附加的约束注解，除此之外用户还可以自定义约束注解。 Spring Boot 的参数校验依赖于 hibernate-validator 来进行。使用 Hib...
Spring Boot @Validated 校验
椰汁菠萝
05-07 401
spring boot 1.4默认使用 hibernate validator 5.2.4 Final实现校验功能。hibernate validator 5.2.4 Final是 JSR 349 Bean Validation 1.1的具体实现。 一 初步使用 hibernate vilidator主要使用注解的方式对bean进行校验，初步的
SpringBoot 表单验证@Valid
m0_37732829的博客
12-26 545
       最近在做项目的时候，需要对调用方传递过来的JSON格式数据项做验证，用来防范小白搞乱网站和一些低级的黑客技术。SpringBoot提供了强大的表单验证功能实现。即校验用户提交的数据的合理性的，比如是否为空了，年龄必须是不小于18 ，是否是纯数字等等。为了项目的优化，可以为每个调用方表单创建下面是我的 import org.hibernate.validator.constrain...
springboot项目@valid 无法校验list怎么解决
06-07
在 Spring Boot 项目中，@Valid 注解可以用来校验请求参数。如果您想要校验一个 List 对象，可以使用 @Valid 注解和 @Validated 注解来实现。 具体来说，您可以在 List 对象前面加上 @Valid 注解，然后在 ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值