当前位置:

首页 > 编程开发 > Java通过注解实现构建树结构工具类

Java通过注解实现构建树结构工具类

前言 Ja va注解这东西,大家都不陌生。说到底,注解就是附加在代码上的一种元数据,它本身不改变程序的逻辑,却能给代码注入额外的信息——配置、验证、文档,甚至驱动一些自动化的逻辑处理。这篇文章要聊的,就是怎么用注解来构建一棵树结构。用注解来做这个事,具体怎么操作?直接往下看。 别绕弯子,直接开搞。

本文目录

    前言

    Ja va注解这东西,大家都不陌生。说到底,注解就是附加在代码上的一种元数据,它本身不改变程序的逻辑,却能给代码注入额外的信息——配置、验证、文档,甚至驱动一些自动化的逻辑处理。这篇文章要聊的,就是怎么用注解来构建一棵树结构。用注解来做这个事,具体怎么操作?直接往下看。

    Ja va通过注解实现构建树结构工具类

    别绕弯子,直接开搞。

    枚举类

    先定义一下字段的数据类型。这么做的目的很简单:注解需要知道自己标注的字段是什么类型,这样在反射取值时才能做正确的类型转换。

    public enum DataType {
        /** long */
        LONG,
    
        /** string */
        STRING,
    
        /** LIST */
        LIST,
    }
    

    注解

    接下来定义三个核心注解,分别标记主键、父节点ID和子节点集合。每个注解都通过dataType属性来指定数据类型,默认值分别对应最常见的场景。

    标记主键的注解:

    	
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.FIELD)
    public @interface PrimaryKey {
    
        /** 字段数据类型默认为 long */
        DataType dataType() default DataType.LONG;
    }
    

    标记父节点ID的注解:

    	
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.FIELD)
    public @interface ParentKey {
        
        /** 字段数据类型默认为 long */
        DataType dataType() default DataType.LONG;
    }
    

    标记子节点集合的注解:

    	
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.FIELD)
    public @interface ChildrenKey {
    
        /** 字段数据类型默认为 List */
        DataType dataType() default DataType.LIST;
    }
    

    获取注解标识的字段值

    有了注解,得有个工具把它们标注的字段值取出来。这步其实不复杂,就是利用反射遍历类的所有字段,找到标注了指定注解的那一个,然后获取它的值。AnnotationUtil 就干这一件事。

    public class AnnotationUtil {
    
        /**
         * 获取注解 annotation 标识的字段值
         * @param t entity
         * @param annotation 注解
         * @return ja va.lang.Object
         */
        public static  Object getFieldValue(T t, Class annotation) throws IllegalAccessException {
            Object fieldValue = null;
            Class clazz = t.getClass();
            Field[] declaredFields = clazz.getDeclaredFields();
            for (Field field : declaredFields) {
                if(field.isAnnotationPresent(annotation)){
                    field.setAccessible(true);
                    fieldValue = field.get(t);
                    break;
                }
            }
            return fieldValue;
        }
    }
    

    构建树结构工具类

    工具类TreeUtils才是重头戏,它负责把平铺的数据列表转化成树形结构。核心思路是:找到所有顶级节点(即父ID不在主键集合中的节点),然后挨个递归查找它们的子节点。这里给Long和String两种主键类型分别做了实现,代码逻辑一致,只是类型处理不同。

    public class TreeUtils {
        private static final Logger log = LoggerFactory.getLogger(TreeUtils.class);
    
        /**
         * 构建前端所需要树结构,主键为 Long 时
         * @param tList 数据集
         * @return ja va.util.List 树结构列表
         */
        public static  List buildLongTree(List tList) {
            try {
                List returnList = new ArrayList<>();
                //主键id集合
                List tempList = new ArrayList<>();
                for (T t : tList) {
                    Long primaryId = (Long) AnnotationUtil.getFieldValue(t, PrimaryKey.class);
                    tempList.add(primaryId);
                }
                for (T t : tList) {
                    // 如果是顶级节点, 遍历该父节点的所有子节点
                    Long parentId = (Long) AnnotationUtil.getFieldValue(t, ParentKey.class);
                    if (!tempList.contains(parentId)) {
                        recursionLong(tList, t);
                        returnList.add(t);
                    }
                }
                if (returnList.isEmpty()) {
                    returnList = tList;
                }
                return returnList;
            } catch (Exception e) {
                log.error("树结构转换失败:{}", e.getMessage());
                return tList;
            }
        }
    
        /**
         * 构建前端所需要树结构,主键为 String 时
         * @param tList 数据集
         * @return ja va.util.List 树结构列表
         */
        public static  List buildStringTree(List tList) {
            try {
                List returnList = new ArrayList<>();
                List tempList = new ArrayList<>();
                for (T t : tList) {
                    String primaryId = (String) AnnotationUtil.getFieldValue(t, PrimaryKey.class);
                    tempList.add(primaryId);
                }
                for (T t : tList) {
                    // 如果是顶级节点, 遍历该父节点的所有子节点
                    String parentId = (String) AnnotationUtil.getFieldValue(t, ParentKey.class);
                    if (!tempList.contains(parentId)) {
                        recursionString(tList, t);
                        returnList.add(t);
                    }
                }
                if (returnList.isEmpty()) {
                    returnList = tList;
                }
                return returnList;
            } catch (IllegalAccessException e) {
                log.error("树结构转换失败:{}", e.getMessage());
                return tList;
            }
        }
    
        /**
         * 递归设置子集数据,主键为 Long 时
         * @param list 数据集合
         * @param o 对象
         */
        private static  void recursionLong(List list, Object o) throws IllegalAccessException {
            // 得到子节点列表
            List childList = getLongChildList(list, o);
            invokeChildrenList(o, childList);
    
            for (Object oChild : childList) {
                if (getLongChildList(list, oChild).size() > 0) {
                    recursionLong(list, oChild);
                }
            }
        }
    
        /**
         * 递归设置子集数据,主键为 String 时
         * @param list 数据集合
         * @param o 对象
         */
        private static  void recursionString(List list, Object o) throws IllegalAccessException {
            // 得到子节点列表
            List childList = getStringChildList(list, o);
            invokeChildrenList(o, childList);
    
            for (Object oChild : childList) {
                if (getStringChildList(list, oChild).size() > 0) {
                    recursionString(list, oChild);
                }
            }
        }
    
        /**
         * 得到子节点列表,主键为 Long 时
         * @param list 数据
         * @param object entity
         * @return ja va.util.List
         */
        private static  List getLongChildList(List list, Object object) throws IllegalAccessException {
            Long primaryId = (Long) AnnotationUtil.getFieldValue(object, PrimaryKey.class);
    
            List objects = new ArrayList<>();
            for (T o : list) {
                Long parentId = (Long) AnnotationUtil.getFieldValue(o, ParentKey.class);
                if (null != parentId && parentId.longValue() == primaryId.longValue()) {
                    objects.add(o);
                }
            }
            return objects;
        }
    
        /**
         * 得到子节点列表,主键为 String 时
         * @param list 数据
         * @param object entity
         * @return ja va.util.List
         */
        private static  List getStringChildList(List list, Object object) throws IllegalAccessException {
            String primaryId = (String) AnnotationUtil.getFieldValue(object, PrimaryKey.class);
    
            List objects = new ArrayList<>();
            for (T o : list) {
                String parentId = (String) AnnotationUtil.getFieldValue(o, ParentKey.class);
                if (null != parentId && parentId.equals(primaryId)) {
                    objects.add(o);
                }
            }
            return objects;
        }
    
        /**
         * 通过反射设置子集数据
         * @param o 对象
         * @param childList 子集数据
         */
        private static  void invokeChildrenList(Object o, List childList) {
            Class clazz = o.getClass();
            Field[] declaredFields = clazz.getDeclaredFields();
            for (Field field : declaredFields) {
                if(field.isAnnotationPresent(ChildrenKey.class)){
                    field.setAccessible(true);
                    ReflectUtils.invokeSetter(o, field.getName(), childList);
                    break;
                }
            }
        }
    
    }
    

    测试一下

    理论说完了,拿一个部门树来跑跑看。定义一个Dept类,三个核心字段全都用注解标记好。主键和父ID是Long型,子集是List型,跟注解的默认值一致。

    // 此处使用lombok减少代码
    @Data
    public class Dept implements Serializable {
        private static final long serialVersionUID = -1L;
    
        /**
         * 部门ID
         * 如果数据类型为字符串,则 @PrimaryKey(dataType = DataType.STRING)
         */  
        @PrimaryKey
        private Long deptId;
    
        /** 
         * 父部门ID
         * 如果数据类型为字符串,则 @ParentKey(dataType = DataType.STRING)
         */
        @ParentKey
        private Long parentId;
    
        /** 部门名称 */
        private String deptName;
    
        /** 子部门 */
        @ChildrenKey
        private List children = new ArrayList<>();
    
        /** 加一个有参构造,方便测试 */
        public Dept(Long deptId, Long parentId, String deptName) {
            this.deptId = deptId;
            this.parentId = parentId;
            this.deptName = deptName;
        }
    }
    
    @Test
    public void test(){
        List deptList = new ArrayList<>();
        deptList.add(new Dept(1L, 0L, "部门0-1"));
        deptList.add(new Dept(2L, 0L, "部门0-2"));
        deptList.add(new Dept(3L, 1L, "部门1-1"));
        deptList.add(new Dept(4L, 1L, "部门1-2"));
        deptList.add(new Dept(5L, 2L, "部门2-1"));
        deptList.add(new Dept(6L, 2L, "部门2-2"));
        deptList.add(new Dept(7L, 3L, "部门1-1-1"));
        deptList.add(new Dept(8L, 3L, "部门1-1-2"));
        deptList.add(new Dept(9L, 6L, "部门2-2-1"));
        deptList.add(new Dept(10L, 6L, "部门2-2-2"));
        List depts = TreeUtils.buildLongTree(deptList);
        System.out.println(JSON.toJSONString(depts));
    }
    

    结果输出如下,嵌套关系完全正确:

    [{
        "deptId": 1,
        "parentId": 0,
        "deptName": "部门0-1",
        "children": [{
            "deptId": 3,
            "parentId": 1,
            "deptName": "部门1-1",
            "children": [{
                "deptId": 7,
                "parentId": 3,
                "deptName": "部门1-1-1",
                "children": []
            }, {
                "deptId": 8,
                "parentId": 3,
                "deptName": "部门1-1-2",
                "children": []
            }]
        }, {
            "deptId": 4,
            "parentId": 1,
            "deptName": "部门1-2",
            "children": []
        }]
    }, {
        "deptId": 2,
        "parentId": 0,
        "deptName": "部门0-2",
        "children": [{
            "deptId": 5,
            "parentId": 2,
            "deptName": "部门2-1",
            "children": []
        }, {
            "deptId": 6,
            "parentId": 2,
            "deptName": "部门2-2",
            "children": [{
                "deptId": 9,
                "parentId": 6,
                "deptName": "部门2-2-1",
                "children": []
            }, {
                "deptId": 10,
                "parentId": 6,
                "deptName": "部门2-2-2",
                "children": []
            }]
        }]
    }]

    以上就是基于Ja va注解构建树结构工具类的完整思路。用注解的关键优势在于,它能给字段贴上明确的语义标签,代码读起来清晰,维护时也省心——改动字段含义时,只需要调整注解配置,而无需修改树构建的核心逻辑。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    QQ影音怎么加速播放视频课程
    QQ影音怎么加速播放视频课程

    播放时右键选播放速度,或点控制条倍速,1.25 到 1.5 倍看课最舒服;公式代码类内容别超过 1.25 倍。

    企业微信创建企业提示失败怎么办 实名与填写检查
    企业微信创建企业提示失败怎么办 实名与填写检查

    先看提示属于哪类:名称占用就加后缀,实名不一致就重填本人信息,证件不清晰就重拍。统一社会信用代码逐位核对,连续三次失败别改材料重投,直接联系客服人工核。

    Modern Web Guidance 的 legacy-scan 反转建议应该怎样判断?
    Modern Web Guidance 的 legacy-scan 反转建议应该怎样判断?

    说明源码提交对字符串、生成器和数组的识别边界,以及扫描命令与发行包核验限制。

    Codex 0.170.0 正式版的语音与连接更新,适用范围有哪些限制?
    Codex 0.170.0 正式版的语音与连接更新,适用范围有哪些限制?

    0.170.0 的语音更新限于终端通话协商能力的明确新增,同名工具服务器跨环境支持仍标注实验性质;连接部分则修复大请求回退、认证竞态和云端重连等具体问题。这份正式版公告不足以证明所有账户、所有客户端都已具备完整语音功能。

    Hy4 flash 三种权重怎么选,安装和授权要注意哪些条件?
    Hy4 flash 三种权重怎么选,安装和授权要注意哪些条件?

    了解Hy4 flash、FP8与base的适用任务,阅读官方安装及图文代码,并核对资源和MaaS许可条件。

    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化
    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化

    OpenAI Python SDK 3.55.0 升级看点:Live MCP 服务配置与预算接口变化。说明已核实的更新范围、类型兼容性和本地版本确认方法。

    OpenAI Java SDK 4.108.0 的两项新增能力适合哪些项目?
    OpenAI Java SDK 4.108.0 的两项新增能力适合哪些项目?

    OpenAI Java SDK 4.108.0 面向 Live MCP 工具接入与 Managed Agents 预算状态处理,说明新增模型、事件含义、正式发布范围和适用限制。

    Free Claude Code 6.19.37 如何兼顾网页搜索与普通工具调用?
    Free Claude Code 6.19.37 如何兼顾网页搜索与普通工具调用?

    Free Claude Code 6.19.37 在自动搜索时保留客户端工具及选择条件,代理执行搜索后仍返回普通调用。说明适用场景、历史信息保留、请求约束与第三方项目的版本边界。

    Google GenAI Go SDK 1.78.0 的 v1beta 配置优先级怎样判断?
    Google GenAI Go SDK 1.78.0 的 v1beta 配置优先级怎样判断?

    Google GenAI Go SDK 1.78.0 将 Gemini Developer API 默认改为 v1,可用 HTTPOptions.APIVersion 或环境变量保留 v1beta,Vertex AI 默认值不变。

    Google GenAI SDK 3.5.0实时交互值得哪些项目升级评估?
    Google GenAI SDK 3.5.0实时交互值得哪些项目升级评估?

    解释实验性实时支持、环境检查与生产评估中需要验证的条件。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。