SpringBoot实现通用的接口参数校验

本文介绍基于Spring Boot和JDK8编写一个AOP,结合自定义注解实现通用的接口参数校验。

缘由

目前参数校验常用的方法是在实体类上添加注解,但对于不同的方法,所应用的校验规则也是不一样的,例如有一个AccountVO实体:

publicclassAccountVO{privateStringname;//姓名privateIntegerage;//年龄}

假设存在这样一个业务:用户注册时需要填写姓名和年龄,用户登陆时只需要填写姓名就可以了。那么把校验规则加在实体类上显然就不合适了。

所以一直想实现一种方法级别的参数校验,对于同一个实体参数,不同的方法可以应用不同的校验规则,由此便诞生了这个工具,而且在日常工作中使用了很久。

介绍

先来看看使用的方式:

@ServicepublicclassTestImplimplementsITestService{@[email protected]({"name","age"})publicvoidtestValid(AccountVOvo){//...}}

其中方法上的@Check注解指明了参数AccountVO中的name、age属性不能为空。除了非空校验外,还支持大小判断、是否等于等校验:

@Check({"id>=8","name!=aaa","title<10"})

默认的错误信息会返回字段,错误原因和调用的方法,例如:

updateUserIdmustnotnullwhilecallingtestValididmust>=8whilecallingtestValidnamemust!=aaawhilecallingtestValid

也支持自定义错误返回信息:

@Check({"title<=8:标题字数不超过8个字,含标点符号"})publicvoidtestValid(TestPOpo){//...}

只需要在校验规则后加上:,后面写上自定义信息,就会替换默认的错误信息。

PS:
核心原理是通过反射获取参数实体中的字段的值,然后根据规则进行校验,
所以目前只支持含有一个参数的方法,并且参数不能是基础类型。

使用

spring-boot中如何使用AOP这里不再赘述,主要介绍AOP中的核心代码。Java:由浅入深揭开 AOP 实现原理

Maven 依赖

除了spring-boot依赖之外,需要的第三方依赖,不是核心的依赖,可以根据个人习惯取舍:

<!--用于字符串校验--><dependency><groupId>org.apache.commons</groupId><artifactId>commons-lang3</artifactId><version>3.3.2</version></dependency><!--用于日志打印--><dependency><groupId>org.slf4j</groupId><artifactId>slf4j-api</artifactId><version>1.7.25</version></dependency>

自定义注解

importjava.lang.annotation.ElementType;importjava.lang.annotation.Retention;importjava.lang.annotation.Target;importstaticjava.lang.annotation.RetentionPolicy.RUNTIME;/***参数校验注解*/@Target({ElementType.TYPE,ElementType.METHOD})@Retention(RUNTIME)[email protected]{//字段校验规则,格式:字段名+校验规则+冒号+错误信息,例如:id<10:ID必须少于10String[]value();}

核心代码

通过切面拦截加上了@Check注解的接口方法,在方法执行前,执行参数校验,如果存在错误信息,则直接返回:

@Around(value="@com.cipher.checker.Check")//这里要换成自定义注解的路径publicObjectcheck(ProceedingJoinPointpoint)throwsThrowable{Objectobj;//参数校验Stringmsg=doCheck(point);if(!StringUtils.isEmpty(msg)){//这里可以返回自己封装的返回类thrownewIllegalArgumentException(msg);}obj=point.proceed();returnobj;}

核心的校验方法在doCheck方法中,主要原理是获取注解上指定的字段名称和校验规则,通过反射获取参数实体中对应的字段的值,再进行校验:

/***参数校验**@parampointProceedingJoinPoint*@return错误信息*/privateStringdoCheck(ProceedingJoinPointpoint){//获取方法参数值Object[]arguments=point.getArgs();//获取方法Methodmethod=getMethod(point);StringmethodInfo=StringUtils.isEmpty(method.getName())?"":"whilecalling"+method.getName();Stringmsg="";if(isCheck(method,arguments)){Checkannotation=method.getAnnotation(Check.class);String[]fields=annotation.value();Objectvo=arguments[0];if(vo==null){msg="paramcannotbenull";}else{for(Stringfield:fields){//解析字段FieldInfoinfo=resolveField(field,methodInfo);//获取字段的值Objectvalue=ReflectionUtil.invokeGetter(vo,info.field);//执行校验规则BooleanisValid=info.optEnum.fun.apply(value,info.operatorNum);msg=isValid?msg:info.innerMsg;}}}returnmsg;}

可以看到主要的逻辑是:

解析字段 -> 获取字段的值 -> 执行校验规则

内部维护一个枚举类,相关的校验操作都在里面指定:

/***操作枚举*/enumOperator{/***大于*/GREATER_THAN(">",CheckParamAspect::isGreaterThan),/***大于等于*/GREATER_THAN_EQUAL(">=",CheckParamAspect::isGreaterThanEqual),/***小于*/LESS_THAN("<",CheckParamAspect::isLessThan),/***小于等于*/LESS_THAN_EQUAL("<=",CheckParamAspect::isLessThanEqual),/***不等于*/NOT_EQUAL("!=",CheckParamAspect::isNotEqual),/***不为空*/NOT_NULL("notnull",CheckParamAspect::isNotNull);privateStringvalue;privateBiFunction<Object,String,Boolean>fun;Operator(Stringvalue,BiFunction<Object,String,Boolean>fun){this.value=value;this.fun=fun;}}

由于篇幅原因,这里就不一一展开所有的代码,有兴趣的朋友可以到以下地址获取所有的源码:

https://github.com/ciphermagic/java-learn/tree/master/sandbox/src/main/java/com/cipher/checker

TODO

  • 以Spring Boot Starter的方式封装成独立组件
  • 支持正则表达式验证

以上实践只做参考,可能会有一定的局限性

原文地址:https://www.cnblogs.com/CQqfjy/p/12272089.html

时间: 2024-08-29 14:28:09

SpringBoot实现通用的接口参数校验的相关文章

接口参数校验之@Valid与BindingResult

接口方法往往需要对入参做一些校验,从而判断入参是否合格,而javax.validation包为我们提供了一些常用的参数校验注解,使用起来很方便. 下面这个示例是检验入参对象中的password是否为空 1. 创建一个User.java import javax.validation.constraints.NotBlank; public class User { private String username; @NotBlank private String password; privat

web接口参数校验神器-json schema 快速入门

Json Schema 快速入门 JSON 模式是一种基于 JSON 格式定义 JSON 数据结构的规范.它被写在 IETF 草案下并于 2011 年到期.JSON 模式: 描述现有数据格式. 干净的人类和机器可读的文档. 完整的结构验证,有利于自动化测试. 完整的结构验证,可用于验证客户端提交的数据. Json schema 格式 Json schema 本身遵循Json规范,本身就是一个Json字符串,先来看一个例子 { "$schema": "http://json-s

SpringBoot 参数校验的方法

Introduction 有参数传递的地方都少不了参数校验.在web开发中,前端的参数校验是为了用户体验,后端的参数校验是为了安全.试想一下,如果在controller层中没有经过任何校验的参数通过service层.dao层一路来到了数据库就可能导致严重的后果,最好的结果是查不出数据,严重一点就是报错,如果这些没有被校验的参数中包含了恶意代码,那就可能导致更严重的后果. 这里我们主要介绍在springboot中的几种参数校验方式.常用的用于参数校验的注解如下: @AssertFalse 所注解的

Spring Boot 参数校验

1.背景介绍 开发过程中,后台的参数校验是必不可少的,所以经常会看到类似下面这样的代码 这样写并没有什么错,还挺工整的,只是看起来不是很优雅而已. 接下来,用Validation来改写这段 2.Spring Boot文档中的Validation 在Spring Boot的官网中,关于Validation只是简单的提了一句,如下 其实,Spring Validator和Hibernate Validator是两套Validator,可以混着用,这里我们用Hibernate Validator 3.

七、springboot整合Spring-data-jpa(二)之通用DAO接口与添加自定义方法

@NoRepositoryBean:Spring Data Jpa在启动时就不会去实例化BaseRepository这个接口 1.通用接口: import org.springframework.data.jpa.repository.JpaRepository; import org.springframework.data.jpa.repository.JpaSpecificationExecutor; import org.springframework.data.repository.N

Springboot + redis + 注解 + 拦截器来实现接口幂等性校验

Springboot + redis + 注解 + 拦截器来实现接口幂等性校验 1. SpringBoot 整合篇 2. 手写一套迷你版HTTP服务器 3. 记住:永远不要在MySQL中使用UTF-8 4. Springboot启动原理解析 一.概念 幂等性, 通俗的说就是一个接口, 多次发起同一个请求, 必须保证操作只能执行一次比如: 订单接口, 不能多次创建订单 支付接口, 重复支付同一笔订单只能扣一次钱 支付宝回调接口, 可能会多次回调, 必须处理重复回调 普通表单提交接口, 因为网络超时

SpringBoot入门二十二,使用Validation进行参数校验

项目基本配置参考文章SpringBoot入门一,使用myEclipse新建一个SpringBoot项目,使用myEclipse新建一个SpringBoot项目即可,此示例springboot升级为2.2.1版本. 1. pom.xml添加aop支持 如果已经引用了spring-boot-starter-web,就不要需要引用spring-boot-starter-validation了,本例就不再引用 <!-- 引入validation支持 --> <dependency> <

接口安全校验

接口安全校验 以前简单介绍过web api 的设计,但是还是有很多朋友问我,如何合理的设计和实现web api.比如,接口安全,异常处理,统一数据返回等问题.所以有必要系统的总结总结 web api 的设计和实现.由于前面已经介绍过web api 的参数和返回格式的设计,<Web API系列(一)设计经验与总结>.这次,就来讲讲接口安全. 由于Web API是基于互联网的应用,因此安全性要远比在本地访问数据库的要严格的多,一般通用的做法,是采用几步来保证接口和数据安全: 1.首先一个是基于CA

spring-boot | 整合通用Mabatis 分页插件PageHelper

Mybatis通用Mapper介绍 Mybatis 通用 Mapper极其方便的使用 Mybatis 单表的增删改查,支持单表操作,不支持通用的多表联合查询优点:通用 Mapper 可以极大的方便开发人员.为了让您更方便的了解通用 Mapper,下面贴一段代码来看实际效果.通用Mapper通用 Mapper 可以缓存,全部针对单表操作,每个实体类都需要继承通用 Mapper 接口来获得通用方法. 实际开发过程中,我们对数据库单表的操作情况有很多,有了通用mapper插件, 我们实现相对应的接口,