使用AOP 做 参数校验

当你使用 javax.validation 对进行类中的属性进行校验的时候, 可能会遇到一个问题,

当你这个校验在多个地方使用, 但是校验规则不相同, 这种情况可能需要创建新的对象, 规定新的规则进行不同的校验

这里考虑通过AOP 自己来控制使用哪种规则校验

首先规定一个切入点

import java.lang.annotation.*;

/**
 * 参数校验的标识，如果方法上加了这个注解，则会校验本参数
 *
 * @author 张林
 * @version 1.0
 * @date 2022/1/20 4:22 下午
 */
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ParamValidator {

	// 会根据这个type 取不同的规则进行校验
    int type() default 1;
}

定义一个规范, 需要校验的类将实现具体的校验规则

/**
 * 用于参数校验的接口
 *
 * @author 张林
 * @version 1.0
 * @date 2022/1/20 4:22 下午
 */
public interface BaseValidatingParam {

    /**
     * 校验请求参数是否为空
     *
     * @param type
     * @return String 如果返回null代表没有为空的参数，校验通过，如果不为空，则代表有空的字段，并且返回的内容是为空的提示信息
     */
    String checkParam(int type);
}

现在我们获取切入点

/**
 * 参数校验的aop
 *
 * @author 张林
 * @version 1.0
 * @date 2022/1/20 4:22 下午
 */
@Aspect
@Component
@Order(99)
public class ParamValidateAspect {

    @Pointcut(value = "@annotation(com.yuance.prevent.common.utils.checkParams.ParamValidator)")
    private void cutService() {

    }

    @Around("cutService()")
    public Object doInvoke(ProceedingJoinPoint point) throws Throwable {
        ParamValidator paramValidator = ((MethodSignature)point.getSignature()).getMethod().getAnnotation(ParamValidator.class);
        //获取拦截方法的参数
        Object[] methodParams = point.getArgs();

        if (methodParams != null && methodParams.length > 0) {
            //如果参数中，包含BaseValidatingParam的子类就开始校验参数
            CheckUtil.validateParameters(methodParams, paramValidator.type());
        }
        return point.proceed();
    }
}

具体的校验的地方

/**
 * 校验参数中的参数是否符合规则
 *
 * @author 张林
 * @version 1.0
 * @date 2022/1/20 4:22 下午
 */
public class CheckUtil {

    public static void validateParameters(Object[] methodParams, int type) {

        for (Object methodParam : methodParams) {
            if (methodParam instanceof BaseValidatingParam) {
                BaseValidatingParam baseValidatingParam = (BaseValidatingParam) methodParam;
                String checkResult = baseValidatingParam.checkParam(type);
                //如果校验结果不为空，则代表参数校验有空的或者不符合规则的，并且checkResult为参数错误的提示信息
                if (ValidateUtil.isNotEmpty(checkResult)) {
                    throw new BizException(checkResult);
                }
            }
        }
    }
}

/**
 * 空参数校验工具类
 *
 * @author 张林
 * @version 1.0
 * @date 2022/1/20 4:22 下午
 */
public class ValidateUtil {

    /**
     * 对象是否不为空(新增)
     */
    public static boolean isNotEmpty(Object o) {
        return !isEmpty(o);
    }

    /**
     * 对象是否为空
     * @param o
     * @return
     */
    public static boolean isEmpty(Object o) {
        if (o == null) {
            return true;
        }
        if (o instanceof String) {
            return o.toString().trim().equals("");
        } else if (o instanceof List) {
            return ((List) o).size() == 0;
        } else if (o instanceof Map) {
            return ((Map) o).size() == 0;
        } else if (o instanceof Set) {
            return ((Set) o).size() == 0;
        } else if (o instanceof Object[]) {
            return ((Object[]) o).length == 0;
        } else if (o instanceof int[]) {
            return ((int[]) o).length == 0;
        } else if (o instanceof long[]) {
            return ((long[]) o).length == 0;
        }
        return false;
    }
}