基于Java的Queue容器做一个简单的的消息队列

基于Java的Queue容器做一个简单的的消息队列

简介：使用java的Queue容器制作一个简单的消息队列

设计思路

类定义

public class MessageQueue<T>

MessageQueue是一个泛型类，它允许你创建一个可以存储任何类型对象的队列。这里的T是泛型参数，代表队列中存储的消息类型。

成员变量

• private Queue<T> queue;
  一个队列，用于存储消息。这里使用的是LinkedList来实现队列的功能。

• private int capacity;
  队列的容量，即队列中最多可以存放的消息数量。

• private Lock lock;
  一个锁对象，用于同步对队列的访问。这里使用的是ReentrantLock，它是java.util.concurrent.locks包中的一个可重入锁。

• private Condition notEmpty;
  一个条件对象，表示队列非空的条件。生产者会在队列为空时等待这个条件。

• private Condition notFull;
  另一个条件对象，表示队列未满的条件。消费者会在队列满时等待这个条件。

构造函数

public MessageQueue(int capacity)

构造函数接收一个整数参数capacity，用于初始化队列的容量。同时，它还会初始化队列、锁对象和两个条件对象。

put方法

public void put(T message) throws InterruptedException

此方法用于向队列中添加消息。如果队列已满，生产者将等待直到队列有空间。一旦有空间，生产者将消息放入队列，并通知可能正在等待的消费者。

take方法

public T take() throws InterruptedException

此方法用于从队列中取出消息。如果队列为空，消费者将等待直到队列中有消息。一旦队列中有消息，消费者取出消息，并通知可能正在等待的生产者。

锁和条件的使用

• lock.lock(); 和 lock.unlock();
  这些方法用于获取和释放锁，确保对队列的操作是线程安全的。

• notEmpty.await(); 和 notFull.await();
  当队列不满足操作条件时（队列满或空），相应的线程将等待。

• notEmpty.signal(); 和 notFull.signal();
  当操作完成，且之前有线程在等待时，唤醒等待的线程。

这个类通过使用锁和条件对象来实现线程间的协调，确保了在多线程环境下队列的安全性和效率。

代码如下：

import java.util.LinkedList;
import java.util.Queue;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;
import java.util.concurrent.locks.Condition;

public class MessageQueue<T> {
    private Queue<T> queue; // 存储消息的队列
    private int capacity;   // 队列容量
    private Lock lock;      // 锁对象
    private Condition notEmpty;  // 队列不为空的条件
    private Condition notFull;  // 队列不满的条件

    /**
     * 构造函数，初始化队列、容量、锁对象和条件。
     * @param capacity 队列容量
     */
    public MessageQueue(int capacity) {
        this.capacity = capacity;
        this.queue = new LinkedList<>(); // 使用LinkedList实现队列
        this.lock = new ReentrantLock(); // 使用ReentrantLock实现锁
        this.notEmpty = lock.newCondition(); // 非空条件
        this.notFull = lock.newCondition(); // 非满条件
    }

    /**
     * 向队列里面添加消息
     * @param message 要添加的消息
     * @throws InterruptedException 当等待时被中断
     */
    public void put(T message) throws InterruptedException {
        lock.lock();
        try {
            while (queue.size() >= capacity) { // 队列满了
                notFull.await(); // 等待队列不满
            }
            queue.add(message); // 添加消息到队列
            notEmpty.signal(); // 唤醒等待的消费者
        } finally {
            lock.unlock(); // 释放锁
        }
    }

    /**
     * 从队列里面取出消息
     * @return 取出的消息
     * @throws InterruptedException 当等待时被中断
     */
    public T take() throws InterruptedException {
        lock.lock();
        try {
            while (queue.isEmpty()) { // 队列为空时
                notEmpty.await(); // 等待队列不空
            }
            T message = queue.poll(); // 从队列里面取出消息
            notFull.signal(); // 唤醒等待的线程
            return message;
        } finally {
            lock.unlock(); // 释放锁
        }
    }
}