Spring请求参数校验功能实例演示

更新时间：2018年05月08日 11:22:14 作者：赵彦军

这篇文章主要介绍了Spring请求参数校验功能实例演示，非常不错，具有一定的参考借鉴价值，需要的朋友参考下吧

SpringMVC支持的数据校验是JSR303的标准，通过在bean的属性上打上@NotNull、@Max等进行验证。JSR303提供有很多annotation接口，而SpringMVC对于这些验证是使用hibernate的实现，所以我们需要添加hibernate的一个validator包：

依赖引用

compile 'javax.validation:validation-api:2.0.0.Final'
compile 'org.hibernate:hibernate-validator:6.0.0.Final'

框架已经提供校验如下：

JSR提供的校验注解：

@Null   被注释的元素必须为 null
@NotNull    被注释的元素必须不为 null,不能为 null , 可以为 ""
@AssertTrue     被注释的元素必须为 true
@AssertFalse    被注释的元素必须为 false
@Min(value)     被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@Max(value)     被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@DecimalMin(value) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@DecimalMax(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@Size(max=, min=)   验证对象（Array,Collection,Map,String）长度是否在给定的范围之内
@Digits (integer, fraction)     被注释的元素必须是一个数字，其值必须在可接受的范围内
@Past   被注释的元素必须是一个过去的日期
@Future     被注释的元素必须是一个将来的日期
@Pattern(regex=,flag=) 被注释的元素必须符合指定的正则表达式

Hibernate Validator提供的校验注解：

@NotBlank(message =)   只能作用在String上，不能为null，而且调用trim()后，长度必须大于0
@Email 被注释的元素必须是电子邮箱地址
@Length(min=,max=) 被注释的字符串的大小必须在指定的范围内
@NotEmpty   被注释的字符串的必须非空，不能为 null、"",可以为 " "
@Range(min=,max=,message=) 被注释的元素必须在合适的范围内

实例演示

创建需要被校验的实体类：

package com.yiba.wifi.news.bean.model;
import org.hibernate.validator.constraints.Length;
import javax.validation.constraints.*;
public class User {
  @NotBlank(message = "用户名不能为null,长度必须大于0")
  String name;  //用户名
  @Min(value = 1, message = "最小年龄为1岁")
  @Max(value = 120, message = "最大年龄为120岁")
  Integer age; //年龄
  @Email(message = "邮箱格式错误")
  @NotBlank(message = "邮箱格式错误")  
  String email; //邮箱
  @Length(min = 6, max = 12, message = "密码长度必须在6位到12位之间")
  String pwd;//密码
  //get、set.........
}

注意在校验邮箱的时候，当 email 为 "", 或者 null 的时候，会通过 @Email验证,所以邮箱校验需要 @Email和 @NotBlank 共同起作用。

controller 接口设计，在参数接受的地方添加 @Validated 关键字

 /**
   * 登录接口
   * @return
   */
  @PostMapping("login")
  public String login(@Validated @RequestBody User user) {
    return "ok";
  }

访问测试：

当访问数据是如下格式的时候

{
 "name": "",
 "age": 0,
 "email": "",
 "pwd": ""
}

响应为：

{
 "timestamp": 1524640724522,
 "status": 400,
 "error": "Bad Request",
 "exception": "org.springframework.web.bind.MethodArgumentNotValidException",
 "errors": [
  {
   "codes": [
    "NotBlank.user.email",
    "NotBlank.email",
    "NotBlank.java.lang.String",
    "NotBlank"
   ],
   "arguments": [
    {
     "codes": [
      "user.email",
      "email"
     ],
     "arguments": null,
     "defaultMessage": "email",
     "code": "email"
    }
   ],
   "defaultMessage": "邮箱格式错误",
   "objectName": "user",
   "field": "email",
   "rejectedValue": "",
   "bindingFailure": false,
   "code": "NotBlank"
  },
  {
   "codes": [
    "NotBlank.user.name",
    "NotBlank.name",
    "NotBlank.java.lang.String",
    "NotBlank"
   ],
   "arguments": [
    {
     "codes": [
      "user.name",
      "name"
     ],
     "arguments": null,
     "defaultMessage": "name",
     "code": "name"
    }
   ],
   "defaultMessage": "用户名不能为null,长度必须大于0",
   "objectName": "user",
   "field": "name",
   "rejectedValue": "",
   "bindingFailure": false,
   "code": "NotBlank"
  },
  {
   "codes": [
    "Length.user.pwd",
    "Length.pwd",
    "Length.java.lang.String",
    "Length"
   ],
   "arguments": [
    {
     "codes": [
      "user.pwd",
      "pwd"
     ],
     "arguments": null,
     "defaultMessage": "pwd",
     "code": "pwd"
    },
    12,
    6
   ],
   "defaultMessage": "密码长度必须在6位到12位之间",
   "objectName": "user",
   "field": "pwd",
   "rejectedValue": "",
   "bindingFailure": false,
   "code": "Length"
  },
  {
   "codes": [
    "Min.user.age",
    "Min.age",
    "Min.java.lang.Integer",
    "Min"
   ],
   "arguments": [
    {
     "codes": [
      "user.age",
      "age"
     ],
     "arguments": null,
     "defaultMessage": "age",
     "code": "age"
    },
    1
   ],
   "defaultMessage": "最小年龄为1岁",
   "objectName": "user",
   "field": "age",
   "rejectedValue": 0,
   "bindingFailure": false,
   "code": "Min"
  }
 ],
 "message": "Validation failed for object='user'. Error count: 4",
 "path": "/yiba/sms/login"
}

可以看到本地请求，4个字段校验都没通过，那么我有没有办法获取异常信息呢，答案是有的，需要我们修改 controller 接口。

 /**
   * 登录接口
   *
   * @return
   */
  @PostMapping("login")
  public String login(@Validated @RequestBody User user, BindingResult bindingResult) {
    if (bindingResult.hasErrors()) {
      //有校验没通过
      List<ObjectError> errorList = bindingResult.getAllErrors();
      for (ObjectError error : errorList) {
        System.out.println(error.getDefaultMessage()); //输出具体的错误信息
      }
      return "参数异常";
    }
    return "ok";
  }

再次请求，请求格式如下

{
 "name": "",
 "age": 0,
 "email": "",
 "pwd": ""
}

响应如下

参数异常

在控制台打印的信息如下：

用户名不能为null,长度必须大于0
密码长度必须在6位到12位之间
最小年龄为1岁
邮箱格式错误

可以看到我们已经正常的获取到了校验信息了。

下面我们来做一次参照正确的访问：

请求参数如下：

{
 "name": "zhaoyanjun",
 "age": 1,
 "email": "362299465@qq.com",
 "pwd": "123456"
}

响应如下：

ok

控制台什么也没输出。

总结

以上所述是小编给大家介绍的Spring请求参数校验功能实例演示，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对脚本之家网站的支持！

spring framework源码调试技巧
这篇文章给大家介绍了spring-framework源码调试方法，可以直接将最新代码clone到本地，如果想在代码做一些注释，也可以Fork到自己的仓库。本文采用Fork的方式，并添加了测试module，感兴趣的朋友一起看看吧
2021-10-10
IDEA2023常用配置指南(JDK/系统设置等常用配置)
idea很强大,但是初次安装默认的有很多设置并不是满足我们开发的需要,下面这篇文章主要给大家介绍了关于IDEA2023常用配置(JDK/系统设置等常用配置)的相关资料,需要的朋友可以参考下
2023-12-12
Java循环结构之多重循环及continue break
这篇文章主要介绍了Java循环结构之多重循环及continue break，文章围绕主题展开详细的内容介绍，具有一定的参考价值，需要的朋友可以参考一下
2022-09-09
Java编程接口详细
这篇文章主要小编主要给大家讲解的是Java编程中的接口，文章会从抽象类和抽象方法开始展开内容，感兴趣的小伙伴可以参考下面文章的具体内容
2021-10-10
java编程题之合并两个排序的链表
这篇文章主要为大家详细介绍了java编程题之合并两个排序的链表，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-03-03
Java数据结构中堆的向下和向上调整解析
堆是一颗完全二叉树，在这棵树中，所有父节点都满足大于等于其子节点的堆叫大根堆，所有父节点都满足小于等于其子节点的堆叫小根堆。堆虽然是一颗树，但是通常存放在一个数组中，父节点和孩子节点的父子关系通过数组下标来确定
2021-11-11
Java Scala之模式匹配与隐式转换
在Java中我们有switch case default这三个组成的基础语法，在Scala中我们是有match和case组成 default的作用由case代替，本文详细介绍了Scala的模式匹配与隐式转换，感兴趣的可以参考本文
2023-04-04
解决JTable排序问题的方法详解
本篇文章是对JTable排序问题的方法进行了详细的分析介绍，需要的朋友参考下
2013-05-05
Java利用反射获取object的属性和值代码示例
这篇文章主要介绍了Java利用反射获取object的属性和值代码示例，具有一定借鉴价值，需要的朋友可以参考下。
2017-12-12
关于kafka发送消息的三种方式总结
这篇文章主要介绍了关于kafka发送消息的三种方式总结，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-04-04