项目中经常会遇到各种需要以树形结构展示的功能，比较常见的，如菜单树，分类树，部门树等等，如果为每种类型都遍历递归生成树形结构返回给前端，显得有些冗余且麻烦，并且其实逻辑都是一致的，只是遍历的对象不同而已，故其实可以通过面向接口思维，来实现这种通用工具类的实现。
TreeNode用来表示每个树节点的抽象，即需要生成树的对象需要实现此接口。
/**
* 树节点父类，所有需要使用{@linkplain TreeUtils}工具类形成树形结构等操作的节点都需要实现该接口
*
* @param <T> 节点id类型
*/
public interface TreeNode<T> {
/**
* 获取节点id
*
* @return 树节点id
*/
T id();
/**
* 获取该节点的父节点id
*
* @return 父节点id
*/
T parentId();
/**
* 是否是根节点
*
* @return true：根节点
*/
boolean root();
/**
* 设置节点的子节点列表
*
* @param children 子节点
*/
void setChildren(List<? extends TreeNode<T>> children);
/**
* 获取所有子节点
*
* @return 子节点列表
*/
List<? extends TreeNode<T>> getChildren();
}
TreeUtils用来生成树形结构，以及获取所有叶子节点等操作
/**
* 树形结构工具类
*
* @author meilin.huang
* @version 1.0
* @date 2019-08-24 1:57 下午
*/
public class TreeUtils {
/**
* 根据所有树节点列表，生成含有所有树形结构的列表
*
* @param nodes 树形节点列表
* @param <T> 节点类型
* @return 树形结构列表
*/
public static <T extends TreeNode<?>> List<T> generateTrees(List<T> nodes) {
List<T> roots = new ArrayList<>();
for (Iterator<T> ite = nodes.iterator(); ite.hasNext(); ) {
T node = ite.next();
if (node.root()) {
roots.add(node);
// 从所有节点列表中删除该节点，以免后续重复遍历该节点
ite.remove();
}
}
roots.forEach(r -> {
setChildren(r, nodes);
});
return roots;
}
/**
* 从所有节点列表中查找并设置parent的所有子节点
*
* @param parent 父节点
* @param nodes 所有树节点列表
*/
@SuppressWarnings("all")
public static <T extends TreeNode> void setChildren(T parent, List<T> nodes) {
List<T> children = new ArrayList<>();
Object parentId = parent.id();
for (Iterator<T> ite = nodes.iterator(); ite.hasNext(); ) {
T node = ite.next();
if (Objects.equals(node.parentId(), parentId)) {
children.add(node);
// 从所有节点列表中删除该节点，以免后续重复遍历该节点
ite.remove();
}
}
// 如果孩子为空，则直接返回,否则继续递归设置孩子的孩子
if (children.isEmpty()) {
return;
}
parent.setChildren(children);
children.forEach(m -> {
// 递归设置子节点
setChildren(m, nodes);
});
}
/**
* 获取指定树节点下的所有叶子节点
*
* @param parent 父节点
* @param <T> 实际节点类型
* @return 叶子节点
*/
public static <T extends TreeNode<?>> List<T> getLeafs(T parent) {
List<T> leafs = new ArrayList<>();
fillLeaf(parent, leafs);
return leafs;
}
/**
* 将parent的所有叶子节点填充至leafs列表中
*
* @param parent 父节点
* @param leafs 叶子节点列表
* @param <T> 实际节点类型
*/
@SuppressWarnings("all")
public static <T extends TreeNode> void fillLeaf(T parent, List<T> leafs) {
List<T> children = parent.getChildren();
// 如果节点没有子节点则说明为叶子节点
if (CollectionUtils.isEmpty(children)) {
leafs.add(parent);
return;
}
// 递归调用子节点，查找叶子节点
for (T child : children) {
fillLeaf(child, leafs);
}
}
}
具体使用方式之声明树节点对象
@Getter
@Setter
public class ResourceListVO implements TreeNode<Long> {
private Long id;
private Long pid;
private Integer type;
private String name;
private String icon;
private String code;
private Integer status;
private List<ResourceListVO> children;
@Override
public Long id() {
return this.id;
}
@Override
public Long parentId() {
return this.pid;
}
@Override
public boolean root() {
return Objects.equals(this.pid, 0L);
}
@Override
public void setChildren(List children) {
this.children = children;
}
}
具体使用方式之调用
/**
* 获取账号的资源树
*/
public List<ResourceListVO> listByAccountId(Long accountId) {
return TreeUtils.generateTrees(BeanUtils.copyProperties(mapper.selectByAccountId(userId), ResourceListVO.class));
}
通过使用TreeUtils工具可以统一方便地生成一切对象的树形结构以及其他一些对树的操作，避免对每个对象都用特定代码生成。使用起来就是几个字简洁方便爽歪歪biu特否。更多有趣方便的工具及代码可以去个人业余练手项目中获取哈https://gitee.com/objs/mayfly
。
