Springboot 如何使用BindingResult校验参数

 更新时间:2022年01月26日 11:14:18   作者:MyXieZhiXin  
这篇文章主要介绍了Springboot 如何使用BindingResult校验参数,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

使用BindingResult校验参数

1、创建一个参数对象

import java.util.List;
import javax.validation.constraints.Min;
import javax.validation.constraints.Size;
import org.hibernate.validator.constraints.Email;
import org.hibernate.validator.constraints.NotBlank;
import org.hibernate.validator.constraints.NotEmpty;

public class Parameter {    
	@NotEmpty(message="姓名不能为空")
	private String name;
	
	@Min(value = 18, message = "年龄必须大于18岁")
	private int age;
	
	@NotEmpty(message="hobbies不能为空")
	private List<String> hobbies;
	
	@NotBlank(message="账号不能为空")
	private String account;
	
	@Size(min=5,max=10,message="密码的长度应该在5和10之间") 
	private String password;
	
	@Email(message="邮箱格式错误")
	private String email;
	
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public int getAge() {
		return age;
	}
	public void setAge(int age) {
		this.age = age;
	}
	public List<String> getHobbies() {
		return hobbies;
	}
	public void setHobbies(List<String> hobbies) {
		this.hobbies = hobbies;
	}
	public String getAccount() {
		return account;
	}
	public void setAccount(String account) {
		this.account = account;
	}
	public String getPassword() {
		return password;
	}
	public void setPassword(String password) {
		this.password = password;
	}
	public String getEmail() {
		return email;
	}
	public void setEmail(String email) {
		this.email = email;
	} 	
}

2、controller控制层写参数接收的入口

需要注意的是@Valid 和 BindingResult 是一 一对应的,如果有多个@Valid,那么每个@Valid后面都需要添加BindingResult用于接收bean中的校验信息

@RequestMapping(value = "/test", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_VALUE)
	public @ResponseBody ResponseEntity<Pesponsibles> testBindingResult(@Valid @RequestBody Parameter parameter,BindingResult bindingResult)
			{
		log.info("test start");
		Pesponsibles pesponsibles=new Pesponsibles();
		if(bindingResult.hasErrors()){
			 List<FieldError> fieldErrors = bindingResult.getFieldErrors();
			 fieldErrors.forEach(fieldError -> {
                   //日志打印不符合校验的字段名和错误提示
                   log.error("error field is : {} ,message is : {}", fieldError.getField(), fieldError.getDefaultMessage());
                 });
			 for(int i=0;i<fieldErrors.size();i++){
                    //控制台打印不符合校验的字段名和错误提示
			System.out.println("error field is :"+fieldErrors.get(i).getField()+",message is :"+fieldErrors.get(i).getDefaultMessage());
			 }
			// pesponsibles.setError_msg(fieldErrors);
			return new ResponseEntity<>(pesponsibles, HttpStatus.BAD_REQUEST);
		}
		return new ResponseEntity<>(pesponsibles, HttpStatus.OK);
	}

3、传入参数和控制台打印结果

如下图所示:

log日志编码集没有修改所以是乱码,返回结果我并没有返回错误信息,在此只是在控制台打印出来,实际情况再根据实际需要返回给前台呈现

4、常用校验注解

  • @Null 只能是null
  • @NotNull 不能为null 注意用在基本类型上无效,基本类型有默认初始值
  • @AssertFalse 必须为false
  • @AssertTrue 必须是true

字符串/数组/集合检查:(字符串本身就是个数组)

  • @Pattern(regexp="reg") 验证字符串满足正则
  • @Size(max, min) 验证字符串、数组、集合长度范围
  • @NotEmpty 验证字符串不为空或者null
  • @NotBlank 验证字符串不为null或者trim()后不为空

数值检查:同时能验证一个字符串是否是满足限制的数字的字符串

  • @Max 规定值得上限int
  • @Min 规定值得下限
  • @DecimalMax("10.8") 以传入字符串构建一个BigDecimal,规定值要小于这个值 
  • @DecimalMin 可以用来限制浮点数大小
  • @Digits(int1, int2) 限制一个小数,整数精度小于int1;小数部分精度小于int2
  • @Digits 无参数,验证字符串是否合法
  • @Range(min=long1,max=long2) 检查数字是否在范围之间 这些都包括边界值

日期检查:Date/Calendar

  • @Post 限定一个日期,日期必须是过去的日期
  • @Future 限定一个日期,日期必须是未来的日期

其他验证:

  • @Vaild 递归验证,用于对象、数组和集合,会对对象的元素、数组的元素进行一一校验
  • @Email 用于验证一个字符串是否是一个合法的右键地址,空字符串或null算验证通过
  • @URL(protocol=,host=,port=,regexp=,flags=) 用于校验一个字符串是否是合法UR

BindingResult 作用原理

controller代码

@RequestMapping("")
    public String index(@Valid User user , BindingResult bindingResult){
        if (bindingResult.hasErrors()){
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            ObjectError objectError = allErrors.get(0);
            System.out.println(objectError.getDefaultMessage());
            System.out.println(objectError.getObjectName());
            System.out.println(allErrors);
        }
        return "index";
    }

请求先来到DispatcherServlet的doDispatch 方法,最终会调用ModelAttributeMethodProcessor#resolveArgument方法

调用DataBinder#validate方法后调用ConstraintTree#validateSingleConstraint,由它来调用具体的验证器

具体的验证器

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Java随机密码生成并和邮箱、手机号匹配

    Java随机密码生成并和邮箱、手机号匹配

    这篇文章主要介绍了Java随机密码生成并和邮箱、手机号匹配的相关资料,需要的朋友可以参考下
    2016-01-01
  • 老生常谈java数组中的常见异常

    老生常谈java数组中的常见异常

    数组是用来存储一系列数据,但它往往被认为是一系列相同类型的变量,异常是程序中的一些错误,但并不是所有的错误都是异常,并且错误有时候是可以避免的,接下来让我们详细的了解吧
    2022-03-03
  • Java Chassis3的多种序列化方式支持技术解密

    Java Chassis3的多种序列化方式支持技术解密

    这篇文章主要为大家介绍了Java Chassis 3多种序列化方式支持技术解密,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2024-01-01
  • springboot+kafka中@KafkaListener动态指定多个topic问题

    springboot+kafka中@KafkaListener动态指定多个topic问题

    这篇文章主要介绍了springboot+kafka中@KafkaListener动态指定多个topic问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-12-12
  • 聊一聊new对象与Spring对bean的初始化的差别

    聊一聊new对象与Spring对bean的初始化的差别

    这篇文章主要介绍了聊一聊new对象与Spring对bean的初始化的差别,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-02-02
  • SpringBoot RestTemplate 简单包装解析

    SpringBoot RestTemplate 简单包装解析

    这篇文章主要介绍了SpringBoot RestTemplate 简单包装解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-08-08
  • Java中死锁产生的原因有哪些?

    Java中死锁产生的原因有哪些?

    这篇文章主要介绍了Java中死锁产生的原因有哪些?死锁即Dead Lock指的是两个或两个以上的运算单元,下文关于其产生的原因,需要的小伙伴可以参考一下
    2022-05-05
  • Java CharacterEncodingFilter案例详解

    Java CharacterEncodingFilter案例详解

    这篇文章主要介绍了Java CharacterEncodingFilter案例详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
    2021-08-08
  • Java 日期与时间API相关用法总结

    Java 日期与时间API相关用法总结

    这篇文章主要介绍了Java 日期与时间API相关用法总结,帮助大家更好的理解和使用Java,感兴趣的朋友可以了解下
    2021-02-02
  • linux配置java环境变量详细过程

    linux配置java环境变量详细过程

    这篇文章主要介绍了linux配置java环境变量详细过程,需要的朋友可以参考下
    2015-09-09

最新评论