Page History

Synchronizing on the return value of the Object.getClass() method , can lead to unexpected behavior. Whenever the implementing class is subclassed, the subclass locks on the subclass's type, which is a completely different Class object.. The Class object of the subclass is entirely distinct from the Class object of the parent class.

According to The Java Language Specification, §4 Wiki MarkupSection 4.3.2 , "The Class Object" of the _Java Language Specification_ describes how method synchronization works \[ [JLS 2005|AA. Java References#JLS 05]\]:

A class method that is declared synchronized synchronizes on the lock associated with the Class object of the class.

This does not Programmers who interpret this to mean that a subclass using getClass() can only will synchronize on the Class object of the base class . In fact, it will are incorrect. The subclass will actually lock on its own Class object, which may or may not be what the programmer intended. Consequently, programs must not synchronize on the class object returned by getClass().

The programmer's actual intent should be clearly documented or annotated. Note that if when a subclass does not fails to override an accessible noncompliant superclass's method, it inherits the method, which may lead to the false conclusion that the superclass's intrinsic lock is available in the subclass.

When synchronizing on a class literal, the corresponding lock object should not be accessible inaccessible to untrusted code. If the class is Callers from other packages cannot access class objects that are package-private, callers from other packages may not access the class object, ensuring its trustworthiness as an intrinsic lock object. For more information, see guideline ; consequently, synchronizing on the intrinsic lock object of such classes is permitted (see LCK00-J. Use private final lock objects to synchronize classes that may interact with untrusted code for more information).

Noncompliant Code Example (getClass() Lock Object)

In this noncompliant code example, the parse() method of the Base class parses a date and synchronizes on the class object returned by getClass(). The Derived class also inherits the parse() method. However, this inherited method synchronizes on Derived's class object because of the particular return value of getClass()the inherited parse method's invocation of getClass() is really an invocation of this.getClass(), and the this argument is a reference to the instance of the Derived class.

The Derived class also adds a doSomethingAndParse() method that locks on the class object of the base Base class because the developer misconstrued that the parse() method in Base always obtains a lock on the Base class object, and doSomethingAndParse() must follow the same locking policy. Consequently, the Derived class has two different locking strategies and is not fails to be thread-safe.

class Base {
  static DateFormat format =
      DateFormat.getDateInstance(DateFormat.MEDIUM);

  public Date parse(String str) throws ParseException {
    synchronized (getClass()) {
      return format.parse(str);
    }
  }
}

class Derived extends Base {
  public Date doSomethingAndParse(String str) throws ParseException {
    synchronized (Base.class) {
      // ...
      return format.parse(str);
    }
  }
}

...

In this compliant solution, the class name providing the lock (Base) is fully qualified.:

class Base {
  static DateFormat format =
      DateFormat.getDateInstance(DateFormat.MEDIUM);

  public Date parse(String str) throws ParseException {
    synchronized (Base.class) {
      return format.parse(str);
    }
  }
}

// ...

This code example always synchronizes on the Base.class object, even if when it is called from a Derived object.

...

This compliant solution uses the Class.forName() method to synchronize on the Base class's Class object.:

class Base {
  static DateFormat format =
      DateFormat.getDateInstance(DateFormat.MEDIUM);

  public Date parse(String str) throws ParseException {
    try {
      synchronized (Class.forName("Base")) {
        return format.parse(str);
      }
    } catch (ClassNotFoundException x) {
      // "Base" not found; handle error
    }
    return null;
  } 
}

// ...

Never accept untrusted inputs It is important that untrusted inputs are not accepted as arguments while loading classes using Class.forName(). See guideline SEC05 (see SEC03-J. Do not expose standard APIs that use the immediate caller's class loader instance to untrusted codeload trusted classes after allowing untrusted code to load arbitrary classes for more information).

Noncompliant Code Example (getClass() Lock Object, Inner Class)

This noncompliant code example synchronizes on the class object returned by getClass() in the parse() method of class Base class. The Base class also has a nested Helper class whose doSomethingAndParse() method incorrectly synchronizes on the value returned by getClass().

class Base {
  static DateFormat format =
      DateFormat.getDateInstance(DateFormat.MEDIUM);

  public Date parse(String str) throws ParseException {
    synchronized (getClass()) { // Intend to synchronizes on Base.class
      return format.parse(str);
    }
  }

  public Date doSomething(String str) throws ParseException {
    return new Helper().doSomethingAndParse(str);
  }

  private class Helper {
    public Date doSomethingAndParse(String str) throws ParseException {
      synchronized (getClass()) { // Synchronizes on getClass()Helper.class
        // ...
        return format.parse(str);
      }
    }
  }
}

...

This compliant solution synchronizes using a Base class literal in the parse() and doSomethingAndParse() methods.:

class Base {
  // ...

  public Date parse(String str) throws ParseException {
    synchronized (Base.class) {
      return format.parse(str);
    }
  }

  private class Helper {
    public Date doSomethingAndParse(String str) throws ParseException {
      synchronized (Base.class) { // Synchronizes on Base class literal
        // ...
        return format.parse(str);
      }
    }
  }
}

Consequently, both Base and Helper lock on Base's intrinsic lock. Similarly, the Class.fornameforName() method can be used instead of a class literal.

...

Synchronizing on the class object returned by getClass() can result in nondeterministic behavior.

References

\[[API 2006|AA. Java References#API 06]\]
\[[Findbugs 2008|AA. Java References#Findbugs 08]\].
\[[Pugh 2008|AA. Java References#Pugh 08]\] "Synchronization"
\[[Miller 2009|AA. Java References#Miller 09]\] Locking

Automated Detection

Some static analysis tools can detect violations of this rule

Bibliography

...

Image Added Image Added Image Removed      12. Locking (LCK)