https://www.cnblogs.com/funyoung/p/8670550.html

https://www.cnblogs.com/monkeydai/p/10068547.html

Hello@

两粒种子,一片森林.

随笔 - 21  文章 - 0  评论 - 8

SpringMVC参数校验

 

使用SpringMVC时配合hibernate-validate进行参数的合法性校验,能节省一定的代码量。

1.搭建Web工程并引入hibernate-validate依赖

<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.7.Final</version>
</dependency>

Maven依赖传递,自动依赖validation-api、jboss-logging、classmate。

2.使用校验注解标注在属性上(DTO)

*每个注解都有message属性,该属性用于填写校验失败时的异常描述信息,当校验失败时可以获取对应的message属性值。

按 Ctrl+C 复制代码
按 Ctrl+C 复制代码

3.控制层中使用DTO接收参数并使用@Validated/@Valid注解开启对参数的校验

 

*@Validated注解表示开启Spring的校验机制,支持分组校验,声明在入参上。

*@Valid注解表示开启Hibernate的校验机制,不支持分组校验,声明在入参上。

*在DTO后面紧跟BindingResult对象,那么当参数不符合时,能通过该对象直接获取不符合校验的message描述信息。

*若使用了@Validated/@Valid注解开启校验,但DTO后面没有紧跟BindingResult对象,那么当参数不符合时,将直接返回400 Bad Request状态码。

按 Ctrl+C 复制代码
按 Ctrl+C 复制代码

演示:

结果:

密码不能为空!
id不能为空!
用户名的长度在4~12之间!

*校验的顺序是随机的,因此程序不能依赖校验的顺序去做相关的逻辑处理。

4.分组校验

每个校验注解都有group属性用于指定校验所属的组,其值是Class数组,在Controller中使用@Validated注解开启对参数的校验时若指定要进行校验的组,那么只有组相同的属性才会被进行校验(默认全匹配)

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

一般定义标识接口作为组资源

public interface GroupA {

}

public interface GroupB {

}

使用校验注解标注在属性上并进行分组

public class User {

    @NotNull(message="id不能为空!",groups = {GroupA.class})
private Integer id; @NotBlank(message="用户名不能为空!",groups = {GroupB.class})
@Size(min=4,max=12,message="用户名的长度在4~12之间!")
private String username; @NotBlank(message="密码不能为空!")
private String password; @Email(message="非法邮箱!")
private String email; public Integer getId() {
return id;
} public void setId(Integer id) {
this.id = id;
} public String getUsername() {
return username;
} public void setUsername(String username) {
this.username = username;
} 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;
} public User() {
super();
} }

Controller中使用@Validated注解开启对参数的校验并指定校验的组,那么只有组相同的属性才会被进行校验(默认全匹配)

@RestController
public class BaseController { @RequestMapping("/test")
public User test(@Validated(value= {GroupB.class}) User user, BindingResult result) {
if (result.hasErrors()) {
List<ObjectError> errors = result.getAllErrors();
for (ObjectError error : errors) {
System.out.println(error.getDefaultMessage());
}
}
return user;
} }

演示:

结果:

用户名不能为空!

*后端一般只返回重名等错误描述信息,对于非空、字符长度、手机邮箱合法性校验等由前端进行判断并提示,后端校验不通过时不返回错误描述信息,所以不需要使用BindingResult获取错误描述,当参数不符合时直接返回400 Bad Request请求。

spring mvc 参数校验

                  spring mvc中的参数校验

spring mvc 支持jsr-303 Bean验证框架,默认实现是使用的Hibernate validator。在spring mvc中只需要使用@Validated注解在方法参数上即可对参数对象进行校验。校验结果放在BindingResult中,所以每个被校验的参数后面都需要放一个BindingResult。

因为有时候并不是所有的地方需要的验证都是一样的,例如更新的时候需要id notnull,而插入的时候确需要id为null,所以验证的时候在每个验证条件中都增加了groups属性,用于标识需要哪种校验,而在@validated中可以设置vlue属性,用于和验证条件中的groups配合使用,只有@Validated中的value类型和验证注解中的groups属性一致的时候才进行校验。

JSR-303提供的常用的校验注解主要有以下几类 

空类型检查
@Null验证对象必须为空 @NotNull验证对象不能为空 @NotBlank 验证对象不能为空字符串 @NotEmpty 验证对象不能为空,集合类型不能为空 长度检查
@Size(min= ,max=) 验证对象长度,支持字符串和集合 @Length 验证字符串长度 数值检查
@Max 验证数字大小是否小于某个数值 @Min 验证数字大小是否大于某个数值 @Digits 验证数字是否符合某个格式例如:整数3为,小数2位 @Range 验证数值是否在某个范围之内 其他检查
@Email 验证是否位邮件格式,若为null则不做校验
@Pattern 验证是否符合正则表达式规则

例子

  在controller中使用@Validated注解

    

 1 @Controller
2 @RequestMapping("valid")
3 @Slf4j
4 public class ValidateController {
5
6 private static final String BASE_PATH = "/valid/";
7
8 @RequestMapping("index")
9 public String index(@Validated() Student student,BindingResult result){
10 if(result.hasErrors()){
11 StringBuffer sb = new StringBuffer();
12 List<FieldError> errorList = result.getFieldErrors();
13 errorList.stream().forEach(error->{
14 String message = error.getDefaultMessage();
15 String field = error.getField();
16 sb.append(field).append(":").append(message).append(",");
17 });
18 log.error(sb.toString());
19 }
20
21 return BASE_PATH + "index";
22 }
23 }

    在bean中使用验证注解

@Data
public class Student { @Length(max = 32,min = 32,groups = {})
private String id; @NotNull
@Size(max = 50)
private String name; @Max(100)
@Min(12)
@NotNull
private Integer age; @Email
@NotNull
private String email; @AssertFalse
private Boolean isLeader; @WorkOverTime
private String workOverTime;
}

  这样在前台请求该方法的时候就会进行自动校验。而校验结果会保存在BindingResult中。可以通过hasErrors判断校验是否通过,getFieldErrors可以获取所有的错误。

自定义参数校验

  有的时候自带的参数校验类型并不能满足我们的需求,这时我们可以自定校验注解。

  定义自定义注解类:

    

@Constraint(validatedBy = {ValidatedWorkOverTime.class})
@Documented
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface WorkOverTime { String message() default "加班时长不能超过{max}小时"; int max() default 5; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {};
}

在这个类中我们使用Constraint注解声明我们需要使用哪个类来进行具体的验证。

注解类中必须包含1.错误信息。即message方法,2.验证规则分组,即gourps方法,3.验证的有效负荷即payload方法。

我们还必须实现一个类来进行具体的验证。即上面Constraint声明的类。

@Slf4j
public class ValidatedWorkOverTime implements ConstraintValidator<WorkOverTime,Object> { private Integer max; private WorkOverTime workOverTime; @Override
public void initialize(WorkOverTime constraintAnnotation) {
this.max = constraintAnnotation.max();
this.workOverTime = constraintAnnotation;
} @Override
public boolean isValid(Object integer, ConstraintValidatorContext constraintValidatorContext) {
Integer overWorkTime = Integer.MAX_VALUE;
if(integer instanceof Integer){
overWorkTime = (Integer) integer;
}else{
try {
overWorkTime = Integer.parseInt(integer.toString());
}catch (Exception e){
log.error(e.toString(),e);
if(e instanceof NumberFormatException){ }
}
}
return max>overWorkTime;
}
}

这样我们就可以在bean中的属性中使用@WorkOverTime注解来进行参数校验了。

 
 
 
 
 
 
 

实用———springmvc接收参数校验的更多相关文章

  1. springMVC接收参数的区别form data与query string parameters与request payload

    在AJAX请求中,我见过有三种form表单数据类型提交. 第一种:form data, 第二种:query string parameters,第三种:request payload. 在google ...

  2. springmvc接收参数

    springmvc执行流程 搭建ssm框架:http://www.cnblogs.com/liyafei/p/7955413.html 1:从表单中接收 普通请求参数 结构目录 role.html 1 ...

  3. springMVC接收参数 xml/json

    springMVC参数接收 作为web层框架,可以接受复杂的类型,且很简单 1.接收字符串可以直接写参数类型,参数名称,跟前端传过来的name值一样即可 如果不一样也可以,通过@RequestPara ...

  4. springmvc接收参数为日期类型

    用单个Date类型接收日期类型时,会出现报错,加上initBinder的方法 意思是将所有传入的参数都通过此方法,如果过是日期通过日期格式化器进行格式化 如果是接收类型为对象内的属性为Date类型时 ...

  5. springMVC接收参数的几种方式

    Spring3 MVC请求参数获取的几种方法 一.      通过@PathVariabl获取路径中的参数 @RequestMapping(value="user/{id}/{name}&q ...

  6. SpringMVC接收参数的注解笔记

    1.@RequestParam var param = {}; param.keys = delKeys.join();//delKeys是数组,如delKeys=['a',b','c'],join函 ...

  7. springMVC 接收数组参数,mybatis 接收数组参数,mybatis批量插入/批量删除案例

    案例是给一个用户赋予多个权限,多个权限用其对应的主键 id 为参数,组成了 一个id数组,传给springMVC,然后springMVC传给mybatis,然后mybatis批量插入.其实类似的场景还 ...

  8. SpringMVC框架笔记01_SpringMVC的使用案例和架构组件_SpringMVC和Mybatis整合_接收参数

    目录 第1章:SpringMVC简介 1.1 什么是SpringMVC 1.2 SpringMVC的处理流程 第2章:SpringMVC入门程序 2.1 场景描述 2.2 步骤分析 2.3 步骤一:创 ...

  9. SpringMVC接受参数若干问题

    最近2年在工作问题总结中,好几次遇到了SpringMVC接收参数的问题,今天特别总结下.  SpringMVC接收参数的方法:  Html参数输入: <input name="stat ...

随机推荐

  1. mysql使用过程中出现的问题总结

    1.mysql命令窗口输入密码后窗口闪退 密码输入错误.(其他暂不清楚) 2. 出现这个错误的原因是,数据库的编码格式不一致. https://www.cnblogs.com/lsr-flying/p ...

  2. artillery强大灵活的负载测试套件

    artillery是基于nodejs 编写的负载测试套件支持http&&socket.io&&websockets&&kinesis&& ...

  3. GoCN每日新闻(2019-11-04)

    GoCN每日新闻(2019-11-04) GoCN每日新闻(2019-11-04)   1. Go中垃圾收集器是如何标记内存的 https://medium.com/a-journey-with-go ...

  4. 前端微服务初试(singleSpa)

    1.基本概念 实现一套微前端架构,可以把其分成四部分(参考:https://alili.tech/archive/11052bf4/) 加载器:也就是微前端架构的核心,主要用来调度子应用,决定何时展示 ...

  5. 面试官问线程安全的List,看完再也不怕了!

    最近在Java技术栈知识星球里面有球友问到了线程安全的 List: 扫码查看答案或加入知识星球 栈长在之前的文章<出场率比较高的一道多线程安全面试题>里面讲过 ArrayList 的不安全 ...

  6. SpringBoot(3)自定义Filter

    SpringBoot自动添加了OrderedCharacterEncodingFilter和HiddenHttpMethodFilter,当然我们可以自定 义Filter. 自定义Filter需要两个 ...

  7. Linux-Centos学习笔记

    Linux目录结构: 只有1个目录,根目录 usr:相当于program files etc:存放系统配置文件 root:系统管理员默认目录 home:存放其他用户的目录 pwd: 打印当前目录 cd ...

  8. CentOS 使用官方源yum安装最新nginx版本

    CentOS 使用官方源yum安装最新nginx版本 1.创建nginx.repo # vi /etc/yum.repos.d/nginx.repo 2.添加内容#如果是CentOS6,文件内容如下: ...

  9. 650. Find Leaves of Binary Tree

    class Solution { public: vector<vector<int>> findLeaves(TreeNode* root) { vector<vect ...

  10. UltraISO安装windows10时0x8007000D错误解决办法

    进入安装界面之后提示错误:windows无法打开所需的文件 F:\Sources\install.wim.请确保安装所需的所有文件可用,并重新启动安装.错误代码:0x8007000D 原因: 肯定是i ...