当前位置:

首页 > 编程开发 > 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注解构建树结构工具类的完整思路。用注解的关键优势在于,它能给字段贴上明确的语义标签,代码读起来清晰,维护时也省心——改动字段含义时,只需要调整注解配置,而无需修改树构建的核心逻辑。

本文内容来源于网友投稿,如有侵权请联系删除。
作者最新文章
编程开发
相关文章 更多
解决PHP递归报错:max_nesting_level限制与内存溢出处理
解决PHP递归报错:max_nesting_level限制与内存溢出处理

遇到PHP递归报错时,不要盲目调大max_nesting_level。本文教你区分Xdebug限制、内存耗尽和正则递归错误,提供代码级的终止条件优化与迭代替代方案,彻底解决栈溢出问题。

PHP递归中static变量与引用传递的常见陷阱及调试
PHP递归中static变量与引用传递的常见陷阱及调试

本文分析PHP递归中static变量导致的状态污染及引用传递引发的共享数据修改问题。提供具体的代码复现、缓存键设计建议及调试打印技巧,帮助开发者避免隐蔽的逻辑错误。

PHP递归性能优化技巧与迭代替代方案
PHP递归性能优化技巧与迭代替代方案

解析PHP递归函数在树形数据处理中的性能瓶颈,提供预加载数据消除I/O、使用显式栈替代深层递归的实战方案,帮助开发者在代码可读性与执行效率间做出合理取舍。

Java测试中怎么使用Mockito模拟依赖对象
Java测试中怎么使用Mockito模拟依赖对象

详细讲解在Java单元测试中如何使用Mockito模拟依赖对象,包括引入依赖、创建Mock、打桩返回值、行为验证以及Mock与Spy的核心差异和常见陷阱排查。

链表删除节点的时间复杂度是多少及其详细分析
链表删除节点的时间复杂度是多少及其详细分析

详细分析链表删除节点的时间复杂度,深入探讨单链表与双向链表在不同已知前提下的查找与删除开销,并结合完整代码与清晰图解进行对比总结。

codex如何配置模型参数及文件设置教程
codex如何配置模型参数及文件设置教程

想知道如何让AI写出的代码更贴合你的习惯?本文手把手教你在VS Code中调整Codex相关模型参数,通过修改配置文件优化温度值和令牌限制,解决代码建议不准确或响应慢的问题。

Claude Code AI编程工具实力揭秘与编程助手实测
Claude Code AI编程工具实力揭秘与编程助手实测

通过实测展示Claude Code在终端中如何理解自然语言指令、自动修改代码文件并处理复杂编程任务,帮助开发者评估其实际辅助能力。

winforms教程自学入门与基础开发步骤详解
winforms教程自学入门与基础开发步骤详解

本教程详细讲解如何使用Visual Studio创建WinForms项目,通过添加按钮和标签控件并编写点击事件代码,实现一个基础的计数器功能,适合C#初学者快速上手Windows窗体应用开发。

Cursor自动补全设置教程教你快速开启代码补全功能
Cursor自动补全设置教程教你快速开启代码补全功能

详解Cursor编辑器中自动补全功能的开启与优化设置,涵盖Tab触发机制、上下文窗口调整及模型切换,帮助开发者解决补全延迟、干扰大等问题,提升编码流畅度。

pandas的数据格式怎么转换和设置方法教程
pandas的数据格式怎么转换和设置方法教程

详解Pandas中数据格式转换的核心方法,包括astype强制转换、to_numeric容错处理及日期解析技巧,解决常见类型错误并提升数据处理效率。

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

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

Windows
Windows

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

macOS软件
macOS软件

正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

Mac软件 更多
photoshop
photoshop
Windows、macOS 、 iPad

Photoshop 2026 是 Adobe 推出的专业图像处理与视觉设计软件,支持 Windows、macOS 和 iPad 等平台,广泛应用于摄影修图、电商设计、平面海报、数字绘画及视觉合成等创作场景。

Blender
Blender
Windows、macOS 和 Linux

Blender 是一款免费开源、跨平台的专业 3D 创作软件,集建模、动画、渲染、视频编辑与视觉合成等功能于一体,广泛应用于影视动画、游戏设计和建筑可视化等领域。软件支持 Cycles 物理渲染器与 Eevee 实时渲染引擎,并提供多边形建模、骨骼绑定、物理模拟等专业工具。Blender 兼容 Windows、macOS 和 Linux 系统,安装包轻巧、运行流畅,依托活跃的全球开发者社区持续更新,是从初学者到专业创作者都值得选择的正版 3D 创作工具。

灵活计算器
灵活计算器
macOS/iOS/Android

灵活计算器是一款笔记式算数应用,支持实时计算、动态关联和云端同步功能。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

WINDOWS 更多
3dmax(3ds max)
3dmax(3ds max)
Windows

Autodesk 3ds Max 是一款专业的三维建模、动画与渲染软件,广泛应用于建筑可视化、游戏开发、影视动画、广告设计和产品展示等领域。

photoshop
photoshop
Windows、macOS 、 iPad

Photoshop 2026 是 Adobe 推出的专业图像处理与视觉设计软件,支持 Windows、macOS 和 iPad 等平台,广泛应用于摄影修图、电商设计、平面海报、数字绘画及视觉合成等创作场景。

Blender
Blender
Windows、macOS 和 Linux

Blender 是一款免费开源、跨平台的专业 3D 创作软件,集建模、动画、渲染、视频编辑与视觉合成等功能于一体,广泛应用于影视动画、游戏设计和建筑可视化等领域。软件支持 Cycles 物理渲染器与 Eevee 实时渲染引擎,并提供多边形建模、骨骼绑定、物理模拟等专业工具。Blender 兼容 Windows、macOS 和 Linux 系统,安装包轻巧、运行流畅,依托活跃的全球开发者社区持续更新,是从初学者到专业创作者都值得选择的正版 3D 创作工具。