基于注解的可校验泛型的参数校验工具

最新推荐文章于 2024-05-28 20:54:27 发布

原创最新推荐文章于 2024-05-28 20:54:27 发布 · 2.1k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java #注解 #反射

语言同时被 2 个专栏收录

21 篇文章

订阅专栏

设计模式

16 篇文章

订阅专栏

本文介绍了一种基于注解的参数校验工具，适用于验证单个参数、列表以及带泛型的List<String>。然而，该工具不支持嵌套泛型如List<List<String>>的校验。文中包含注解类和校验类的详细说明。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

基于注解的校验工具很多，但有些不是很符合自己的场景，自己写了一个，亲测可用

可以校验入参中的单个参数、列表、带泛型的列表（List<String>），但是嵌套的泛型(List<List<String>>)不能校验:

注解类：

package com.mhc.gw.sti.api.jd.util;

import java.lang.annotation.*;

/**
 * 单参数注解
 * @author zhuobing
 * @since 2018/8/27
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface SingleParamNotNull {
}

package com.mhc.gw.sti.api.jd.util;

import java.lang.annotation.*;

/**
 * 列表参数注解
 * @author zhuobing
 * @since 2018/8/27
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface ListParamNotNull {
}

校验类：

package annotations;

import java.lang.reflect.Field;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.List;

/**
 * 参数校验工具使用说明：
 * 1.配合SingleParamNotNull，ListParamNotNull注解进行使用
 * 2.可以对泛型参数进行级联校验（List<String> ,List<User>）
 * 3.参数嵌套层级不可过深，最多三层，如果过深可能会有异常出现，如StackOverflow
 * 4.父类参数校验不到
 * 5.嵌套的泛型(List<List<String>>)不能校验
 * @author zhuobing
 * @since 2018/8/28
 */
public class ParamCheckUtil {
    public static <T> void checkParams(T t) {
        try {
            if (t == null) {
                throw new RuntimeException(t + "不能为空");
            }

            Field[] fields = t.getClass().getDeclaredFields();

            if (fields != null && fields.length > 0) {
                for (Field field : fields) {

                    SingleParamNotNull singleParamNotNull = field.getAnnotation(SingleParamNotNull.class);
                    if (singleParamNotNull != null) {
                        field.setAccessible(true);
                        checkSingleParam(field.get(t), field);
                        field.setAccessible(false);
                        continue;
                    }

                    ListParamNotNull listParamNotNull = field.getAnnotation(ListParamNotNull.class);
                    if (listParamNotNull != null) {
                        field.setAccessible(true);
                        checkListParam(field.get(t), field);
                        field.setAccessible(false);
                    }

                }
            }
        } catch (Exception e) {
            throw new RuntimeException(e.getMessage());
        }
    }

    private static <T> void checkSingleParam(T t, Field field) {
        try {
            if (t == null) {
                throw new RuntimeException(field.getDeclaringClass() + ":" + field.getName() + "不能为空");
            }

            //自定义类（不是java原生类）
            if (!isJavaClass(t.getClass())) {
                checkParams(t);
            }

        } catch (Exception e) {
            throw new RuntimeException(e.getMessage());
        }
    }

    private static <T> void checkListParam(T t, Field field) {
        try {
            //list本身是否为空
            if (t == null || ((List) t).size() == 0) {
                throw new RuntimeException(field.getDeclaringClass().getName() + ":" + field.getName() + "不能为空");
            }

            if (field.getType() == List.class) {
                // 如果是List类型，得到其Generic的类型
                Type genericType = field.getGenericType();
                if (genericType != null) {
                    // 如果是泛型参数的类型
                    if (genericType instanceof ParameterizedType) {
                        ParameterizedType pt = (ParameterizedType) genericType;
                        //得到泛型里的class类型对象
                        Class<?> genericClazz = (Class<?>) pt.getActualTypeArguments()[0];
                        //自定义类
                        if (!isJavaClass(genericClazz)) {
                            List innerObjs = ((List) t);

                            for (Object object : innerObjs) {
                                checkParams(object);
                            }
                        }

                    }
                }
            }

        } catch (Exception e) {
            throw new RuntimeException(e.getMessage());
        }
    }


    /**
     * 判断一个类是JAVA类型还是用户定义类型
     *
     * @param clz
     * @return
     */
    public static boolean isJavaClass(Class<?> clz) {
        return clz != null && clz.getClassLoader() == null;
    }
}