一、需求

在开发过程中，我们会经常遇到将数据库中的扁平行数据转换成树形结构的需求。
例如：菜单、组织机构、物品分类等数据。
那么该如何处理呢？

二、入参

image.png

三、过程

• Tree转换工具类

import org.springframework.util.CollectionUtils;

import java.util.*;

/**
 * @author TanXiao
 * @date 2024-09-27 07:03:31
 */
public class TreeUtils {

    /**
     * 根据所有树节点列表，生成含有所有树形结构的列表
     * @param nodes 树形节点列表
     * @return 树形结构列表
     * @param <T> 节点类型
     */
     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 所有树节点列表
     * @param <T>
     */
     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 父节点
     * @return 叶子节点
     * @param <T> 实际节点类型
     */
   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> 实际节点类型
     */
   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);
       }
   }

    /**
     * 树节点接口，所有需要使用{@linkplain TreeUtils}工具类形成树形结构等操作的节点都需要实现该接口
     * @param <T> 节点id类型
     */
    public interface TreeNode<T>{

        /**
         * 获取节点id
         * @return 树节点id
         */
      T id();

        /**
         * 获取该节点的父节点id
         * @return 父节点id
         */
       T parentId();

        /**
         * 是否是根节点
         * @return 根节点
         */
       boolean root();

        /**
         * 设置节点的子节点列表
         * @param children 子节点
         */
       void setChildren(List<? extends TreeNode<T>> children);

        /**
         * 获取所有子节点
         * @return 子节点列表
         */
       List<? extends TreeNode<T>> getChildren();
    }

}

• 实体类

import com.tx.common.utils.TreeUtils;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;
import lombok.experimental.Accessors;

import javax.persistence.Column;
import javax.persistence.Table;
import java.util.List;
import java.util.Objects;

/**
 * @author TanXiao
 * @date 2024-09-27 06:30:53
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
@Accessors(chain = true)
@ToString
@ApiModel(value = "商品分类列表实体类")
@Table(name = "goods_category")
public class GoodsCategory implements TreeUtils.TreeNode<String> {

    @javax.persistence.Id
    @ApiModelProperty(value = "主键ID")
    private String  Id ;

    @ApiModelProperty(value = "名称")
    @Column(name = "name")
    private String name;

    @ApiModelProperty(value = "父级ID")
    @Column(name = "pid")
    private String pid;

    @ApiModelProperty(value = "等级")
    @Column(name = "level")
    private String level;

    @ApiModelProperty(value = "是否删除")
    @Column(name = "is_delete")
    private String isDelete;

    @ApiModelProperty(value = "图标")
    @Column(name = "icon")
    private String icon;

    private List<GoodsCategory> children;

    @Override
    public String id() {
        return this.Id;
    }

    @Override
    public String parentId() {
        return this.pid;
    }

    @Override
    public boolean root() {
        return Objects.equals(this.pid,"0");
    }

    @Override
    public void setChildren(List children) {
        this.children = children;
    }
}

• 接口、调用

/**
 * @author TanXiao
 * @date 2024-09-27 06:37:32
 */
@RestController
@RequestMapping("/goods_category")
@Api(tags = "商品分类列表API")
public class GoodsCategoryController extends BaseController<GoodsCategoryService, GoodsCategory> {

    @PassToken
    @GetMapping("/v1/getGoodsCategoryTree")
    @ApiOperation(value = "获取商品分类列表树形结构数据", notes = "请查看Models数据字典")
    public ObjectRestResponse getTree(){
        List<GoodsCategory> goodsCategoryTree = TreeUtils.generateTrees(goodsCategoryService.selectListAll());
        return new ObjectRestResponse().data(goodsCategoryTree);
    }
}

四、出参

image.png