spring boot+自定义 AOP 实现全局校验的实例代码
程序员文章站
2024-02-22 13:12:46
最近公司重构项目,重构为最热的微服务框架 spring boot, 重构的时候遇到几个可以统一处理的问题,也是项目中经常遇到,列如:统一校验参数,统一捕获异常。。。
仅凭...
最近公司重构项目,重构为最热的微服务框架 spring boot, 重构的时候遇到几个可以统一处理的问题,也是项目中经常遇到,列如:统一校验参数,统一捕获异常。。。
仅凭代码 去控制参数的校验,有时候是冗余的,但通过框架支持的 去控制参数的校验,是对于开发者很友好,先看下面的例子
@notempty(message="手机号不能为空") @size(min=11,max=11,message="手机号码长度不正确") @pattern(regexp=stringutils.regexp_mobile,message="手机号格式不正确") private string mobile;
这是spring boot支持的 校验注解,然后我们在 contoller层 加上@valid 注解 就可以达到校验的目的。这是一种框架自带的
本章 就展示一种 自定义的 aop 校验,首先 写一个注解,注解里面可以写上 我们需要校验的规则, 比如长度,正则。。。
@documented @target({elementtype.field,elementtype.method}) @retention(retentionpolicy.runtime) public @interface validateparam { int min() default 0; int max() default integer.max_value; string message() default "params is not null"; string regexp(); class<?>[] groups() default { }; class<? extends payload>[] payload() default { }; boolean isnotnull() default true; }
然后定义一个aop类
package com.onecard.primecard.common.aop; import java.lang.reflect.field; import java.lang.reflect.method; import java.lang.reflect.parameterizedtype; import java.util.arraylist; import java.util.arrays; import java.util.regex.pattern; import org.aspectj.lang.joinpoint; import org.aspectj.lang.proceedingjoinpoint; import org.aspectj.lang.annotation.around; import org.aspectj.lang.annotation.aspect; import org.aspectj.lang.annotation.before; import org.aspectj.lang.annotation.pointcut; import org.slf4j.logger; import org.slf4j.loggerfactory; import org.springframework.context.applicationcontext; import org.springframework.context.support.classpathxmlapplicationcontext; import org.springframework.stereotype.component; import com.jfcf.core.dto.resultdata; import com.onecard.core.support.util.stringutils; import com.onecard.primecard.common.annotation.validateparam; import com.onecard.primecard.common.utils.resultdatautil; /** * 全局 切面类(校验参数) * * @author administrator * */ @aspect @component public class gobalhandleraspect { private static logger logger = loggerfactory.getlogger(gobalhandleraspect.class); @pointcut("execution(* 包名.controller..*.*(..)) && execution(* 包名.controller..*.*(..))") public void checkaspect(){}; @before("checkaspect()") public void befor(joinpoint joinpoint) throws exception{ //前置统一输出参数 object[] args = joinpoint.getargs(); if(args != null && args.length>0){ object obj = args[0]; parameterizedtype pt = (parameterizedtype)obj.getclass().getgenericsuperclass(); class<?> classzz = (class<?>) pt.getactualtypearguments()[0]; logger.info("【小x卡】-【请求实体入参】:"+classzz.newinstance().tostring()); } } @around("checkaspect()") public object around(proceedingjoinpoint joinpoint) throws throwable{ //校验参数 object[] args = joinpoint.getargs(); object obj = null; if(args != null && args.length > 0){ obj = args[0]; class classzz = obj.getclass(); //没有顺序和秩序的数组 field[] fieldarray = classzz.getdeclaredfields(); arraylist<field> fieldlist = new arraylist<field>(arrays.aslist(fieldarray)); string res = checkparam(fieldlist,obj); if(stringutils.isnotnull(res)){ return resultdatautil.result(resultdata.status_param_error, res); } } return joinpoint.proceed(); } private string checkparam(arraylist<field> fieldlist, object obj) throws exception { for(field field : fieldlist){ validateparam validateparam = field.getannotation(validateparam.class); logger.info("【小x卡】获取注解值:"+validateparam.isnotnull()+"min="+validateparam.min()+"max="+validateparam.max()); method method = obj.getclass().getmethod("get"+getmethodname(field.getname())); logger.info("【小x卡】入参实体方法名称:"+method.getname()); if(method != null){ object val = method.invoke(obj); logger.info("【小x卡】回调方法:"+val); if(validateparam != null && validateparam.isnotnull() == true){ if(null == val || "".equals(val) ){ return field.getname()+"必填参数为空"; } } if(validateparam.min()==11 && validateparam.max() == 11){ if(val.tostring().length() != 11){ return field.getname()+"请输入参数正确的长度"; } } if(validateparam.regexp().equals(stringutils.regexp_mobile)){ if(!pattern.matches(stringutils.regexp_mobile, val.tostring())){ return field.getname()+"参数格式错误"; } } } } return null; } /** * 方法首字母大写 * @param fieldname * @return */ private string getmethodname(string fieldname) { stringbuffer buffer = new stringbuffer(); string firstletter = fieldname.substring(0, 1).touppercase(); return buffer.append(firstletter).append(fieldname.substring(1, fieldname.length())).tostring(); } }
定义一个切点 @pointcut, 用execution 表达式,去获取要校验的 某个类 和某个方法, 也就是连接点,然后 用定义一个通知,上面代码中有2个通知,一个前置通知@before,一个环绕通知@around,我们使用功能最强大的环绕通知。
通过上面的代码可以看出 首先获取参数,然后通过反射机制 获取 入参对象中的全部字段, 再去获取 我们在字段中加 我们自定义注解的字段,通过反射方法的回调,获取字段值,对值做判断, 返回校验结果。
总结
以上所述是小编给大家介绍的spring boot+自定义 aop 实现全局校验的实例代码,希望对大家有所帮助