1. Overview
In this article, You'll learn how to delay the code execution for some seconds or minutes in java. This quite simple and easy to force the code to sleep or pause for some time and do the remaining execution or waiting for another task to complete.
You might be seeing this is needed when you have any failures or connectivity issues in the application then immediately you don't want to execute tasks. So, You must have to wait for sometime before running the same task.
This is a common use case in every realtime application.
Let us explore the different ways to do the delay in java.
2. Delay with Thread.sleep()
A good and simple way is to call the Thread.sleep(long millies) method from where you want to put the delay in code. Actually, when you start any program in the java, it creates a main thread that controls the execution of the program. So, all threads are spawned from the main thread and the main thread is called as parent thread to all user-defined threads.
Syntax:
public static native void sleep(long millis) throws InterruptedException;
This is a native method that is taken from the C/C++ language.
Example:
The below example program is to sleep the thread for 5 seconds and continue its execution.
public class DelayWithThreadSleep {
public static void main(String[] args) {
System.out.println("Program Started...");
System.out.println("Current Thread name : " + Thread.currentThread().getName());
// do some task
try {
System.out.println("Sleepin for 5 seconds");
Thread.sleep(5000);
} catch (InterruptedException e) {
System.out.println("Thread is interrupted");
}
System.out.println("Code delay completed.");
System.out.println("Program Ended");
}
}
Output:Program Started...
Current Thread name : main
Sleepin for 5 seconds
Code delay completed.
Program Ended
If you need to use the Thread.sleep() method in many methods it is good to wrap it inside a private method as below. And also it is good practice to keep the sleep() method inside try/catch block to handle the exception properly.
If the thread is interrupted then it will come out from sleep state.
public class DelayWithThreadSleepUtil {
public static void main(String[] args) {
System.out.println("Program Started...");
System.out.println("Started task 1");
sleep(5000);
System.out.println("Code delay completed for task 1");
System.out.println("Started task 2");
sleep(3000);
System.out.println("Code delay completed for task 2");
System.out.println("Program Ended");
}
private static void sleep(long millies) {
try {
Thread.sleep(millies);
} catch (InterruptedException e) {
System.out.println("Thread is interrupted");
Thread.currentThread().interrupt();
}
}
}
3. Delay with TimeUnit.SECONDS or TimeUnit.MINUTES
TimeUnit class is added in the java.util.concurrent package which is to make the code easy to read. This class comes with different types of time measurements such as MILLISECONDS, NANOSECONDS, MICROSECONDS, SECONDS, MINUTES, HOURS, DAYS.
This follows the pattern TimeUnit.XXX with sleep for n number of based on the time unit type. But, this method internally calls the Thread.sleep() method.
import java.util.concurrent.TimeUnit;
public class DelayWithTimeUntSleep {
public static void main(String[] args) {
System.out.println("Task 1 Started with TimeUnit Seconds");
try {
TimeUnit.SECONDS.sleep(5);
} catch (InterruptedException e) {
System.out.println("Thread is interuppted....");
}
System.out.println("Task 1 Ended");
System.out.println("Task 2 Started with TimeUnit Seconds");
try {
TimeUnit.MINUTES.sleep(1);
} catch (InterruptedException e) {
System.out.println("Thread is interuppted....");
}
System.out.println("Task 2 Ended");
}
}
Output:Task 1 Started with TimeUnit Seconds
Task 1 Ended
Task 2 Started with TimeUnit Seconds
Task 2 Ended
The main drawback of this is that does not work properly for smaller sleep intervals in milliseconds and nanoseconds. And also, If you use this method inside any loops (for loop) then it might end up in the more timely execution.
4. Delay with an ExecutorService Model
An ExecutorService that can schedule commands to run after a given delay, or to execute periodically. Java has the built-in capability to run the piece of code run after a particular delay or at a fixed rate.
ScheduledExecutorService is a base interface for the ExecutorService.
The below example is to run the code with a fixed delay of 1000 milliseconds or 1 second. After running this code, you will not see anything on the console for the first 1 second. Because we have mentioned that delay to the scheduler. After completion of the delay, it will run the NewTask run() method and prints the "Task Completed".
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
public class DelayWithExecutorService {
public static void main(String[] args) {
ScheduledExecutorService executorService = Executors.newSingleThreadScheduledExecutor();
executorService.schedule(new NewTask(), 1000, TimeUnit.MILLISECONDS);
}
}
class NewTask implements Runnable {
@Override
public void run() {
System.out.println("Task completed");
}
}
Output:
Task completed
But, this task will be executed only once and not executed for every 1 second.
If you want to run the same task for every 5 seconds with initial delay 1 second then you should use scheduleAtFixedRate() method with initial and fixed dealy.
ScheduledExecutorService executorService = Executors.newSingleThreadScheduledExecutor();
executorService.scheduleAtFixedRate(new NewTask(), 1000, 5000, TimeUnit.MILLISECONDS);
Output:Task started
Task completed
Task started
Task completed
Task started
Task completed
If in case the task takes time more then 5 seconds then executor service does not trigger the next task untill the previous one is completed. So, we no need to worry about all these cases manually.
Look at the below example that each task takes 7 seconds but the fixed rate is 5 seconds.
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
public class DelayWithExecutorServiceFixedRate {
public static void main(String[] args) {
ScheduledExecutorService executorService = Executors.newSingleThreadScheduledExecutor();
executorService.scheduleAtFixedRate(new NewTask(), 1000, 5000, TimeUnit.MILLISECONDS);
}
}
class NewTask implements Runnable {
@Override
public void run() {
System.out.println("Task started");
try {
System.out.println("sleeping 7 seconds..");
Thread.sleep(7000);
} catch (InterruptedException e) {
System.out.println("thread is interrputed");
}
System.out.println("Task completed");
}
}
Output:Task started
sleeping 7 seconds..
Task completed
Task started
sleeping 7 seconds..
Task completed
Task started
sleeping 7 seconds..
Task completed
Task started
sleeping 7 seconds..
Task completed
Look at the output, Execution of each task did not get overlapped with the previous run. So, ExecutorService handles well internally each thread state.
5. Conclusion
In this article, You've seen the different ways to delay the thread in java using Thread.sleep(), TimeUnit.SECONDS.sleep() and with executorService.schedule() method.
All examples shown are over GitHub and links are given below.
No comments:
Post a Comment
Please do not add any spam links in the comments section.