1.为什么需要实现非空校验
基于上一篇文章中 15.Objects.requireNonNull方法说明 提到的理论
我们应当遵循Fail-Fast的编程思想,让错误尽可能早地出现。
方法之一便是在上一篇文章中提到的,在每个方法最开始时对参数判断是否为空值。而对于某些特定项目,需要进行全局的参数非空校验,实现的最佳方法就是AOP。
2.代码实现
2.1.整体要点说明
- 在项目下创建aop目录,创建切面类CheckNullAspect
- 在类代码上添加@Aspect、@Component注解
- 在方法代码上添加@Around注解,括号内写execution表达式以确定切点
- 以ProceedingJoinPoint作为方法的形式参数
- 编写增强
package edu.gdut.oec.aop;
import edu.gdut.oec.exception.CustomException;
import edu.gdut.oec.util.ResultUtil;
import org.apache.ibatis.jdbc.Null;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;
/**
* @author xyx-Eshang
*/
@Aspect
@Component
public class CheckNullAspect {
@Around("execution(* edu.gdut.oec..*(..))")
public Object checkNullAdvice(ProceedingJoinPoint pjp) throws Throwable {
//获取所有的参数值
Object[] parameters = pjp.getArgs();
for(int i = 0; i < parameters.length; i++){
if("".equals(parameters[i]) || parameters[i] == null){
//获取方法签名
Object objectSignature = pjp.getSignature();
//获取方法所有的参数名
MethodSignature methodSignature = (MethodSignature) objectSignature;
String[] parameterNames = methodSignature.getParameterNames();
//创建自定义异常,并将其封装到统一返回对象中
CustomException e = new CustomException(methodSignature.toString(), parameterNames[i]);
return new ResultUtil<Null>(e);
}
}
return pjp.proceed();
}
}
说明一下:在第31 - 33行代码中,是对返回的自定义统一返回对象进行处理,这里大家根据实际情况可以作出调整。
注意:在环绕增强中,增强方法的返回值,会替换掉目标方法的返回值
如方法A的返回值是resultA,增强B的返回值是resultB,当方法A作为增强B的切点时,程序执行完毕,最终方法A的返回值会由resultA替换为resultB。若对上述概念有不理解,可见文章11.AOP面向切面编程
2.2.参数值、方法签名、参数名的获取
//tips:pjp是ProceedingJoinPoint的引用
//获取所有的参数值
Object[] parameters = pjp.getArgs();
//获取方法签名
Object objectSignature = pjp.getSignature();
//获取方法所有的参数名
MethodSignature methodSignature = (MethodSignature) objectSignature;
String[] parameterNames = methodSignature.getParameterNames();
3.进阶内容:基于自定义注解的参数非空校验
有时,我们并不需要对所有的方法都进行参数非空校验。此时便可以采用自定义注解的方式。此处可参考文章 14.基于AOP实现自定义注解:
- 创建并编写好注解类(@interface)
- 创建切面类,增强方法上方的@Around括号内,填入@annotation表达式
- 将对应的注解类也作为增强方法的形式参数
- 编写好增强方法的剩余内容
- 在需要用到的方法上使用自定义注解