Java Stream Collector 高级用法：定制化累加器与收集器实现-java教程-PHP中文网

java stream collector 高级用法：定制化累加器与收集器实现

本文深入探讨了 Java Stream API 中 Collector 的高级定制化实现，重点讲解了如何灵活选择和设计累加器类型 (A)，以及如何使用 Collector.of() 方法构建自定义收集器。通过具体示例，展示了利用基本类型数组、现有可变类型、匿名内部类等作为累加器，有效避免了不必要的类创建，提升了代码的简洁性和灵活性。

理解 Collector 接口及其泛型

java.util.stream.Collector 接口是 Java Stream API 中一个核心组件，用于将流中的元素聚合成一个结果。它定义了三种泛型类型：

T：流中元素的类型。
A：累加器（accumulator）的类型，这是一个可变的中间结果类型，用于在收集过程中存储状态。它通常是实现细节，不对外暴露。
R：最终结果的类型，即收集操作完成后返回的类型。

要创建一个自定义的 Collector，最常用的方法是使用 Collector.of() 工厂方法，它需要四个核心函数式接口作为参数：

supplier: 一个 Supplier<A>，用于创建新的累加器实例。
accumulator: 一个 BiConsumer<A, T>，用于将流中的单个元素 T 合并到累加器 A 中。
combiner: 一个 BinaryOperator<A>，用于将两个累加器 A 合并成一个（在并行流中特别有用）。
finisher: 一个 Function<A, R>，用于将最终的累加器 A 转换成最终结果 R。

一个常见的误解是，累加器类型 A 必须是一个独立的、专门为此目的创建的具名类，并且其方法（如 supply、accumulate、combine、finish）需要直接在 Collector 的实现中引用该类的静态方法或实例方法。实际上，Collector.of() 的函数参数提供了极大的灵活性，允许我们使用各种方式来定义这些行为，而无需强制创建额外的具名类。

灵活选择累加器类型

累加器类型 A 的选择是实现自定义 Collector 的关键。它不一定非得是一个复杂的自定义类，可以是以下几种类型：

立即学习“Java免费学习笔记（深入）”；

1. 使用基本类型数组作为累加器

对于简单的数值累加，一个单元素的基本类型数组（如 int[]）是一个非常高效且简洁的累加器。它提供了可变性，并且避免了装箱拆箱的开销。

示例：计算流中整数的和

import java.util.stream.Collector;
import java.util.stream.Stream;

public class CustomSumCollector {

    /**
     * 创建一个收集器，用于计算整数流的总和。
     * 累加器类型为 int[1]，其中数组的第一个元素存储当前和。
     *
     * @return 收集整数到其总和的收集器。
     */
    public static Collector<Integer, ?, Integer> sum() {
        return Collector.of(
            () -> new int[1], // supplier: 创建一个长度为1的int数组作为累加器
            (a, i) -> a[0] += i, // accumulator: 将元素i加到数组的第一个元素
            (a, b) -> { a[0] += b[0]; return a; }, // combiner: 合并两个累加器
            a -> a[0], // finisher: 返回数组的第一个元素作为最终结果
            Collector.Characteristics.UNORDERED // 标识收集器不关心元素顺序
        );
    }

    public static void main(String[] args) {
        Stream<Integer> numbers = Stream.of(1, 2, 3, 4, 5);
        Integer totalSum = numbers.collect(sum());
        System.out.println("Sum using custom collector: " + totalSum); // Output: Sum using custom collector: 15
    }
}

登录后复制

在这个例子中，int[1] 作为累加器 A，简洁地完成了累加任务。

2. 使用现有可变类型作为累加器

Java 标准库中提供了许多可变的类，它们可以直接用作累加器，特别是当需要考虑线程安全时。

示例：使用 AtomicInteger 计算流中整数的和（并发安全）

import java.util.concurrent.atomic.AtomicInteger;
import java.util.stream.Collector;
import java.util.stream.Stream;

public class ConcurrentSumCollector {

    /**
     * 创建一个并发安全的收集器，用于计算整数流的总和。
     * 累加器类型为 AtomicInteger。
     *
     * @return 并发收集整数到其总和的收集器。
     */
    public static Collector<Integer, ?, Integer> concurrentSum() {
        return Collector.of(
            AtomicInteger::new, // supplier: 创建一个新的 AtomicInteger 实例
            AtomicInteger::addAndGet, // accumulator: 将元素i原子地加到 AtomicInteger 中
            (a, b) -> { a.addAndGet(b.intValue()); return a; }, // combiner: 合并两个 AtomicInteger
            AtomicInteger::intValue, // finisher: 返回 AtomicInteger 的值作为最终结果
            Collector.Characteristics.UNORDERED,
            Collector.Characteristics.CONCURRENT // 标识收集器支持并发
        );
    }

    public static void main(String[] args) {
        Stream<Integer> numbers = Stream.of(1, 2, 3, 4, 5);
        Integer totalSum = numbers.collect(concurrentSum());
        System.out.println("Concurrent sum using custom collector: " + totalSum); // Output: Concurrent sum using custom collector: 15
    }
}

登录后复制

AtomicInteger 天然提供了线程安全的原子操作，非常适合在并行流中使用。

3. 使用匿名内部类或 Ad-hoc 类型作为累加器

当没有合适的现有类型，并且不想创建新的具名类时，可以使用匿名内部类或 Object 的子类（通常通过 new Object() {} 语法）作为累加器。这种方式将累加器的定义局部化在 Collector 的实现内部，增加了封装性。

集简云

软件集成平台，快速建立企业自动化与智能化

查看详情

示例：收集 Map.Entry 流中具有最大值的键列表

假设我们有一个 Map.Entry<K, Integer> 的流，我们希望找出所有具有最大值的键，并以 List<K> 的形式返回。

方法一：使用 AbstractMap.SimpleEntry 作为累加器

AbstractMap.SimpleEntry 可以作为一个简单的键值对容器，这里我们用它来存储当前找到的最大值 (Integer) 和对应的键列表 (List<K>)。

import java.util.*;
import java.util.stream.Collector;
import java.util.stream.Stream;

public class KeysToMaximumCollector {

    /**
     * 收集 Map.Entry 流中具有最大值的键列表。
     * 累加器类型为 AbstractMap.SimpleEntry<List<K>, Integer>。
     *
     * @param <K> 键的类型
     * @return 收集器，返回具有最大值的键列表。
     */
    public static <K> Collector<Map.Entry<K, Integer>, ?, List<K>> keysToMaximum() {
        return Collector.of(
            () -> new AbstractMap.SimpleEntry<>(new ArrayList<>(), Integer.MIN_VALUE), // supplier: 初始累加器
            (current, next) -> { // accumulator: 处理每个 Map.Entry
                int max = current.getValue();
                int value = next.getValue();
                if (value >= max) {
                    if (value > max) { // 找到更大的值，清空旧列表，更新最大值
                        current.setValue(value);
                        current.getKey().clear();
                    }
                    current.getKey().add(next.getKey()); // 添加当前键
                }
            },
            (a, b) -> { // combiner: 合并两个累加器
                int maxA = a.getValue();
                int maxB = b.getValue();
                if (maxA < maxB) return b; // B 的最大值更大，返回 B
                if (maxA == maxB) a.getKey().addAll(b.getKey()); // 最大值相同，合并键列表
                return a; // 否则返回 A
            },
            Map.Entry::getKey // finisher: 返回累加器中的键列表
        );
    }

    public static void main(String[] args) {
        Map<String, Integer> map = new HashMap<>();
        map.put("A", 10);
        map.put("B", 20);
        map.put("C", 15);
        map.put("D", 20);
        map.put("E", 5);

        List<String> keys = map.entrySet().stream().collect(keysToMaximum());
        System.out.println("Keys with maximum value: " + keys); // Output: Keys with maximum value: [B, D] (顺序可能不同)
    }
}

登录后复制

方法二：使用匿名内部类作为累加器

这种方式创建了一个只在 Collector 内部可见的、具有特定字段的匿名对象作为累加器。

import java.util.*;
import java.util.stream.Collector;
import java.util.stream.Stream;

public class KeysToMaximumAdHocCollector {

    /**
     * 收集 Map.Entry 流中具有最大值的键列表。
     * 累加器类型为匿名内部类。
     *
     * @param <K> 键的类型
     * @return 收集器，返回具有最大值的键列表。
     */
    public static <K> Collector<Map.Entry<K, Integer>, ?, List<K>> keysToMaximum() {
        return Collector.of(
            () -> new Object() { // supplier: 创建一个匿名内部类实例作为累加器
                int max = Integer.MIN_VALUE;
                final List<K> keys = new ArrayList<>();
            },
            (current, next) -> { // accumulator: 处理每个 Map.Entry
                int value = next.getValue();
                if (value >= current.max) {
                    if (value > current.max) {
                        current.max = value;
                        current.keys.clear();
                    }
                    current.keys.add(next.getKey());
                }
            },
            (a, b) -> { // combiner: 合并两个匿名内部类累加器
                if (a.max < b.max) return b;
                if (a.max == b.max) a.keys.addAll(b.keys);
                return a;
            },
            a -> a.keys // finisher: 返回累加器中的键列表
        );
    }

    public static void main(String[] args) {
        Map<String, Integer> map = new HashMap<>();
        map.put("A", 10);
        map.put("B", 20);
        map.put("C", 15);
        map.put("D", 20);
        map.put("E", 5);

        List<String> keys = map.entrySet().stream().collect(keysToMaximum());
        System.out.println("Keys with maximum value (ad-hoc): " + keys); // Output: Keys with maximum value (ad-hoc): [B, D] (顺序可能不同)
    }
}

登录后复制

这两种方法都避免了为累加器单独创建一个具名类，使代码更加紧凑和局部化。

注意事项与总结

累加器类型的选择：
- 简单场景：考虑使用基本类型数组（如 int[]）或现有可变容器（如 ArrayList、StringBuilder）作为累加器，它们通常更高效且简洁。
- 并发场景：使用 AtomicInteger、ConcurrentHashMap 等并发工具类作为累加器，并添加 Collector.Characteristics.CONCURRENT 特性。
- 复杂场景或封装需求：当需要封装多个状态时，可以考虑 AbstractMap.SimpleEntry 或匿名内部类。如果逻辑非常复杂，或者该累加器类型需要在多个 Collector 中复用，那么创建一个具名类仍然是更好的选择。
函数式接口的实现：
- supplier、accumulator、combiner、finisher 可以是方法引用 (ClassName::methodName) 或 Lambda 表达式。它们不要求是累加器类型 A 自身的成员方法，这提供了极大的灵活性。
- combiner 函数的正确实现对于并行流至关重要。它必须能够正确地将两个部分累加器合并为一个。
- finisher 函数负责将中间的累加器状态转换为最终结果。如果累加器本身就是最终结果，finisher 可以简单地返回累加器本身（即 Function.identity()）。
Collector.Characteristics：
- UNORDERED：表示收集器不关心流的顺序。
- CONCURRENT：表示收集器可以支持并行执行，即 accumulator 可以被多个线程调用，并且 combiner 可以被跳过（如果 supplier 返回一个线程安全的可变结果容器）。
- IDENTITY_FINISH：表示 finisher 函数是一个恒等函数（Function.identity()），即累加器类型 A 和结果类型 R 相同。