Java中的 BlockingQueue drainTo() 方法及示例

Introduction

Java中的BlockingQueue是一个很重要的队列实现，它可以让我们方便地使用生产者消费者模式来管理我们的线程安全数据结构。BlockingQueue同样提供了丰富的方法，其中一个常用的方法就是drainTo()，本文将会对drainTo()方法进行详细介绍并提供示例代码。

What is drainTo() in BlockingQueue

drainTo()是BlockingQueue提供的一个方法，它可以一次性从队列中取出指定数量的元素，并将这些元素放入另一个集合中。drainTo()方法有两个重载版本：

int drainTo(Collection<? super E> c);

这个方法会一次性将队列中所有元素取出来放入参数c中，并返回取出元素的数量。

int drainTo(Collection<? super E> c, int maxElements);

这个方法会一次性从队列中最多取出maxElements个元素，放入参数c中，并返回取出元素的数量。

需要使用注意的是，如果队列中没有元素，drainTo()方法将会立即返回0。

Examples

下面是使用drainTo()方法的一个示例，我们将从一个阻塞队列中取出一定数量的元素并将它们打印出来。

import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.BlockingQueue;

public class BlockingQueueExample {

    public static void main(String[] args) {

        // 创建一个阻塞队列
        BlockingQueue<Integer> queue = new ArrayBlockingQueue<>(10);

        // 生产者放入元素
        for (int i = 0; i < 10; i++) {
            queue.offer(i);
        }

        // 定义一个集合用于存放取出的元素
        List<Integer> list = new ArrayList<>();

        // 一次性从队列中取出3个元素
        int result = queue.drainTo(list, 3);
        System.out.println("取出了" + result + "个元素");

        // 打印存放在集合中的元素
        System.out.println("存放在集合中的元素：");
        for (int value : list) {
            System.out.println(value);
        }

        // 打印队列中剩余的元素
        System.out.println("队列中剩余的元素：");
        for (int value : queue) {
            System.out.println(value);
        }
    }
}

程序结果输出如下：

取出了3个元素
存放在集合中的元素：
0
1
2
队列中剩余的元素：
3
4
5
6
7
8
9

我们可以看到，drainTo()方法从队列中成功取出了3个元素，并存放在了list集合中。同时，我们也可以看到在队列中剩余的元素仍然保留。