Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This noncompliant code example explicitly invokes run() in the context of the current thread.:

Code Block
bgColor#FFCCCC

public final class Foo implements Runnable {
  @Override public void run() {
    // ...
  }

  public static void main(String[] args) {
    Foo foo = new Foo();
    new Thread(foo).run();
  }
}

...

This compliant solution correctly uses the start() method to tell the Java runtimes runtime to start a new thread.:

Code Block
bgColor#ccccff

public final class Foo implements Runnable {
  @Override public void run() {
    // ...
  }

  public static void main(String[] args) {
    Foo foo = new Foo();
    new Thread(foo).start();
  }
}

Exceptions

THI00-J-EX0: The run() method may be directly invoked during unit testing. Note that this method cannot be used to test a class for multithreaded use.

Given a Thread object that has been was constructed with a runnable argument, when invoking the Thread.run() method, the Thread object may be cast to Runnable to eliminate analyzer diagnostics.:

Code Block
bgColor#ccccff

public void sampleRunTest() {

  Thread thread = new Thread(new Runnable() {
      @Override public void run() {
        // ...
      }
    });
  
  ((Runnable) thread).run();  // THI00-J-EX0: Does not start a new thread

}

Casting a thread to Runnable before calling the run() method documents that the explicit call to Thread.run() is intentional. Adding an explanatory comment alongside the invocation is highly recommended.

THI00-J-EX1: Runtime system code involved in starting new threads is permitted to invoke a Thread object's run() method directly; this is an obvious necessity for a working Java runtime system. Note that the likelihood that this exception applies to user-written code is vanishingly small.

...

Failure to start threads correctly can cause unexpected behavior.

Rule

Severity

Likelihood

Remediation Cost

Priority

Level

THI00-J

low

Low

probable

Probable

medium

Medium

P4

L3

Automated Detection

Automated detection of direct invocations of Thread.run() methods is straightforward. Sound automated determination of which specific invocations are permitted may be infeasible. Heuristic approaches may be useful.

Tool
Version
Checker
Description
CodeSonar

Include Page
CodeSonar_V
CodeSonar_V

JAVA.CONCURRENCY.LOCK.SCTBSynchronous Call to Thread Body (Java)
Coverity7.5DC.THREADING.thread_runImplemented
Parasoft Jtest
Include Page
Parasoft_V
Parasoft_V
CERT.THI00.IRUNDo not call the 'run()' method directly on classes extending 'java.lang.Thread' or implementing 'java.lang.Runnable'
PVS-Studio

Include Page
PVS-Studio_V
PVS-Studio_V

V6064
SonarQube
Include Page
SonarQube_V
SonarQube_V
S1217Thread.run() should not be called directly

Related Guidelines

MITRE CWE

CWE-572

.

, Call to Thread run() instead of start()

Bibliography

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="21509431-c868-4758-b4b1-c9e1170d757f"><ac:plain-text-body><![CDATA[

[[API 2006

AA. Bibliography#API 06]]

Interface Runnable and class Thread

]]></ac:plain-text-body></ac:structured-macro>

Android Implementation Details

Android provides a couple of solutions for threading. The Android Developers Blog's article "Painless Threading" discusses those solutions.

Bibliography


...

Image Added Image Added 09. Thread APIs (THI)      09. Thread APIs (THI)