fix: handle awaitTermination result and ensure proper ExecutorService shutdown (#3244)

* fix: handle awaitTermination result and ensure proper ExecutorService shutdown

- Added handling for the result of awaitTermination to avoid Sonar warning
- Wrapped ExecutorService with try-finally for proper shutdown (java:S2095)
- Prevents potential resource leak and aligns with best practices

Fixes: #2865

Note: ExecutorService is not AutoCloseable, so try-with-resources is not applicable. Used try-finally instead.

* fix: add missing logger definition for SLF4J

- Defined logger explicitly with LoggerFactory.getLogger(...)
- Ensured compatibility with Lombok's @Slf4j annotation
- Fixed compilation error caused by missing 'log' variable

* fix: add missing logger definition for SLF4J
This commit is contained in:
Kim Gi Uk
2025-04-11 01:33:40 +09:00
committed by GitHub
parent 44f6ab3fd4
commit 6cadf253ba
@@ -1,61 +1,13 @@
/*
* This project is licensed under the MIT license. Module model-view-viewmodel is using ZK framework licensed under LGPL (see lgpl-3.0.txt).
*
* The MIT License
* Copyright © 2014-2022 Ilkka Seppälä
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.iluwatar.leaderfollowers;
import java.security.SecureRandom;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
import lombok.extern.slf4j.Slf4j;
/**
* Leader/Followers pattern is a concurrency pattern. This pattern behaves like a taxi stand where
* one of the threads acts as leader thread which listens for event from event sources,
* de-multiplexes, dispatches and handles the event. It promotes the follower to be the new leader.
* When processing completes the thread joins the followers queue, if there are no followers then it
* becomes the leader and cycle repeats again.
*
* <p>In this example, one of the workers becomes Leader and listens on the {@link TaskSet} for
* work. {@link TaskSet} basically acts as the source of input events for the {@link Worker}, who
* are spawned and controlled by the {@link WorkCenter} . When {@link Task} arrives then the leader
* takes the work and calls the {@link TaskHandler}. It also calls the {@link WorkCenter} to
* promotes one of the followers to be the new leader, who can then process the next work and so on.
*
* <p>The pros for this pattern are: It enhances CPU cache affinity and eliminates unbound
* allocation and data buffer sharing between threads by reading the request into buffer space
* allocated on the stack of the leader or by using the Thread-Specific Storage pattern [22] to
* allocate memory. It minimizes locking overhead by not exchanging data between threads, thereby
* reducing thread synchronization. In bound handle/thread associations, the leader thread
* dispatches the event based on the I/O handle. It can minimize priority inversion because no extra
* queuing is introduced in the server. It does not require a context switch to handle each event,
* reducing the event dispatching latency. Note that promoting a follower thread to fulfill the
* leader role requires a context switch. Programming simplicity: The Leader/Followers pattern
* simplifies the programming of concurrency models where multiple threads can receive requests,
* process responses, and de-multiplex connections using a shared handle set.
*/
@Slf4j
public class App {
/** The main method for the leader followers pattern. */
public static void main(String[] args) throws InterruptedException {
var taskSet = new TaskSet();
var taskHandler = new TaskHandler();
@@ -64,18 +16,23 @@ public class App {
execute(workCenter, taskSet);
}
/** Start the work, dispatch tasks and stop the thread pool at last. */
private static void execute(WorkCenter workCenter, TaskSet taskSet) throws InterruptedException {
var workers = workCenter.getWorkers();
var exec = Executors.newFixedThreadPool(workers.size());
workers.forEach(exec::submit);
Thread.sleep(1000);
addTasks(taskSet);
exec.awaitTermination(2, TimeUnit.SECONDS);
exec.shutdownNow();
try {
workers.forEach(exec::submit);
Thread.sleep(1000);
addTasks(taskSet);
boolean terminated = exec.awaitTermination(2, TimeUnit.SECONDS);
if (!terminated) {
LOGGER.warn("Executor did not terminate in the given time.");
}
} finally {
exec.shutdownNow();
}
}
/** Add tasks. */
private static void addTasks(TaskSet taskSet) throws InterruptedException {
var rand = new SecureRandom();
for (var i = 0; i < 5; i++) {