redhat-developer / redhat-developer/vscode-java

Gradle Generated Sources from Annotation Processor not picked up correctly by intellisense nor will work with Run/Debug

未关闭
#2,981 0 条评论 10 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
TypeScript
星标
2.3k
派生
547
平均合并
20 小时 1 分钟
30 天内合并 PR
11

描述

Problem:
Unable to use annotation processor from Gradle and have intellisense or the run/debug menu work. Results in not found or package path issues.

  1. Using gradle build task, it compiles fine without issue
  2. Using gradle task from "fabric -> runClient" works fine without issue
  3. Using fabric -> configureClientLaunch to create the vscode launch.json does not allow me to use the Run and Debug if I am using annotation processor. Without it, it will work fine.
  4. Lombok works without issue
  5. Intellisense in source files that use the generated source will result in "The import net.glass.settings.GlassConfig cannot be resolved"
  6. Intellisense in generated files, when seen, will result in The declared package "net.glass.settings" does not match the expected package ""

I have seen some previous closed issues on this on this "eclipse jdt" repo and here, but I haven't had any success. I have yet to be able to get this to work without resorting to manually moving files around. Note that I do not know much about gradle nor do I know what eclipse is other than the IDE.

#2793 Support Gradle Annotation Processing
https://github.com/eclipse/eclipse.jdt.ls/pull/2319

I have also somewhat seen this mentioned on the Gradle Plugin page, but there are no real instructions or examples on HOW to change the source sets to make vscode happy, which doesn't even seem to be possible with version 8 of gradle.

See Class References section
https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-gradle

Environment
  • Operating System: macOS Ventura 13.2.1 (M1 mac)
  • JDK version: 17.0.2
  • Visual Studio Code version: 1.76.0 (Universal)
  • Java extension version: v1.15.0
  • Gradle Version: Tried both the latest version of 7 and 8
  • Gradle Extension Version: v3.12.6
Steps To Reproduce
  1. Include an annotation processor under dependencies
  2. Gradle build task to create generated source file
  3. vscode will complain about missing class

My repo is here:
https://github.com/alison-gravley/Glass

Not sure if these are the right log files. This was under the F1 -> Toggle Developer Tools -> Console tab

ERR ENOENT: no such file or directory, open '/Users/alison/Library/Application Support/Code/User/workspaceStorage/0d20f7af9fd0c96c108f44b4cb73ffde/redhat.java/jdt_ws/.metadata/.log': Error: ENOENT: no such file or directory, open '/Users/alison/Library/Application Support/Code/User/workspaceStorage/0d20f7af9fd0c96c108f44b4cb73ffde/redhat.java/jdt_ws/.metadata/.log'

unamed.log
client_2023_03_04.log
client_2023_03_05.log

Current Result

Intellisense does not see the generated source files and they show up as errors
Run & Debug views these as compilation errors and will not run

Things I have tried

I have tried several build.gradle changes that result in the sources sometimes being seen, but never interpreted correctly. I have reloaded the project from Gradle and deleted the workspace from Java Project on every change.

I have tried turning "Java › Import › Gradle

› Annotation Processing: Enabled" both on and off. More info below on that.

build.gradle
Solution 1: Eclipse???

Eclipse example I found. I have no idea what eclipse is other than the IDE, so I am not sure what all of these eclipse references are about. I do not have the eclipse IDE.

plugins {
	id 'fabric-loom' version '1.0-SNAPSHOT'
	id 'maven-publish'
	id 'io.freefair.lombok' version '6.6.1'
	id 'java'
    id 'eclipse'
}
...
dependencies {
...
    annotationProcessor modImplementation("io.wispforest:owo-lib:${project.owo_version}")
...
}
...
eclipse {
    classpath {
        containers 'org.eclipse.buildship.core.gradleclasspathcontainer'
        file.whenMerged { cp ->
            def entries = cp.entries;
            def src = new org.gradle.plugins.ide.eclipse.model.SourceFolder('build/generated/sources/annotationProcessor/java/main', null)
            entries.add(src)
        } 
    }
}
Solution 2: Various versions of adding the directory to source sets, but they cause warnings with Gradle and as of version 8 I cannot do this method at all without the below error.

Task ':sourcesJar' uses this output of task ':compileJava' without declaring an explicit or implicit dependency. This can lead to incorrect results being produced, depending on what order the tasks are executed.

plugins {
	id 'fabric-loom' version '1.0-SNAPSHOT'
	id 'maven-publish'
	id 'io.freefair.lombok' version '6.6.1'
	id 'java'
}
...
dependencies {
...
    annotationProcessor modImplementation("io.wispforest:owo-lib:${project.owo_version}")
...
}
...
sourceSets {
    test {
        runtimeClasspath += main.runtimeClasspath
        compileClasspath += main.compileClasspath
    }
    //With version 8 of gradle, this is no longer allowed and will not compile
    main {
        java {
            srcDir 'build/generated/sources/annotationProcessor/java/main'
        }
    }
}
Enabling Java › Import › Gradle › Annotation Processing: Enabled

Note: Eclipse and source sets items removed at this point

This adds a "bin/generated-sources/annotations" folder in addition to the ones that gradle creates within their build directory. This option gets me a step further, but I run into package path issues: The declared package "net.glass.settings" does not match the expected package ""

The only way I found to get this to work was to manually add the package path to the annotations folder and move the generated source file to there. This at least allows the intellisense AND Run & Debug to work as expected.

The only issue with this is eventually the file gets regenerated and I end up with 2 copies. Usually when I have to eventually "Clean Workspace", because something in the cache gets corrupted during a build or I change build.gradle and things get in a bad state. This is also bad as anytime I make a change to the class, I will have to manually fix it again.

In my specific example, I manually created the net.glass.settings folders so the package error would go away.
bin/generated-sources/annotations/net/glass/settings/GlassConfig.java

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从报告的 Glass 仓库及其 build.gradle 开始,然后检查 configureClientLaunch 入口点和附加日志,同时复现生成源导入以及 Run/Debug 失败的问题。将 Gradle 注解处理器的源路径与 Java 项目配置进行比较;当生成的类无需手动移动文件即可在 IntelliSense 和 Run/Debug 中解析时,即表示完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
java, vscode
领域
developer-experience, devtools
Issue 类型
缺陷
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
需要澄清
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。