S1186: Ignore empty methods with @CacheEvict annotation

java-checks-test-sources/default/src/main/java/checks/EmptyMethodsCheckNoSemantics.java

@@ -2,6 +2,7 @@
 
 import org.aspectj.lang.annotation.Before;
 import org.aspectj.lang.annotation.Pointcut;
+import org.springframework.cache.annotation.CacheEvict;
 
 class EmptyMethodsCheckNoSemantics {
   class A {
@@ -186,12 +187,18 @@ private void emptyMethod2() {
 
   private class ExceptionalCompliantCases {
     @org.aspectj.lang.annotation.Pointcut()
-    void foo() {
+    void foo() {  // Compliant
 
     }
 
     @Pointcut()
-    void bar() {}
+    void bar() {}  // Compliant
+
+    @org.springframework.cache.annotation.CacheEvict(cacheNames = "flowers", allEntries = true)
+    void evictAll() {}  // Compliant
+
+    @CacheEvict(value = "flowers", key = "{#name}")
+    void evict(String name) {}  // Compliant
 
     @Before("")
     void stillTriggerOnOtherAnnotations() {} // Noncompliant

java-checks-test-sources/default/src/main/java/checks/EmptyMethodsCheckSample.java

@@ -2,6 +2,7 @@
 
 import org.aspectj.lang.annotation.Before;
 import org.aspectj.lang.annotation.Pointcut;
+import org.springframework.cache.annotation.CacheEvict;
 
 class EmptyMethodsCheckSample {
   class A {
@@ -186,12 +187,18 @@ private void emptyMethod2() {
 
   private class ExceptionalCompliantCases {
     @org.aspectj.lang.annotation.Pointcut()
-    void foo() {
+    void foo() {  // Compliant
 
     }
 
     @Pointcut()
-    void bar() {}
+    void bar() {}  // Compliant
+
+    @org.springframework.cache.annotation.CacheEvict(cacheNames = "flowers", allEntries = true)
+    void evictAll() {}  // Compliant
+
+    @CacheEvict(value = "flowers", key = "{#name}")
+    void evict(String name) {}  // Compliant
 
     @Before("")
     void stillTriggerOnOtherAnnotations() {} // Noncompliant

java-checks/src/main/java/org/sonar/java/checks/EmptyMethodsCheck.java

@@ -39,10 +39,6 @@
 @Rule(key = "S1186")
 public class EmptyMethodsCheck extends IssuableSubscriptionVisitor {
 
-  // Some methods may legitimately be left empty, e.g. methods annotated with org.aspectj.lang.annotation.Pointcut. We ignore them here.
-  private static final String IGNORED_METHODS_ANNOTATION = "org.aspectj.lang.annotation.Pointcut";
-  private static final String IGNORED_METHODS_ANNOTATION_UNQUALIFIED = "Pointcut";
-
   @Override
   public List<Kind> nodesToVisit() {
     return Arrays.asList(Tree.Kind.CLASS, Tree.Kind.ENUM, Tree.Kind.RECORD);
@@ -73,8 +69,18 @@ private void checkMethods(List<Tree> members) {
    * Returns true if the annotation indicates that the method body can legitimately be empty.
    */
   private static boolean isExceptedAnnotation(AnnotationTree annotationTree) {
-    return annotationTree.symbolType().is(IGNORED_METHODS_ANNOTATION) ||
-      (annotationTree.symbolType().isUnknown() && annotationTree.symbolType().name().equals(IGNORED_METHODS_ANNOTATION_UNQUALIFIED));
+    if (annotationTree.symbolType().isUnknown()) {
+      return switch (annotationTree.symbolType().name()) {
+        case "Pointcut",
+            "CacheEvict" -> true;
+        default -> false;
+      };
+    }
+    return switch (annotationTree.symbolType().fullyQualifiedName()) {
+      case "org.aspectj.lang.annotation.Pointcut",
+          "org.springframework.cache.annotation.CacheEvict" -> true;
+      default -> false;
+    };
   }
 
   private void checkConstructors(List<Tree> members) {

sonar-java-plugin/src/main/resources/org/sonar/l10n/java/rules/java/S1186.html

@@ -14,6 +14,7 @@ <h3>Exceptions</h3>
   <li> Public default (no-argument) constructors when there are other constructors in the class </li>
   <li> Empty methods in abstract classes </li>
   <li> Methods annotated with <code>@org.aspectj.lang.annotation.Pointcut()</code> </li>
+  <li> Methods annotated with <code>@org.springframework.cache.annotation.CacheEvict()</code> </li>
 </ul>
 <pre>
 public abstract class Animal {