lsm/hutool
1
0
Fork 0
mirror of https://gitee.com/dromara/hutool.git synced 2025-05-09 15:17:59 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

!988 优化 HierarchyUtil文档及其测试用例

Browse Source 
Merge pull request !988 from emptypoint/update-HierarchyUtil
This commit is contained in:
Looly 2023-05-09 02:12:34 +00:00 committed by Gitee
commit 8051611bd7
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
4 changed files with 59 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hutool-core/src/main/java/org/dromara/hutool/core/tree/hierarchy/HierarchyIterator.java
View File

@ -43,7 +43,7 @@ public interface HierarchyIterator<H, R> {
* *
* @param result 结果 * @param result 结果
* @param hierarchy 当前层级 * @param hierarchy 当前层级
* @return 向容器中添加元素的方法 * @return 下一需要遍历的层级
*/ */
Collection<H> nextHierarchies(R result, H hierarchy); Collection<H> nextHierarchies(R result, H hierarchy);

2
hutool-core/src/main/java/org/dromara/hutool/core/tree/hierarchy/HierarchyIteratorImpl.java
View File

@ -50,7 +50,7 @@ public class HierarchyIteratorImpl<H, R> implements HierarchyIterator<H, R> {
* *
* @param result 结果 * @param result 结果
* @param hierarchy 当前层级 * @param hierarchy 当前层级
* @return 向容器中添加元素的方法 * @return 下一需要遍历的层级
*/ */
@Override @Override
public Collection<H> nextHierarchies(final R result, final H hierarchy) { public Collection<H> nextHierarchies(final R result, final H hierarchy) {

8
hutool-core/src/main/java/org/dromara/hutool/core/tree/hierarchy/HierarchyUtil.java
View File

@ -35,11 +35,11 @@ import java.util.function.Predicate;
* Node root = Tree.build(); * Node root = Tree.build();
* // 从树结构中通过深度优先查找某个节点 * // 从树结构中通过深度优先查找某个节点
* Node target = HierarchyUtil.traverseByDepthFirst( * Node target = HierarchyUtil.traverseByDepthFirst(
* root, HierarchyUtil.finder(Node::getChildren, node -> Objects.equals(node.getId(), "target") ? node : null) * root, HierarchyIteratorUtil.find(Node::getChildren, node -> Objects.equals(node.getId(), "target") ? node : null)
* ); * );
* // 从树结构中通过广度优先获取其所有的子节点 * // 从树结构中通过广度优先获取其所有的子节点
* List<Node> nodes = HierarchyUtil.traverseByBreadthFirst( * List<Node> nodes = HierarchyUtil.traverseByBreadthFirst(
* root, HierarchyUtil.collector(Node::getChildren) * root, HierarchyIteratorUtil.collect(Node::getChildren)
* ); * );
* }</pre> * }</pre>
* *
@ -123,17 +123,15 @@ public class HierarchyUtil {
Objects.requireNonNull(hierarchyIterator); Objects.requireNonNull(hierarchyIterator);
// 遍历层级结构 // 遍历层级结构
final Predicate<? super H> hierarchyFilter = filter.negate();
final LinkedList<H> queue = new LinkedList<>(); final LinkedList<H> queue = new LinkedList<>();
final Set<H> accessed = new HashSet<>(); final Set<H> accessed = new HashSet<>();
queue.add(hierarchy); queue.add(hierarchy);
while (!queue.isEmpty()) { while (!queue.isEmpty()) {
// 跳过已经访问过或者被过滤的层级结构 // 跳过已经访问过或者被过滤的层级结构
final H curr = queue.removeFirst(); final H curr = queue.removeFirst();
if (accessed.contains(curr) || hierarchyFilter.test(curr)) { if (!accessed.add(curr) || !filter.test(curr)) {
continue; continue;
} }
accessed.add(curr);
// 若迭代器返回true，则结束遍历 // 若迭代器返回true，则结束遍历
if (hierarchyIterator.isBreak(curr)) { if (hierarchyIterator.isBreak(curr)) {

106
hutool-core/src/test/java/org/dromara/hutool/core/tree/hierarchy/HierarchyUtilTest.java
View File

@ -12,13 +12,12 @@
package org.dromara.hutool.core.tree.hierarchy; package org.dromara.hutool.core.tree.hierarchy;
import lombok.Data;
import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import java.util.*; import java.util.*;
import java.util.function.Function;
import java.util.stream.Collectors;
/** /**
* test for {@link HierarchyUtil} * test for {@link HierarchyUtil}
@ -27,63 +26,72 @@ import java.util.stream.Collectors;
*/ */
class HierarchyUtilTest { class HierarchyUtilTest {
private Map<String, String> tree; @Data
static class Node {
private String parent;
private String value;
private List<Node> children;
public Node(String parent, String value) {
this.parent = parent;
this.value = value;
}
}
private Node root;
@BeforeEach @BeforeEach
void init() { void init() {
tree = new LinkedHashMap<>();
// 根节点 // 根节点
tree.put("0", null); root = new Node(null, "0");
// 第一层 // 第二层
tree.put("0-1", "0"); Node first1 = new Node(root.value, "0-1");
tree.put("0-2", "0"); Node first2 = new Node(root.value, "0-2");
tree.put("0-3", "0"); Node first3 = new Node(root.value, "0-3");
root.setChildren(Arrays.asList(first1, first2, first3));
// 第三层 // 第三层
tree.put("0-1-1", "0-1"); Node second11 = new Node(first1.value, "0-1-1");
tree.put("0-1-2", "0-1"); Node second12 = new Node(first1.value, "0-1-2");
tree.put("0-1-3", "0-1"); Node second13 = new Node(first1.value, "0-1-3");
first1.setChildren(Arrays.asList(second11, second12, second13));
tree.put("0-2-1", "0-2"); Node second21 = new Node(first2.value, "0-2-1");
tree.put("0-2-2", "0-2"); Node second22 = new Node(first2.value, "0-2-2");
tree.put("0-2-3", "0-2"); Node second23 = new Node(first2.value, "0-2-3");
first2.setChildren(Arrays.asList(second21, second22, second23));
tree.put("0-3-1", "0-3"); Node second31 = new Node(first3.value, "0-3-1");
tree.put("0-3-2", "0-3"); Node second32 = new Node(first3.value, "0-3-2");
tree.put("0-3-3", "0-3"); Node second33 = new Node(first3.value, "0-3-3");
first3.setChildren(Arrays.asList(second31, second32, second33));
} }
@Test @Test
void testTraverseByBreadthFirst() { void testTraverseByBreadthFirst() {
// 按广度优先遍历所有节点 // // 按广度优先遍历所有节点
final Set<String> nodes = new LinkedHashSet<>(); final List<String> nodes = new ArrayList<>();
HierarchyUtil.traverseByBreadthFirst("0", HierarchyIteratorUtil.scan(t -> { HierarchyUtil.traverseByBreadthFirst(root, HierarchyIteratorUtil.scan(t -> {
nodes.add(t); nodes.add(t.getValue());
return tree.entrySet().stream() return t.getChildren();
.filter(e -> Objects.equals(t, e.getValue()))
.map(Map.Entry::getKey)
.collect(Collectors.toList());
})); }));
Assertions.assertEquals(13, nodes.size()); Assertions.assertEquals(13, nodes.size());
Assertions.assertEquals( Assertions.assertEquals(
new LinkedHashSet<>(Arrays.asList("0", "0-1", "0-2", "0-3", "0-1-1", "0-1-2", "0-1-3", "0-2-1", "0-2-2", "0-2-3", "0-3-1", "0-3-2", "0-3-3")), Arrays.asList("0", "0-1", "0-2", "0-3", "0-1-1", "0-1-2", "0-1-3", "0-2-1", "0-2-2", "0-2-3", "0-3-1", "0-3-2", "0-3-3"),
nodes nodes
); );
// 按广度优先寻找 0-2-3 // 按广度优先寻找 0-2-3
final String target = HierarchyUtil.traverseByBreadthFirst("0", HierarchyIteratorUtil.find(parentFinder(), final String target = HierarchyUtil.traverseByBreadthFirst(root, HierarchyIteratorUtil.find(Node::getChildren,
t -> Objects.equals(t, "0-2-3") ? t : null t -> Objects.equals(t.getValue(), "0-2-3") ? t.getValue() : null
)); ));
Assertions.assertEquals("0-2-3", target); Assertions.assertEquals("0-2-3", target);
// 按广度优先获取 0-2 的所有子节点 // 按广度优先获取 0-2 的所有子节点
final List<String> children = HierarchyUtil.traverseByBreadthFirst( final List<String> children = HierarchyUtil.traverseByBreadthFirst(root, HierarchyIteratorUtil.collect(Node::getChildren,
"0", HierarchyIteratorUtil.collect(parentFinder(), t -> Objects.equals(t.getParent(), "0-2") ? t.getValue() : null
t -> Objects.equals(tree.get(t), "0-2") ? t : null ));
)
);
Assertions.assertEquals(3, children.size()); Assertions.assertEquals(3, children.size());
Assertions.assertEquals(new ArrayList<>(Arrays.asList("0-2-1", "0-2-2", "0-2-3")), children); Assertions.assertEquals(new ArrayList<>(Arrays.asList("0-2-1", "0-2-2", "0-2-3")), children);
} }
@ -92,12 +100,9 @@ class HierarchyUtilTest {
void testTraverseByDepthFirst() { void testTraverseByDepthFirst() {
// 按深度优先遍历所有节点 // 按深度优先遍历所有节点
final Set<String> nodes = new LinkedHashSet<>(); final Set<String> nodes = new LinkedHashSet<>();
HierarchyUtil.traverseByDepthFirst("0", HierarchyIteratorUtil.scan(t -> { HierarchyUtil.traverseByDepthFirst(root, HierarchyIteratorUtil.scan(t -> {
nodes.add(t); nodes.add(t.getValue());
return tree.entrySet().stream() return t.getChildren();
.filter(e -> Objects.equals(t, e.getValue()))
.map(Map.Entry::getKey)
.collect(Collectors.toList());
})); }));
Assertions.assertEquals(13, nodes.size()); Assertions.assertEquals(13, nodes.size());
Assertions.assertEquals( Assertions.assertEquals(
@ -106,26 +111,17 @@ class HierarchyUtilTest {
); );
// 按深度优先寻找 0-2-3 // 按深度优先寻找 0-2-3
final String target = HierarchyUtil.traverseByDepthFirst("0", HierarchyIteratorUtil.find(parentFinder(), final String target = HierarchyUtil.traverseByDepthFirst(root, HierarchyIteratorUtil.find(Node::getChildren,
t -> Objects.equals(t, "0-2-3") ? t : null t -> Objects.equals(t.getValue(), "0-2-3") ? t.getValue() : null
)); ));
Assertions.assertEquals("0-2-3", target); Assertions.assertEquals("0-2-3", target);
// 按深度优先获取 0-2 的所有子节点 // 按深度优先获取 0-2 的所有子节点
final List<String> children = HierarchyUtil.traverseByDepthFirst( final List<String> children = HierarchyUtil.traverseByDepthFirst(root, HierarchyIteratorUtil.collect(Node::getChildren,
"0", HierarchyIteratorUtil.collect(parentFinder(), t -> Objects.equals(t.getParent(), "0-2") ? t.getValue() : null
t -> Objects.equals(tree.get(t), "0-2") ? t : null ));
)
);
Assertions.assertEquals(3, children.size()); Assertions.assertEquals(3, children.size());
Assertions.assertEquals(new ArrayList<>(Arrays.asList("0-2-1", "0-2-2", "0-2-3")), children); Assertions.assertEquals(new ArrayList<>(Arrays.asList("0-2-1", "0-2-2", "0-2-3")), children);
} }
private Function<String, Collection<String>> parentFinder() {
return t -> tree.entrySet()
.stream()
.filter(e -> Objects.equals(t, e.getValue()))
.map(Map.Entry::getKey)
.collect(Collectors.toList());
}
} }