Centralize spring fully qualified names into constants

Author: leonardo-pilastri-sonarsource

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

@@ -19,6 +19,7 @@
 import java.util.HashSet;
 import java.util.List;
 import org.sonar.check.Rule;
+import org.sonar.java.checks.helpers.SpringUtils;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.tree.ClassTree;
 import org.sonar.plugins.java.api.tree.MethodTree;
@@ -49,14 +50,14 @@ public void visitNode(Tree tree) {
   }
 
   private static boolean isConfigurationClass(ClassTree classTree) {
-    return classTree.symbol().metadata().isAnnotatedWith("org.springframework.context.annotation.Configuration");
+    return classTree.symbol().metadata().isAnnotatedWith(SpringUtils.CONFIGURATION_ANNOTATION);
   }
 
   private static List<MethodTree> getBeanMethods(ClassTree classTree) {
     return classTree.members().stream()
       .filter(member -> member.is(Tree.Kind.METHOD))
       .map(MethodTree.class::cast)
-      .filter(method -> method.symbol().metadata().isAnnotatedWith("org.springframework.context.annotation.Bean"))
+      .filter(method -> method.symbol().metadata().isAnnotatedWith(SpringUtils.BEAN_ANNOTATION))
       .toList();
   }
 

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

@@ -24,6 +24,7 @@
 import java.util.Optional;
 import java.util.Set;
 import org.sonar.check.Rule;
+import org.sonar.java.checks.helpers.SpringUtils;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.semantic.Symbol;
 import org.sonar.plugins.java.api.semantic.SymbolMetadata;
@@ -41,7 +42,7 @@
 public class LeastSpecificTypeCheck extends IssuableSubscriptionVisitor {
 
   private static final Set<String> SPRING_INJECT_ANNOTATIONS = Set.of(
-    "org.springframework.beans.factory.annotation.Autowired",
+    SpringUtils.AUTOWIRED_ANNOTATION,
     "javax.inject.Inject",
     "jakarta.inject.Inject",
     "javax.annotation.Resource",

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

@@ -20,6 +20,7 @@
 import java.util.List;
 import org.sonar.check.Rule;
 import org.sonar.check.RuleProperty;
+import org.sonar.java.checks.helpers.SpringUtils;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.semantic.SymbolMetadata;
 import org.sonar.plugins.java.api.tree.ClassTree;
@@ -71,7 +72,7 @@ public class TooManyParametersCheck extends IssuableSubscriptionVisitor {
     "io.micronaut.http.annotation.Patch",
     "io.micronaut.http.annotation.Head",
     "io.micronaut.http.annotation.Trace",
-    "org.springframework.beans.factory.annotation.Autowired");
+    SpringUtils.AUTOWIRED_ANNOTATION);
 
   @Override
   public List<Tree.Kind> nodesToVisit() {

java-checks/src/main/java/org/sonar/java/checks/helpers/SpringUtils.java

@@ -22,15 +22,27 @@
 
 public final class SpringUtils {
 
-  public static final String SPRING_SCOPE_ANNOTATION = "org.springframework.context.annotation.Scope";
+  public static final String SPRING_BOOT_APP_ANNOTATION = "org.springframework.boot.autoconfigure.SpringBootApplication";
+  public static final String CONTROLLER_ANNOTATION = "org.springframework.stereotype.Controller";
+  public static final String COMPONENT_ANNOTATION = "org.springframework.stereotype.Component";
+  public static final String REPOSITORY_ANNOTATION = "org.springframework.stereotype.Repository";
+  public static final String SERVICE_ANNOTATION = "org.springframework.stereotype.Service";
   public static final String AUTOWIRED_ANNOTATION = "org.springframework.beans.factory.annotation.Autowired";
+  public static final String VALUE_ANNOTATION = "org.springframework.beans.factory.annotation.Value";
+  public static final String TRANSACTIONAL_ANNOTATION = "org.springframework.transaction.annotation.Transactional";
+  public static final String BEAN_ANNOTATION = "org.springframework.context.annotation.Bean";
+  public static final String SCOPE_ANNOTATION = "org.springframework.context.annotation.Scope";
+  public static final String CONFIGURATION_ANNOTATION = "org.springframework.context.annotation.Configuration";
+  public static final String ASYNC_ANNOTATION = "org.springframework.scheduling.annotation.Async";
+  public static final String DATA_REPOSITORY_ANNOTATION = "org.springframework.data.repository.Repository";
+  public static final String REST_CONTROLLER_ANNOTATION = "org.springframework.web.bind.annotation.RestController";
 
   private SpringUtils() {
     // Utils class
   }
 
   public static boolean isScopeSingleton(SymbolMetadata clazzMeta) {
-    List<SymbolMetadata.AnnotationValue> values = clazzMeta.valuesForAnnotation(SPRING_SCOPE_ANNOTATION);
+    List<SymbolMetadata.AnnotationValue> values = clazzMeta.valuesForAnnotation(SCOPE_ANNOTATION);
     if (values == null) {
       // Scope is singleton by default
       return true;

java-checks/src/main/java/org/sonar/java/checks/spring/AsyncMethodsCalledViaThisCheck.java

@@ -19,6 +19,7 @@
 import java.util.List;
 import java.util.Map;
 import org.sonar.check.Rule;
+import org.sonar.java.checks.helpers.SpringUtils;
 import org.sonar.java.model.ExpressionUtils;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.tree.MemberSelectExpressionTree;
@@ -29,8 +30,8 @@
 public class AsyncMethodsCalledViaThisCheck extends IssuableSubscriptionVisitor {
 
   private static final Map<String, String> DISALLOWED_METHOD_ANNOTATIONS = Map.of(
-    "org.springframework.scheduling.annotation.Async", "async",
-    "org.springframework.transaction.annotation.Transactional", "transactional",
+    SpringUtils.ASYNC_ANNOTATION, "async",
+    SpringUtils.TRANSACTIONAL_ANNOTATION, "transactional",
     "org.springframework.cache.annotation.Cacheable", "cacheable");
 
   @Override

java-checks/src/main/java/org/sonar/java/checks/spring/AsyncMethodsOnConfigurationClassCheck.java

@@ -19,6 +19,7 @@
 import java.util.List;
 import org.sonar.check.Rule;
 import org.sonar.java.checks.helpers.QuickFixHelper;
+import org.sonar.java.checks.helpers.SpringUtils;
 import org.sonar.java.reporting.JavaQuickFix;
 import org.sonar.java.reporting.JavaTextEdit;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
@@ -38,14 +39,14 @@ public List<Tree.Kind> nodesToVisit() {
   public void visitNode(Tree tree) {
     ClassTree classTree = (ClassTree) tree;
     boolean isConfiguration = classTree.modifiers().annotations().stream()
-      .anyMatch(annotation -> annotation.annotationType().symbolType().is("org.springframework.context.annotation.Configuration"));
+      .anyMatch(annotation -> annotation.annotationType().symbolType().is(SpringUtils.CONFIGURATION_ANNOTATION));
 
     if (isConfiguration) {
       classTree.members().stream()
         .filter(member -> member.is(Tree.Kind.METHOD))
         .map(MethodTree.class::cast)
         .forEach(member -> member.modifiers().annotations().stream()
-          .filter(annotation -> annotation.annotationType().symbolType().is("org.springframework.scheduling.annotation.Async"))
+          .filter(annotation -> annotation.annotationType().symbolType().is(SpringUtils.ASYNC_ANNOTATION))
           .findFirst()
           .ifPresent(annotation -> QuickFixHelper.newIssue(context)
             .forRule(this)

java-checks/src/main/java/org/sonar/java/checks/spring/AsyncMethodsReturnTypeCheck.java

@@ -18,6 +18,7 @@
 
 import java.util.List;
 import org.sonar.check.Rule;
+import org.sonar.java.checks.helpers.SpringUtils;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.tree.MethodTree;
 import org.sonar.plugins.java.api.tree.Tree;
@@ -33,7 +34,7 @@ public List<Tree.Kind> nodesToVisit() {
   @Override
   public void visitNode(Tree tree) {
     var mt = (MethodTree) tree;
-    if (mt.symbol().metadata().isAnnotatedWith("org.springframework.scheduling.annotation.Async")) {
+    if (mt.symbol().metadata().isAnnotatedWith(SpringUtils.ASYNC_ANNOTATION)) {
       var returnType = mt.returnType();
       // returnType can only be null if the method is a constructor. Since the @Async annotation is not allowed on constructors, and since
       // we hence only visit methods, not constructors, we assume that returnType is not null.

java-checks/src/main/java/org/sonar/java/checks/spring/AutowiredOnConstructorWhenMultipleConstructorsCheck.java

@@ -18,6 +18,7 @@
 
 import java.util.List;
 import org.sonar.check.Rule;
+import org.sonar.java.checks.helpers.SpringUtils;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.tree.ClassTree;
 import org.sonar.plugins.java.api.tree.MethodTree;
@@ -27,12 +28,12 @@
 public class AutowiredOnConstructorWhenMultipleConstructorsCheck extends IssuableSubscriptionVisitor {
 
   private final List<String> annotations = List.of(
-    "org.springframework.context.annotation.Bean",
-    "org.springframework.context.annotation.Configuration",
-    "org.springframework.stereotype.Component",
-    "org.springframework.stereotype.Controller",
-    "org.springframework.stereotype.Repository",
-    "org.springframework.stereotype.Service");
+    SpringUtils.BEAN_ANNOTATION,
+    SpringUtils.CONFIGURATION_ANNOTATION,
+    SpringUtils.COMPONENT_ANNOTATION,
+    SpringUtils.CONTROLLER_ANNOTATION,
+    SpringUtils.REPOSITORY_ANNOTATION,
+    SpringUtils.SERVICE_ANNOTATION);
 
   @Override
   public List<Tree.Kind> nodesToVisit() {
@@ -57,7 +58,7 @@ public void visitNode(Tree tree) {
     if (constructors.size() > 1) {
       boolean anyHasAutowired = constructors.stream()
         .anyMatch(constructor -> constructor.modifiers().annotations().stream()
-          .anyMatch(annotation -> annotation.symbolType().is("org.springframework.beans.factory.annotation.Autowired")));
+          .anyMatch(annotation -> annotation.symbolType().is(SpringUtils.AUTOWIRED_ANNOTATION)));
 
       if (!anyHasAutowired) {
         reportIssue(classTree.simpleName(), "Add @Autowired to one of the constructors.");

java-checks/src/main/java/org/sonar/java/checks/spring/AutowiredOnMultipleConstructorsCheck.java

@@ -19,6 +19,7 @@
 import java.util.List;
 import java.util.Optional;
 import org.sonar.check.Rule;
+import org.sonar.java.checks.helpers.SpringUtils;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.semantic.Symbol;
 import org.sonar.plugins.java.api.semantic.SymbolMetadata;
@@ -30,8 +31,6 @@
 @Rule(key = "S6818")
 public class AutowiredOnMultipleConstructorsCheck extends IssuableSubscriptionVisitor {
 
-  private static final String AUTOWIRED_ANNOTATION = "org.springframework.beans.factory.annotation.Autowired";
-
   @Override
   public List<Tree.Kind> nodesToVisit() {
     return List.of(Tree.Kind.CLASS);
@@ -61,7 +60,7 @@ private boolean checkConstructor(MethodTree methodTree, boolean isAutowiredAlrea
 
     if (isAutowiredAlreadyFound && isAutowired) {
       Optional<AnnotationTree> autowiredAnnotation = methodTree.modifiers().annotations().stream()
-        .filter(a -> a.annotationType().symbolType().is(AUTOWIRED_ANNOTATION))
+        .filter(a -> a.annotationType().symbolType().is(SpringUtils.AUTOWIRED_ANNOTATION))
         .findFirst();
       autowiredAnnotation.ifPresent(annotationTree -> reportIssue(annotationTree, "Remove this \"@Autowired\" annotation."));
     }
@@ -70,8 +69,8 @@ private boolean checkConstructor(MethodTree methodTree, boolean isAutowiredAlrea
   }
 
   private static boolean isAutowired(Symbol s) {
-    if (s.metadata().isAnnotatedWith(AUTOWIRED_ANNOTATION)) {
-      List<SymbolMetadata.AnnotationValue> annotationValues = s.metadata().valuesForAnnotation(AUTOWIRED_ANNOTATION);
+    if (s.metadata().isAnnotatedWith(SpringUtils.AUTOWIRED_ANNOTATION)) {
+      List<SymbolMetadata.AnnotationValue> annotationValues = s.metadata().valuesForAnnotation(SpringUtils.AUTOWIRED_ANNOTATION);
       return annotationValues.isEmpty() || annotationValues.stream().anyMatch(a -> a.value().equals(true));
     }
     return false;

java-checks/src/main/java/org/sonar/java/checks/spring/AvoidQualifierOnBeanMethodsCheck.java

@@ -20,6 +20,7 @@
 import java.util.List;
 import org.sonar.check.Rule;
 import org.sonar.java.checks.helpers.QuickFixHelper;
+import org.sonar.java.checks.helpers.SpringUtils;
 import org.sonar.java.model.expression.AssignmentExpressionTreeImpl;
 import org.sonar.java.model.expression.LiteralTreeImpl;
 import org.sonar.java.reporting.JavaQuickFix;
@@ -32,7 +33,6 @@
 
 @Rule(key = "S6831")
 public class AvoidQualifierOnBeanMethodsCheck extends IssuableSubscriptionVisitor {
-  private static final String BEAN_ANNOTATION = "org.springframework.context.annotation.Bean";
   private static final String QUALIFIER_ANNOTATION = "org.springframework.beans.factory.annotation.Qualifier";
 
   @Override
@@ -47,7 +47,7 @@ public List<Tree.Kind> nodesToVisit() {
   public void visitNode(Tree tree) {
     var methodTree = (MethodTree) tree;
 
-    var beanAnnotation = getAnnotation(methodTree, BEAN_ANNOTATION);
+    var beanAnnotation = getAnnotation(methodTree, SpringUtils.BEAN_ANNOTATION);
     var qualifierAnnotation = getAnnotation(methodTree, QUALIFIER_ANNOTATION);
 
     if (beanAnnotation != null && qualifierAnnotation != null) {