基于AOP的自定义注解参数校验
开发时遇到的问题
//很多public方法,严格意义上来说,都需要有一些参数为空校验
@Override
public OrgAttach getAttachByOrgId(Integer orgId) {
if (Objects.isNull(orgId)) {
throw new ParameterException("orgId参数为空异常");
}
//TODO
}
思考
- 参数校验是位于业务逻辑执行执行,可以考虑将其拆分。
- 执行方法之前,做参数校验,与
AOP
思想相符。
- 由于并不是所有的方法,都需要校验(某些方法允许空参数),所以考虑使用自定义注解,让开发者进行灵活控制。
前置版本
springboot
: 2.1.1.RELEASE
详细代码
自定义注解
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ParamNullCheck {
/**
* 待判断的参数下标位置(从0开始)
* @return 参数列表
*/
int[] paramIndex();
/**
* 参数空校验类型,默认只要一个参数为空时校验不通过
* @return
*/
ParamNullCheckTypeEnum checkType() default ParamNullCheckTypeEnum.ONE;
}
枚举类定义
public enum ParamNullCheckTypeEnum {
/**
* 所有参数为空时校验不通过
*/
ALL,
/**
* 只要一个参数为空,校验不通过
*/
ONE
}
定义切面
@Aspect
public class ParamNullCheckAspect {
/**
* 定义切点
* @param paramNullCheck
*/
@Pointcut("@annotation(paramNullCheck)")
public void pointCut(ParamNullCheck paramNullCheck) {
}
/**
* 切面
* @param joinPoint 切点
* @param paramNullCheck 参数校验注解
* @return
*/
@Before("pointCut(paramNullCheck)")
public void check(JoinPoint joinPoint, ParamNullCheck paramNullCheck) {
//入参列表
Object[] args = joinPoint.getArgs();
//参数为空异常校验
paramCheck(args,