org.sonar.l10n.java.rules.java.S6809.html Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-java-plugin Show documentation
Code Analyzer for Java
The newest version!
Why is this an issue?
A method annotated with Spring’s @Async, @Cacheable or @Transactional annotations will not work as expected
if invoked directly from within its class.
This is because Spring generates a proxy class with wrapper code to manage the method’s asynchronicity (@Async), to cache methods
invocations (@Cacheable), or to handle the transaction (@Transactional). However, when called using this, the
proxy instance is bypassed, and the method is invoked directly without the required wrapper code.
How to fix it
Replace calls to @Async, @Cacheable or @Transactional methods via this with calls on an
instance that was injected by Spring (@Autowired, @Resource or @Inject). The injected instance is a proxy on
which the methods can be invoked safely.
Code examples
Noncompliant code example
@Service
public class AsyncNotificationProcessor implements NotificationProcessor {

  @Override
  public void process(Notification notification) {
    processAsync(notification); // Noncompliant, call bypasses proxy
    retrieveNotification(notification.id); // Noncompliant, call bypasses proxy and will not be cached
  }

  @Async
  public processAsync(Notification notification) {
    // ...
  }

  @Cacheable
  public Notification retrieveNotification(Long id) {
    // ...
  }

}

Compliant solution
@Service
public class AsyncNotificationProcessor implements NotificationProcessor {

  @Resource
  private AsyncNotificationProcessor asyncNotificationProcessor;

  @Override
  public void process(Notification notification) {
    asyncNotificationProcessor.processAsync(notification); // Compliant, call via injected proxy
    asyncNotificationProcessor.retrieveNotification(notification.id); // Compliant, the call will be cached
  }

  @Async
  public processAsync(Notification notification) {
    // ...
  }

  @Cacheable
  public Notification retrieveNotification(Long id) {
    // ...
  }
}

Resources
Documentation

   Spring
  Framework API - Annotation Interface Async 
   Spring
  Framework API - Annotation Interface Transactional 
   Spring Framework
  API - Annotation Interface Cacheable 

Articles & blog posts

   Baeldung - How To Do @Async in Spring 
   Stack Overflow - Spring @Async ignored 
   Stack Overflow - Does Spring
  @Transactional attribute work on a private method? 
   Spring docs, The
  @Cacheable Annotation