CKTIS / Java
BlockingQueue : insérer, retirer et consulter des éléments
Choisissez entre une opération immédiate, une attente limitée et une attente sans limite. Découvrez comment consulter la file et quand l’ordre FIFO s’applique.
Version : Java SE 21
Syntaxe
java.util.concurrent.BlockingQueue<E> — Java SE 21
boolean offer(E e);
boolean offer(E e, long timeout, TimeUnit unit) throws InterruptedException;
E poll();
E poll(long timeout, TimeUnit unit) throws InterruptedException;
void put(E e) throws InterruptedException;
E take() throws InterruptedException;
E peek();
int size();java.util.concurrent.BlockingQueue<E> est une file utilisable par plusieurs threads, notamment pour transmettre du travail des producteurs aux consommateurs. offer(e) n’attend pas de place : elle renvoie true si l’insertion réussit et false s’il n’y a pas de place. offer(e, timeout, unit) attend une place si nécessaire et renvoie false si le délai expire avant qu’une place ne se libère. put(e) a pour type de retour void et attend une place si nécessaire, sans limite de temps.
poll() retire et renvoie l’élément en tête, ou renvoie null si la file est vide, sans attendre un élément. poll(timeout, unit) retire et renvoie aussi l’élément en tête, mais peut l’attendre et renvoie null si le délai expire avant qu’un élément soit disponible. take() retire et renvoie l’élément en tête, en attendant si nécessaire sans limite de temps. Les deux surcharges avec délai utilisent TimeUnit, par exemple 1, TimeUnit.MILLISECONDS. Ces surcharges, ainsi que put et take, lèvent InterruptedException si le thread est interrompu pendant l’attente.
peek(), héritée de Queue, renvoie l’élément en tête sans le retirer, ou null si la file est vide. size(), héritée de Collection, renvoie le nombre d’éléments sous forme d’int, et non la capacité. Si la file contient plus de Integer.MAX_VALUE éléments, la méthode renvoie Integer.MAX_VALUE. Un autre thread peut modifier la file entre deux appels : size() > 0 ne garantit pas qu’un take() ultérieur n’attendra pas. Insérer null avec offer ou put provoque une NullPointerException.
ArrayBlockingQueue a une capacité fixe ; avec LinkedBlockingQueue, on peut spécifier une limite de capacité. Toutes deux suivent l’ordre FIFO : parmi les éléments encore présents, le premier inséré est le premier retiré. L’interface ne garantit pas elle-même cet ordre. PriorityBlockingQueue retire le plus petit élément selon l’ordre naturel ou le comparateur fourni, sans ordre garanti entre éléments à égalité. Elle n’a pas de limite de capacité intrinsèque : son put et son offer avec délai n’attendent pas de place.
Exemples
import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.PriorityBlockingQueue;
import java.util.concurrent.TimeUnit;
public class BlockingQueueDemo {
public static void main(String[] args) throws InterruptedException {
BlockingQueue<Integer> fifo = new ArrayBlockingQueue<>(2);
fifo.put(20);
System.out.println("offer with space: " + fifo.offer(10));
System.out.println("offer when full: " + fifo.offer(30));
System.out.println("timed offer when full: "
+ fifo.offer(30, 1, TimeUnit.MILLISECONDS));
System.out.println("peek: " + fifo.peek());
System.out.println("size after peek: " + fifo.size());
System.out.println("take: " + fifo.take());
System.out.println("poll: " + fifo.poll());
System.out.println("poll when empty: " + fifo.poll());
System.out.println("timed poll when empty: "
+ fifo.poll(1, TimeUnit.MILLISECONDS));
BlockingQueue<Integer> priority = new PriorityBlockingQueue<>();
priority.put(20);
priority.put(10);
System.out.println("priority take: " + priority.take());
}
}
Résultat
offer with space: true offer when full: false timed offer when full: false peek: 20 size after peek: 2 take: 20 poll: 10 poll when empty: null timed poll when empty: null priority take: 10
Deux éléments remplissent la file FIFO. `peek()` indique `20`, mais la taille reste `2`. `take()` retire `20`, puis `poll()` retire `10`. Les deux appels avec un délai de `1` ms illustrent les résultats en cas d’échec, pas le temps écoulé. La file de priorité retire `10` en premier.
Leçons associées
- Java · Leçon 37 · Avancé · Version : 2