自定义Controller接口参数的值不能为空的校验

原创已于 2024-05-04 15:49:56 修改 · 1.7k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java

于 2023-07-31 17:15:16 首次发布

java 同时被 2 个专栏收录

126 篇文章

订阅专栏

后端框架

15 篇文章

订阅专栏

文章介绍了如何在进入Controller之前通过自定义注解和AOP切面来校验参数是否符合规范，例如非空检查。首先定义了一个名为`ParamNotNullCheck`的注解用于标记需要校验的参数，然后创建了一个切面`ParamNotNullCheckAspect`，该切面在注解标记的方法执行前进行参数值的检查，如果发现参数为空或空字符串，将返回错误信息。

需求：在进入到相应Controller控制器前，需要先校验参数是否符合规范要求，如是否为空等等。

有人说，可以使用@PathVariable里面的required属性控制，然而该属性只是代表参数是否必填，并不能校验参数的值是否满足要求。

解决

考虑到项目可能多处需要做此判断，所以我采用注解和切面的方式来解决此问题。

首先定义一个注解，用作标识，在参数的值需要做非空判断的地方添加该注解，定义一个切面来对添加了注解的地方进行校验。

添加注解

ParamNotNullCheck.java

内容：

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ParamNotNullCheck {}

添加切面

切面的逻辑可参考下面代码

@Aspect
@Component
public class ParamNotNullCheckAspect {

    @Around("@annotation(com.dtranx.tools.corpora.business.annotations.ParamNotNullCheck)")
    public Object doAround (ProceedingJoinPoint joinPoint) throws Throwable {
        MethodSignature signature=(MethodSignature) joinPoint.getSignature();
        //获取拦截的方法
        Method method = signature. getMethod();
        //获取方法的参数名
        String[] paramNames = signature.getParameterNames();
        //获取参数值
        Object[] paramValues = joinPoint.getArgs();
        //获取方法参数类型
        Class<?>[] parameterTypes =method .getParameterTypes();
        for (int i=0; i < paramValues.length; i++){
            Object paramValue = paramValues[i];
            if(StrUtil.equals(parameterTypes[i].getName(), "java.lang.String")) {
                if (ObjectUtil.isNull(paramValue) || StrUtil.isBlank((String) paramValue)){
                    //字符串，不能为空串（""、" " 等等）和null
                    return ResponseResult.failure(StrUtil.format( "参数数{}不能为空",paramNames[i]), 10021);}}
            if (ObjectUtil.isNull(paramValue)){
                return ResponseResult.failure(StrUtil.format("参数{}不能为空",paramNames[i]), 10021);}}
        return joinPoint.proceed();
    }
}

最后在需要做非空判断的地方加上@ParamNotNullCheck注解即可。如下所示：