全网最简单：Spring Boot + validation + AOP 请求参数校验

前言：之前发的文章评论中，很多小伙伴说希望我写一篇关于Spring Boot + validation + AOP 请求参数校验的文章，以便于各位小伙伴更好的学习（哈哈哈，说不上学习，当作个参考也是蛮好的）。咱们话不多说，直接上干货。

一、validation 校验注解

通用

@Null 被注释的属性必须为 null

@NotNull被注释的属性必须不为 null

@AssertTrue 被注释的属性必须为 true

@AssertFalse 被注释的属性必须为 false

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

@Pattern(regexp="reg") 验证字符串满足正则

@Size(max, min) 验证字符串、数组、集合长度范围

@NotEmpty 验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）

@NotBlank 验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格

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

@Min(value) 被注释的属性必须是一个数字，其值必须大于等于指定的最小值

@Max(value) 被注释的属性必须是一个数字，其值必须小于等于指定的最大值

@DecimalMin(value) 被注释的属性必须是一个数字，其值必须大于等于指定的最小值

@DecimalMax(value)被注释的属性必须是一个数字，其值必须小于等于指定的最大值

@Size(max=, min=) 被注释的属性的大小必须在指定的范围内

@Digits(integer, fraction) 被注释的属性必须是一个数字，其值必须在可接受的范围内

@Pattern(regex=,flag=) 被注释的属性必须符合指定的正则表达式

日期检查：Date/Calendar

@Past 限定一个日期，日期必须是过去的日期

@Future 限定一个日期，日期必须是未来的日期

Hibernate Validator 附加的 constraint

@Email 被注释的属性必须是电子邮箱地址

@Length(min=,max=)被注释的字符串的大小必须在指定的范围内

@Range(min=,max=,message=) 被注释的属性必须在合适的范围内

二、依赖

代码展示如下

org.springframework.boot

spring-boot-starter-web

org.springframework.boot

spring-boot-starter-aop

三、代码实例

1.SpmkApproveSummaryDto.java 用 validation 校验

代码展示如下：

import java.util.List;

import javax.validation.constraints.DecimalMax;

import javax.validation.constraints.DecimalMin;

import javax.validation.constraints.NotBlank;

import javax.validation.constraints.NotNull;

import cn.hutool.json.JSONObject;

import io.swagger.annotations.ApiModelProperty;

import lombok.AllArgsConstructor;

import lombok.Builder;

import lombok.Data;

import lombok.NoArgsConstructor;

/**

* 审批汇总

*/

@Data

@Builder

@NoArgsConstructor

@AllArgsConstructor

public class SpmkApproveSummaryDto{

@NotBlank(message = "title为空")

@ApiModelProperty(value = "标题 ", example = "标题", required = true)

private String title;

@NotBlank(message = "approveName为空")

@ApiModelProperty(value = "审批名称 ", example = "审批名称", required = true)

private String approveName;

@NotBlank(message = "initiator为空")

@ApiModelProperty(value = "发起人名称 ", example = "发起人名称", required = true)

private String initiator;

@NotNull(message = "assoType为空")

@DecimalMax(value = "9",message = "assoType 只能为 0无 1转正 2离职 3调岗 4加班 5请假 6出差 7外出 8补卡 9调薪")

@DecimalMin(value = "0",message = "assoType 只能为 0无 1转正 2离职 3调岗 4加班 5请假 6出差 7外出 8补卡 9调薪")

@ApiModelProperty(value = "关联类型 0无 1转正 2离职 3调岗 4加班 5请假 6出差 7外出 8补卡 9调薪", example = "1")

private Integer assoType;

@NotNull(message = "requestData为空")

@ApiModelProperty(value = "申请数据 ", example = "申请数据", required = true)

private JSONObject requestData;

@NotNull(message = "froms为空")

@ApiModelProperty(value = "审批表单 ", example = "数组", required = true)

private List froms;

@NotNull(message = "router为空")

@ApiModelProperty(value = "审批流程", example = "审批流程", required = true)

private Router router;

}

2.ValidationError.java 校验错误提示类

代码展示如下：

import lombok.AllArgsConstructor;

import lombok.Builder;

import lombok.Data;

import lombok.NoArgsConstructor;

@Data

@Builder

@NoArgsConstructor

@AllArgsConstructor

public class ValidationError {

private String field;

private String msg;

}

代码看完是不是觉得非常简单,我们来看下一个

3.controller类

代码展示如下：

/**

* 发起审批

* @throws Exception

*/

@PostMapping(value = "/start_approval")

public Result saveCa(@Valid @RequestBody SpmkApproveSummaryDto spmkApproveSummaryDto,BindingResult bindingResult) throws Exception{

// 判断校验结果 bindingResult，hasErrors 为 true 则解析 返回给前端 校验错误提示信息

if(bindingResult != null && bindingResult.hasErrors()){

List ls = bindingResult.getAllErrors();

// 创建List 存放 校验错误提示信息

List listVe = new ArrayList();

ValidationError ve;

for (ObjectError one : ls) {

String fieldString = one.getCodes().length >= 1 ? one.getCodes()[0] : "";

if (fieldString != null) {

fieldString = fieldString.substring(fieldString.lastIndexOf(".") + 1);

}

ve = ValidationError.builder().field(fieldString).msg(one.getDefaultMessage()).build();

listVe.add(ve);

}

// 返回 校验校验错误提示信息

return ResultUtil.error(listVe);

}

// 业务逻辑省略

// ...

}

3.1.调试

如下图：

3.2.校验失败 返回数据

代码展示如下：

{

"code": "400",

"data": [

{

"field": "assoType",

"msg": "assoType为空"

},

{

"field": "title",

"msg": "title为空"

}

],

"message": "参数错误",

"result": true,

"timestamp": 1588867983720

}

在此，我们要注意以下三点：

@Valid和BindingResult配套使用，@Valid用在参数前，BindingResult作为校验结果绑定返回

后端通过对 BindingResult 校验结果 的 再次解析和封装为 ValidationError列表 再返回给 客户端

如果不设置 BindingResult 参数, 校验失败后 后端会直接 返回BindingResult校验结果,错误提示 有冗余

4.不设置 BindingResult 参数

代码展示如下：

/**

* 发起审批

* @throws Exception

*/

@PostMapping(value = "/start_approval")

public Result saveCa(@Valid @RequestBody SpmkApproveSummaryDto spmkApproveSummaryDto) throws Exception{

// ...

// 业务逻辑省略

// ...

}

4.1.调试

如下图：

4.2.校验失败 返回数据

代码展示如下：

{

"timestamp": "2020-05-08 00:18:13",

"status": 400,

"error": "Bad Request",

"errors": [

{

"arguments": [

{

"code": "title",

"codes": [

"spmkApproveSummaryDto.title",

"title"

],

"defaultMessage": "title"

}

],

"bindingFailure": false,

"code": "NotBlank",

"codes": [

"NotBlank.spmkApproveSummaryDto.title",

"NotBlank.title",

"NotBlank.java.lang.String",

"NotBlank"

],

"defaultMessage": "title为空",

"field": "title",

"objectName": "spmkApproveSummaryDto"

},

{

"arguments": [

{

"code": "assoType",

"codes": [

"spmkApproveSummaryDto.assoType",

"assoType"

],

"defaultMessage": "assoType"

}

],

"bindingFailure": false,

"code": "NotNull",

"codes": [

"NotNull.spmkApproveSummaryDto.assoType",

"NotNull.assoType",

"NotNull.java.lang.Integer",

"NotNull"

],

"defaultMessage": "assoType为空",

"field": "assoType",

"objectName": "spmkApproveSummaryDto"

}

],

"message": "Validation failed for object='spmkApproveSummaryDto'. Error count: 2",

"path": "/spmk/start_approval"

}

四、AOP切面 处理 BindingResult 校验结果

1.BindingResultAspect.java(定义切面类，加上@Component @Aspect这两个注解

代码展示如下：

import java.lang.reflect.Method;

import java.util.ArrayList;

import java.util.List;

import org.aspectj.lang.JoinPoint;

import org.aspectj.lang.ProceedingJoinPoint;

import org.aspectj.lang.Signature;

import org.aspectj.lang.annotation.Around;

import org.aspectj.lang.annotation.Aspect;

import org.aspectj.lang.annotation.Pointcut;

import org.aspectj.lang.reflect.MethodSignature;

import org.springframework.stereotype.Component;

import org.springframework.validation.BeanPropertyBindingResult;

import org.springframework.validation.ObjectError;

import com.alibaba.fastjson.JSONObject;

import cn.hutool.core.collection.CollectionUtil;

import cn.hutool.core.lang.Console;

import cn.hutool.core.util.ClassUtil;

import cn.timer.api.aspect.lang.annotation.BindingResultCtrol;

import cn.timer.api.aspect.lang.bean.ValidationError;

import cn.timer.api.utils.ResultUtil;

/**

* 校验信息返回

*

* @author TZQ

*/

@Aspect

@Component

public class BindingResultAspect {

// execution 配置织入点 -匹配 cn.timer.api.controller 包下的所有子包的类的方法

@Pointcut("execution(* cn.timer.api.controller.*.*.*(..))")

public void clazzPointCut(){

}

@Around("clazzPointCut()")

public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {

Long startTime = System.currentTimeMillis();

Object retVal;

Object[] objs = joinPoint.getArgs();

List listObj = CollectionUtil.toList(objs);

// 从 joinPoint 中 取得 BeanPropertyBindingResult的对象 (相当与上面的 bindingResult)

BeanPropertyBindingResult optional = (BeanPropertyBindingResult)listObj.stream()

.filter(p -> "BeanPropertyBindingResult".equals(ClassUtil.getClassName(p, true)))

.findFirst()

.orElse(null);

// 把 controller 方法里 对bindingResult的解析逻辑 迁移到这来做统一处理，这样每个被 切点 clazzPointCut() 匹配的方法都会做 一下处理

if(optional != null && optional.hasErrors()){

List ls = optional.getAllErrors();

List listVe = new ArrayList();

ValidationError ve;

for (ObjectError one : ls) {

String fieldString = one.getCodes().length >= 1 ? one.getCodes()[0] : "";

if (fieldString != null) {

fieldString = fieldString.substring(fieldString.lastIndexOf(".") + 1);

}

ve = ValidationError.builder().field(fieldString).msg(one.getDefaultMessage()).build();

listVe.add(ve);

}

retVal = ResultUtil.error(listVe);

}else {

retVal = joinPoint.proceed(joinPoint.getArgs());

}

Console.log("返回内容 {}: " ,JSONObject.toJSONString(retVal));

Long endtime = System.currentTimeMillis();

Console.log("执行耗时为{}：" ,endtime-startTime + "ms");

return retVal;

}

}

2.简要说明

1.@Aspect(切面)

通常是一个类，里面可以定义切入点和通知

2.@Pointcut (切点)

配置切入点Pointcut的几种方式: 例

当切入点为所有的public方法时： execution(public**(…))

当切入点为所有的set开始方法时：execution(set(…))

当切入点为xxx类种所有的方法时：execution(xxx(…))

当切入点为com.abc包下所有的方法时：execution(*com.abc…(…))

当切入点为com.abc包及其子包下面所有的方法时:execution(*com.abc…(…))

3.@Befor（前置通知）

在方法调用之前 调用

4.@After（后置通知）

在方法返回之后调用

5.@Afterthrow

在方法出现异常后调用

6.@Around

环绕通知

3.效果一样 返回校验错误提示

如下图：

至此，关于Spring Boot + validation + AOP 请求参数校验的方法和代码分享就结束了！

最后

你的每一次回眸都是永恒，每一次鼓励都是我前进的动力，每一次分享都是对我的认可。

作者：浓密秀发之谦先生

原文链接：https://blog.csdn.net/weixin_38150130/article/details/105984418

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 212,332评论 6赞 493
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 90,508评论 3赞 385
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 157,812评论 0赞 348
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 56,607评论 1赞 284
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 65,728评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 49,919评论 1赞 290
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,071评论 3赞 410
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,802评论 0赞 268
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,256评论 1赞 303
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,576评论 2赞 327
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,712评论 1赞 341
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,389评论 4赞 332
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,032评论 3赞 316
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,026评论 1赞 266
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,473评论 2赞 360
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,606评论 2赞 350