优雅的树形数据结构管理包,基于Closure Table模式设计.
- 优雅的树形数据设计模式
- 最少的数据库查询
- 一个think\Model Trait简单操作
- 完善的树形结构操作方法
- 支持生成树形数据
- 支持多个根存在
- 支持节点/树修复
- ...
- php > 7.1.0
- topthink/framework ^6.0.0
- mysql > 8.0.0
Closure Table将树中每个节点与其后代节点的关系都存储了下来,
这将需要一个存储节点关系的表xxx_closure.
例如一个菜单表menus:
| id | name | parent |
|---|---|---|
| 1 | A | 0 |
| 2 | AA | 1 |
| 3 | AB | 1 |
| 4 | AAA | 2 |
| 5 | ABA | 3 |
| 6 | ABAA | 5 |
一个基本的closure表包含ancestor,descendant,distance3个字段,如:
| ancestor | descendant | distance |
|---|---|---|
| 1 | 1 | 0 |
| 1 | 2 | 1 |
| 1 | 3 | 1 |
| 1 | 4 | 2 |
| 1 | 5 | 2 |
| 1 | 6 | 3 |
| 2 | 2 | 0 |
| 2 | 4 | 1 |
| 3 | 3 | 0 |
| 3 | 5 | 1 |
| 3 | 6 | 2 |
| 4 | 4 | 0 |
| 5 | 5 | 0 |
| 5 | 6 | 1 |
| 6 | 6 | 0 |
这个表记录了每个节点之间的关系,并且还记录了一条自身的关联,如：1,1,0.
ClosureTable提供了大量方法操作树结构.
$ php think closuretable:make Node
$ php think migrate:run可以生成实体类的xxx_closure 表的迁移数据 自动在数据生成数据表
<?php
$menu = Menu::find(2);
// 将$menu作为根,return bool
$menu->makeRoot();
// 创建一个子级节点,return new model
$menu->createChild($attributes);
// 创建一个新的节点，该节点为根,也可以指定列 parent,它将自动维护树结构.,return new model
$child = Menu::create($attributes);
// 将一个已存在的节点添加到子级,$child参数可以是模型实例/集合/id/包含id的数组,return bool
$menu->addChild($child);
$menu->addChild(12);
$menu->addChild('12');
$menu->addChild([3, 4, 5]);
// 移动到$parent的下级,后代也将随之移动,$parent参数可以是模型实例/id,return bool
$menu->moveTo($parent);
$menu->moveTo(2);
$menu->moveTo('2');
// 添加一个或多个同级节点,$siblings的后代也将随之移动,$siblings可以是模型实例/集合/id/包含id的数组,return bool
$menu->addSibling($siblings);
$menu->addSibling(2);
$menu->addSibling('2');
$menu->addSibling([2,3,4]);
// 新建一个同级节点,return new model
$menu->createSibling($attributes);
它监听了
onAfterInsert,onBeforeUpdate,onBeforeDelete事件,如果你使用了create(),或对实例使用了update(), restore()它将自动维护树结构. 这意味着如果你在修改parent列,它将自动维护树结构.
<?php
$menu = Menu::find(3);
// 获取所有后代,return model collection
$menu->getDescendants();
// 获取所有后代,包括自己,return model collection
$menu->getDescendantsAndSelf();
// 获取所有祖先,return model collection
$menu->getAncestors();
// 获取所有祖先,包括自己,return model collection
$menu->getAncestorsAndSelf();
// 获取所有儿女(直接下级),return model collection
$menu->getChildren();
// 获取父辈(直接上级),return model
$menu->getParent();
// 获取祖先(根),return model
$menu->getRoot();
// 获取所有兄弟姐妹,return model collection
$menu->getSiblings();
//获取所有兄弟姐妹包括自己,return model collection
$menu->getSiblingsAndSelf();
// 获取所有孤立节点,孤立节点指在`closureTable`里没有的记录
Menu::getIsolated();
Menu::isolated()->where('id', '>', 5)->select();
// 获取所有根
Menu::getRoots();
// 一个scope,同getRoots()
Menu::onlyRoot()->select();-
以上
select...()方法都包含一个query构造器,如getDescendants()对应有一个queryDescendants(),这使得你可以在查询中加入更多条件或 'order',
你可以这样使用
$menu->queryDescendants()->where('id', '>', 5)->order('sort','desc')->get();注意
getRoot(),getParent(),getRoots(),getIsolated()4个方法没有query构造器 -
如果你想获取只包含单个或多个列的结果可以在
select...()方法里传入参数,如:$menu->getAncestors(['id','name']);
提供多种方法生成树形数据,可从任意节点生成树
<?php
$menu = Menu::find(3);
// 从当前节点生成树,return tree
$menu->getTree();
// 当前节点作为根生成树,以sort字段排序,return tree
$menu->getTree(['sortColumn', 'desc']);
// 同上,return tree
$menu->getDescendantsAndSelf()->toTree();
// 获取到以所有children为根的multi tree
$menu->getDescendants()->toTree();
// 从根节点生成树,return tree
$menu->getRoot()->getTree();
//旁树,不包含自己和下级,return tree
$menu->getBesideTree();生成的树如下:
[
[
'id' => 3,
'name' => 'node3',
'children' => [
[
'id' => 4,
'name' => 'node4'
],
[
'id' => 5,
'name' => 'node5'
'children' => [
[
'id' => 6,
'name' => 'node6'
]
]
]
]
]
]-
生成的树
children键默认为children,如果你想自定义可以作为第2个参数传入,如:$menu->getTree(['sortColumn', 'desc'], 'son');如果你想获取只包含单个或多个列的结果可以作为第3个参数传入,如:
$menu->getTree(['sortColumn', 'desc'], 'son', ['id', 'name']); -
你的表里可能包含多棵树,如果你想一一获取他们可以这样做:
<?php $multiTree = Menu::all()->toTree(); var_dump($multiTree);
<?php
$menu = Menu::find(3);
// 是否根
$menu->isRoot();
// 是否叶子节点
$menu->isLeaf();
// 是否孤立节点
$menu->isIsolated();
// 是否$descendant的上级
$menu->isAncestorOf($descendant);
// 是否$ancestor的下级
$menu->isDescendantOf($ancestor);
// 是否$parent的直接下级
$menu->isChildOf($parent);
// 是否$child的直接上级
$menu->isParentOf($child);
// 是否$sibling的同级(同一个上级)
$menu->isSiblingOf($sibling);
// 如果$beside不是自己也不是自己的后代返回true
$menu->isBesideOf($beside);ClosureTable 监听了模型的 BeforeDelete 事件
$menu->delete();删除(包括软删除)一条记录,这个操作将解除自身的所有关联,
并且其 children 会成为根,这意味着所有的 children 成立了自己的树.
请勿使用以下方法来删除模型
Menu::destroy(1);
Menu::where('id', 1)->delete()
因为这些操作不会触发BeforeDelete事件
<?php
// 清理冗余的关联信息
Menu::deleteRedundancies();
$menu = Menu::find(20);
// 修复此节点的关联, 它将重新建立 `closure` 表里的记录
$menu->perfectNode();
// 修复树关联,注意:这个操作将追朔到到根节点然后从根遍历整颗树调用perfectNode(),如果你的树很庞大将耗费大量资源,请慎用.
// 解决方案是使用队列对每个节点使用 perfectNode()
$menu->perfectTree();$ composer require hsen/tp6-closure-table-
你的模型中必要的列
id,pid, -
closure表必要的列ancestor,descendant,depth
示例:
<?php
$this->table('{{closure_table}}',['id'=>false,'primary_key' => ['ancestor','descendant']])
->addColumn('ancestor','integer',['limit'=>2,'null'=>false,'default'=>0,'comment'=>'祖先节点'])
->addColumn('descendant','integer',['limit'=>2,'null'=>false,'default'=>0,'comment'=>'后代节点'])
->addColumn('depth','integer',['limit'=>2,'null'=>false,'default'=>0,'comment'=>'距离'])
->create();-
在
model里引入 traiths\ClosureTable\Traits\ClosureTable. -
(非必要)如果你想自定义关联表名和字段，可在
model里定义以下属性:$closureTable,$ancestorColumn,$descendantColumn,$distanceColumn. -
(非必要)如果你想自定义
parent字段,在model里定义属性$parentColumn.
如下示例:
<?php
namespace App;
use think\Model;
use hs\ClosureTable\Traits\ClosureTable;
class Menu extends Model
{
// (必要)引入ClosureTable.
use ClosureTable;
// (非必要)关联表名，默认'Model类名+_closure',如'menu_closure'
protected $closureTable = 'menu_closure';
// (非必要)ancestor列名,默认'ancestor'
protected $ancestorColumn = 'ancestor';
// (非必要)descendant列名,默认'descendant'
protected $descendantColumn = 'descendant';
// (非必要)distance列名,默认'distance'
protected $distanceColumn = 'distance';
// (非必要)parent列名,默认'parent'
protected $parentColumn = 'pid';
}接下来,你就可以自由的使用ClosureTable带来的所有功能了.
非常感谢composer包jiaxincui/closure-table