Groovy - Block Synchronization

When we start two or more threads within a Groovy program, there may be a situation when multiple threads try to access the same resource and finally they can produce unforeseen result due to concurrency issues. For example, if multiple threads try to write within a same file then they may corrupt the data because one of the threads can override data or while one thread is opening the same file at the same time another thread might be closing the same file.

So there is a need to synchronize the action of multiple threads and make sure that only one thread can access the resource at a given point in time. This is implemented using a concept called monitors. Each object in Groovy is associated with a monitor, which a thread can lock or unlock. Only one thread at a time may hold a lock on a monitor.

Block Synchronization in Groovy

Groovy programming language provides a very handy way of creating threads and synchronizing their task by using synchronized blocks. You keep shared resources within this block.

Syntax

Following is the general form of the synchronized statement −

synchronized(objectidentifier) {
   // Access shared variables and other shared resources
}

Here, the objectidentifier is a reference to an object whose lock associates with the monitor that the synchronized statement represents. Now we are going to see two examples, where we will print a counter using two different threads. When threads are not synchronized, they print counter value which is not in sequence, but when we print counter by putting inside synchronized() block, then it prints counter very much in sequence for both the threads.

Example - Multithreading without Synchronization

Here is a simple example which may or may not print counter value in sequence and every time we run it, it produces a different result based on CPU availability to a thread.

Example.groovy

class Example {
   static void main(String[] args) {
      PrintDemo printDemo = new PrintDemo();
      ThreadDemo t1 = new ThreadDemo( "Thread - 1 ", printDemo );
      ThreadDemo t2 = new ThreadDemo( "Thread - 2 ", printDemo );

      t1.start();
      t2.start();

      // wait for threads to end
         try {
         t1.join();
         t2.join();
      } catch ( Exception e) {
         println("Interrupted");
      }
   }
}

class PrintDemo {
   void printCount() {
      try {
         for(int i = 5; i >  0; i--) {
            Thread.sleep(50);
            println("Counter   ---   "  + i );
         }
      } catch (Exception e) {
         System.out.println("Thread  interrupted.");
      }
   }
}

class ThreadDemo extends Thread {
   private Thread t;
   private String threadName;
   PrintDemo printDemo;

   ThreadDemo( String threadName, PrintDemo printDemo) {
      this.threadName = threadName;
      this.printDemo = printDemo;
   }
   
   void run() {
      printDemo.printCount();
      println("Thread " +  threadName + " exiting.");
   }

   void start () {
      println("Starting " +  threadName );
      if (t == null) {
         t = new Thread (this, threadName);
         t.start ();
      }
   }
}

Output

This produces a different result every time you run this program −

Starting Thread - 1 
Starting Thread - 2 
Counter   ---   5
Counter   ---   5
Counter   ---   4
Counter   ---   4
Counter   ---   3
Counter   ---   3
Counter   ---   2
Counter   ---   2
Counter   ---   1
Counter   ---   1
Thread Thread - 1  exiting.
Thread Thread - 2  exiting.

Multithreading Example with Synchronization at Block level

Here is the same example which prints counter value in sequence and every time we run it, it produces the same result. We've put synchronized keyword over a block so that counter increment code is now locked as per the object during method execution. We're using current object as lock which we're passing in the synchronized block as parameter.

Example.groovy

class Example {

   static void main(String[] args) {
      PrintDemo printDemo = new PrintDemo();

      ThreadDemo t1 = new ThreadDemo( "Thread - 1 ", printDemo );
      ThreadDemo t2 = new ThreadDemo( "Thread - 2 ", printDemo );

      t1.start();
      t2.start();

      // wait for threads to end
      try {
         t1.join();
         t2.join();
      } catch ( Exception e) {
         println("Interrupted");
      }
   }
}
class PrintDemo {
   void printCount() {
      try {
         for(int i = 5; i > 0; i--) {
            Thread.sleep(50);
            println("Counter   ---   "  + i );
         }
      } catch (Exception e) {
         println("Thread  interrupted.");
      }
   }
}

class ThreadDemo extends Thread {
   private Thread t;
   private String threadName;
   PrintDemo printDemo;

   ThreadDemo( String name, PrintDemo pd) {
      threadName = name;
      printDemo = pd;
   }
   
   void run() {
      synchronized(printDemo) {
         printDemo.printCount();
      }
      println("Thread " +  threadName + " exiting.");
   }

   void start () {
      println("Starting " +  threadName );
      if (t == null) {
         t = new Thread (this, threadName);
         t.start ();
      }
   }
}

Output

This produces the same result every time you run this program −

Starting Thread - 1 
Starting Thread - 2 
Counter   ---   5
Counter   ---   4
Counter   ---   3
Counter   ---   2
Counter   ---   1
Thread Thread - 1  exiting.
Counter   ---   5
Counter   ---   4
Counter   ---   3
Counter   ---   2
Counter   ---   1
Thread Thread - 2  exiting.

Multithreading Example with Synchronization at Method level

Here is the same example which prints counter value in sequence and every time we run it, it produces the same result. W've put synchronized keyword over a method this time so that complete method is locked as per the object during method execution.

Example.groovy

class Example {
   static void main(String[] args) {
      PrintDemo printDemo = new PrintDemo();
      Thread t1 = new Thread(printDemo );
      Thread t2 = new Thread(printDemo );
      t1.start();
      t2.start();
      // wait for threads to end
      try {
         t1.join();
         t2.join();
      } catch ( Exception e) {
         println("Interrupted");
      }
   }
}
class PrintDemo extends Thread {
   void printCount() {
      try {
         for(int i = 5; i > 0; i--) {
            Thread.sleep(50);
            println("Counter --- " + i );
         }
      } catch (Exception e) {
         println("Thread " + Thread.currentThread().getName()+" interrupted.");
      }
   }
   synchronized void run() {
      printCount();
      println("Thread " + Thread.currentThread().getName() + " exiting.");
   }
}

Output

This produces the same result every time you run this program −

Counter --- 5
Counter --- 4
Counter --- 3
Counter --- 2
Counter --- 1
Thread Thread-1 exiting.
Counter --- 5
Counter --- 4
Counter --- 3
Counter --- 2
Counter --- 1
Thread Thread-2 exiting.