VSCode无法识别Gradle项目中Lombok依赖的问题排查与解决

问题背景 #

我正在用VSCode开发Gradle项目，已经安装了以下扩展：

• Gradle for Java
• Gradle Language Support
• Language Support for Java
• Project Manager for Java

但Lombok的导入无法被解析，提示The import lombok cannot be resolved: Java(268435846)。我熟悉C/C++的LSP，但对Java领域不太了解，有两个疑问：

1. Gradle for Java和Language Support for Java之间是什么关系？我觉得如果后者不知道build.gradle里的依赖，就没法正常工作。
2. 怎么在Language Support for Java中打印已索引包的调试信息？

附上我的build.gradle文件内容：

/*
 * This file was generated by the Gradle 'init' task.
 *
 * This generated file contains a sample Java application project to get you started.
 * For more details on building Java & JVM projects, please refer to https://docs.gradle.org/8.8/userguide/building_java_projects.html in the Gradle documentation.
 */

plugins {
    // Apply the application plugin to add support for building a CLI application in Java.
    id 'application'
}

repositories {
    // Use Maven Central for resolving dependencies.
    mavenCentral()
}

dependencies {
    // Use JUnit Jupiter for testing.
    testImplementation libs.junit.jupiter

    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'

    // This dependency is used by the application.
    implementation libs.guava

    // https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-web
implementation 'org.springframework.boot:spring-boot-starter-web:3.3.3'

    compileOnly 'org.projectlombok:lombok:1.18.34'
    annotationProcessor 'org.projectlombok:lombok:1.18.34'
    
    testCompileOnly 'org.projectlombok:lombok:1.18.34'
    testAnnotationProcessor 'org.projectlombok:lombok:1.18.34'

}

// Apply a specific Java toolchain to ease working on different environments.
java {
    toolchain {
        languageVersion = JavaLanguageVersion.of(21)
    }
}

application {
    // Define the main class for the application.
    mainClass = 'moso_blog.App'
}

tasks.named('test') {
    // Use JUnit Platform for unit tests.
    useJUnitPlatform()
}

解答与解决方案 #

针对疑问的解答 #

1. Gradle for Java与Language Support for Java的关系

   • Language Support for Java是VSCode中Java语言服务的核心，负责代码补全、语法检查、重构等基础LSP功能，默认依赖项目类路径识别库，但原生不直接解析Gradle配置。
   • Gradle for Java是对接Gradle的专属扩展，它会解析build.gradle生成Java语言服务能识别的类路径信息，并同步给Language Support for Java，相当于两者之间的桥接工具——前者处理Gradle构建逻辑，后者提供Java代码编辑体验。

2. 打印Language Support for Java已索引包的调试信息

   • 打开VSCode设置，搜索java.trace.server，将其值改为verbose。
   • 切换到VSCode的输出面板，在下拉菜单中选择Language Support for Java，就能看到包含已索引包、类路径加载等的详细调试日志。
   • 问题解决后记得改回off，避免日志过多占用资源。

解决Lombok依赖无法识别的步骤 #

1. 安装Lombok专属扩展
   当前扩展列表缺少Lombok Annotations Support for VS Code，必须安装该扩展才能让Java语言服务正确识别Lombok的注解和导入语句。

2. 强制Gradle同步依赖

   • 打开VSCode左侧的Gradle面板，点击顶部的刷新按钮，重新同步项目依赖。
   • 或者在终端执行命令：

     # Linux/Mac
     ./gradlew clean build --refresh-dependencies
     # Windows
     gradlew.bat clean build --refresh-dependencies
     

     强制Gradle重新下载并构建依赖。

3. 重置Java语言服务缓存

   • 按下Ctrl+Shift+P（Windows/Linux）或Cmd+Shift+P（Mac）打开命令面板，输入Java: Clean Java Language Server Workspace并执行，随后重启VSCode。
   • 这会清除语言服务的旧缓存，重新根据Gradle同步后的类路径索引依赖。

4. 开启注解处理器支持

   • 打开VSCode设置，搜索java.completion.annotationProcessing.enabled，确保该选项已勾选，让语言服务能处理Lombok的编译时注解。

内容的提问来源于stack exchange，提问作者syheliel syheliel