GH-1635: check for lombok constructor annotations to avoid validation errors while checking for superfluous autowired annotations

Author: martinlippert

headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/Annotations.java

@@ -132,5 +132,11 @@ public class Annotations {
 	);
 
 	public static final String JMOLECULES_STEREOTYPE = "org.jmolecules.stereotype.Stereotype";
-
+	
+	public static final Set<String> LOMBOK_CONSTRUCTOR_ANNOTATIONS = Set.of(
+			"lombok.RequiredArgsConstructor",
+			"lombok.NoArgsConstructor",
+			"lombok.AllArgsConstructor"
+	);
+	
 }

headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/reconcilers/NoAutowiredOnConstructorReconciler.java

@@ -26,6 +26,7 @@
 import org.springframework.ide.vscode.boot.java.Annotations;
 import org.springframework.ide.vscode.boot.java.Boot2JavaProblemType;
 import org.springframework.ide.vscode.boot.java.annotations.AnnotationHierarchies;
+import org.springframework.ide.vscode.boot.java.utils.ASTUtils;
 import org.springframework.ide.vscode.commons.java.IClasspathUtil;
 import org.springframework.ide.vscode.commons.java.IJavaProject;
 import org.springframework.ide.vscode.commons.languageserver.quickfix.QuickfixRegistry;
@@ -67,6 +68,15 @@ public boolean visit(TypeDeclaration typeDecl) {
 				if (IClasspathUtil.getProjectJavaSourceFoldersWithoutTests(project.getClasspath())
 						.anyMatch(f -> sourceFile.startsWith(f.toPath()))) {
 
+					// lombok annotation around -> don't check for constructors
+					if (ASTUtils.getAnnotations(typeDecl).stream()
+							.map(annotation -> annotation.resolveTypeBinding().getQualifiedName())
+							.filter(annotationType -> Annotations.LOMBOK_CONSTRUCTOR_ANNOTATIONS.contains(annotationType))
+							.findAny().isPresent()) {
+						return super.visit(typeDecl);
+					}
+
+					// more than one constructor ?
 					int constructorCount = 0;
 					MethodDeclaration constructor = null;
 					for (MethodDeclaration method : typeDecl.getMethods()) {
@@ -79,7 +89,8 @@ public boolean visit(TypeDeclaration typeDecl) {
 							}
 						}
 					}
-					
+
+					// one constructor -> check for autowired annotation
 					if (constructor != null) {
 						Annotation autowiredAnnotation = ReconcileUtils.findAnnotation(annotationHierarchies, constructor,
 								Annotations.AUTOWIRED, false);

headless-services/spring-boot-language-server/src/test/java/org/springframework/ide/vscode/boot/java/reconcilers/test/NoAutowiredOnConstructorReconcilerTest.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2023 VMware, Inc.
+ * Copyright (c) 2023, 2025 VMware, Inc.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -98,6 +98,27 @@ class A {
 		List<ReconcileProblem> problems = reconcile("A.java", source, false);
 
 		assertEquals(0, problems.size());
+	}
+
+	@Test
+	void multipleConstructorsViaLombok() throws Exception {
+		String source = """
+				package example.demo;
+				
+				import org.springframework.beans.factory.annotation.Autowired;
+				import lombok.RequiredArgsConstructor;
+				
+				@RequiredArgsConstructor
+				class A {
+				
+					@Autowired
+					A() {};
+					
+				}
+				""";
+		List<ReconcileProblem> problems = reconcile("A.java", source, false);
 
+		assertEquals(0, problems.size());
 	}
+
 }

headless-services/spring-boot-language-server/src/test/resources/test-projects/test-spring-validations/pom.xml

@@ -1,18 +1,19 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="https://maven.apache.org/POM/4.0.0" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
+<project xmlns="https://maven.apache.org/POM/4.0.0"
+	xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
 	xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 
 	<groupId>com.example</groupId>
 	<artifactId>test-spring-validations</artifactId>
 	<version>0.0.1-SNAPSHOT</version>
 	<packaging>jar</packaging>
-	
+
 	<parent>
 		<groupId>org.springframework.boot</groupId>
 		<artifactId>spring-boot-starter-parent</artifactId>
 		<version>3.4.4</version>
-		<relativePath/> <!-- lookup parent from repository -->
+		<relativePath /> <!-- lookup parent from repository -->
 	</parent>
 
 	<properties>
@@ -48,8 +49,14 @@
 			<artifactId>spring-boot-starter-test</artifactId>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>org.projectlombok</groupId>
+			<artifactId>lombok</artifactId>
+			<version>1.18.40</version>
+			<scope>provided</scope>
+		</dependency>
 	</dependencies>
-<!--
+	<!--
 	<build>
 		<plugins>
 			<plugin>