在自定义 uml 任务中找不到 Gradle 模块

Question

我在 javadoc 上使用这个“插件”来生成带有 Gradle 的 UML 类图：https://github.com/talsma-ict/umldoclet 这个“插件”使用 javadoc 创建 UML 类图。

我正在使用 JavaFX 库来构建我的应用程序。当我运行应该生成图像的自定义任务时，我的module-info.java 中出现错误，即找不到javafx.controls。

build.gradle:

plugins {
id 'application'
id 'org.openjfx.javafxplugin' version '0.0.8'
id 'org.beryx.jlink' version '2.12.0'
}

apply plugin: 'java'

repositories {
    mavenCentral()
}

configurations {
    umlDoclet
}

dependencies {
    // https://mvnrepository.com/artifact/org.apache.commons/commons-collections4
    compile group: 'org.apache.commons', name: 'commons-collections4', version: '4.4'
    // https://mvnrepository.com/artifact/mysql/mysql-connector-java
    compile group: 'mysql', name: 'mysql-connector-java', version: '8.0.18'
    // Used for generating UML class diagram
    umlDoclet "nl.talsmasoftware:umldoclet:2.0.6"
}

javafx {
    version = "13"
    modules = [ 'javafx.controls', 'javafx.fxml' ]
}

javadoc {
    source = sourceSets.main.allJava
    options.docletpath = configurations.umlDoclet.files.asType(List)
    options.doclet = "nl.talsmasoftware.umldoclet.UMLDoclet"
}

task generateUmlClass(type: Javadoc) {
    dependsOn("javadoc")
    source = sourceSets.main.allJava
    destinationDir = reporting.file("uml")
    options.docletpath = configurations.umlDoclet.files.asType(List)
    options.doclet = "nl.talsmasoftware.umldoclet.UMLDoclet"
}

mainClassName = "$moduleName/nl.avans.sagrada.MainApp"

jlink {
    options = ['--strip-debug', '--compress', '2', '--no-header-files', '--no-man-pages']
    launcher {
        name = 'Sagrada'
    }
}

我尝试添加dependsOn("javadoc")，所以我会先构建，但这似乎不起作用。

我的module-info.java

module Sagrada {
requires javafx.controls;
requires java.sql;

opens nl.avans.sagrada to javafx.base;
opens nl.avans.sagrada.controllers to javafx.controls;
opens nl.avans.sagrada.view.scenes to javafx.controls;
opens nl.avans.sagrada.view.panes to javafx.controls;

opens nl.avans.sagrada.database to java.sql;

exports nl.avans.sagrada;
exports nl.avans.sagrada.controllers;
exports nl.avans.sagrada.view.scenes;
exports nl.avans.sagrada.view.panes;
exports nl.avans.sagrada.interfaces;
exports nl.avans.sagrada.helpers;
exports nl.avans.sagrada.models;
exports nl.avans.sagrada.database;
exports nl.avans.sagrada.database.annotations;
exports nl.avans.sagrada.database.models;
}

每当我尝试运行gradle generateUmlClass 时，都会出现以下错误：

2:55:13 PM: Executing task 'generateUmlClass'...

> Configure project :
Found module name 'Sagrada'

> Task :compileJava UP-TO-DATE
> Task :processResources UP-TO-DATE
> Task :classes UP-TO-DATE
> Task :jar
> Task :startScripts
> Task :distTar
> Task :distZip
> Task :assemble
> Task :compileTestJava NO-SOURCE
> Task :processTestResources NO-SOURCE
> Task :testClasses UP-TO-DATE
> Task :test NO-SOURCE
> Task :check UP-TO-DATE
> Task :build

> Task :generateUmlClass FAILED
D:\Avans\Blok 2\Sagrada-Core\src\main\java\module-info.java:2: error: module not found: javafx.controls
    requires javafx.controls;
                   ^
D:\Avans\Blok 2\Sagrada-Core\src\main\java\module-info.java:3: error: module not found: javafx.fxml
    requires javafx.fxml;
                   ^
2 errors

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':generateUmlClass'.
> Javadoc generation failed. Generated Javadoc options file (useful for troubleshooting): 'D:\Avans\Blok 2\Sagrada-Core\build\tmp\generateUmlClass\javadoc.options'

* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.

* Get more help at https://help.gradle.org

BUILD FAILED in 1s
7 actionable tasks: 5 executed, 2 up-to-date
2:55:15 PM: Task execution finished 'generateUmlClass'.

Answer 1

对于初学者，您要添加两个 javadoc 任务：

javadoc {
    source = sourceSets.main.allJava
    options.docletpath = configurations.umlDoclet.files.asType(List)
    options.doclet = "nl.talsmasoftware.umldoclet.UMLDoclet"
}

task generateUmlClass(type: Javadoc) {
    dependsOn("javadoc")
    source = sourceSets.main.allJava
    destinationDir = reporting.file("uml")
    options.docletpath = configurations.umlDoclet.files.asType(List)
    options.doclet = "nl.talsmasoftware.umldoclet.UMLDoclet"
}

使用相同的选项，当您运行./gradlew generateUmlClass 时，您正在调用这两个任务。

如果您向其中一个添加一些必需的选项，另一个将错过它。所以你应该只使用一个。让我们保留默认任务javadoc。

现在：

javadoc {
    source = sourceSets.main.allJava
    options.docletpath = configurations.umlDoclet.files.asType(List)
    options.doclet = "nl.talsmasoftware.umldoclet.UMLDoclet"
    destinationDir = reporting.file("uml")
}

如果你运行./gradlew javadoc，你会得到你报告的错误：

...src/main/java/module-info.java:2: error: module not found: javafx.controls
    requires javafx.controls;
                   ^

这是因为 JavaFX 是模块化的，您应该将它放在模块路径中。

JavaFX gradle org.openjfx.javafxplugin 插件对 run 任务执行此操作，但对于 Javadoc 任务则不然，因此要解决此问题，我们需要使用模块路径向任务添加一个选项。

使用gradle的addStringOption，方法是：

javadoc {
    options.addStringOption('-module-path', ...)
    ...
}

模块路径现在可以从类路径 (classpath.asPath) 中获取，但是 JavaFX 插件使用implementation 而不是已弃用的compile，所以现在我们需要使用runtimeClasspath：

javadoc {
    options.addStringOption('-module-path', configurations.runtimeClasspath.asPath)
    ...
}

最后，这就是你所需要的：

javadoc {
    options.addStringOption('-module-path', configurations.runtimeClasspath.asPath)
    source = sourceSets.main.allJava
    options.docletpath = configurations.umlDoclet.files.asType(List)
    options.doclet = "nl.talsmasoftware.umldoclet.UMLDoclet"
    destinationDir = reporting.file("uml")
}

现在运行 ./gradlew javadoc 应该可以成功。

至少我可以在 `build/reports/uml: 下获得一些不错的 SVG 图像：

Answer 2

请让我为这个似乎已经解决的问题提供一些背景信息。 我是UMLDoclet的作者；它是一个 Javadoc Doclet，它确实是 Javadoc 工具的一种插件。

它的工作原理如下：

1. 从您的 Javadoc 版本调用 Standard Doclet 以生成常规 HTML 文档。
2. 生成以下PlantUML 图表：
   1. 每个记录类的类图
   2. 每个记录包的包图
   3. 带有包含所有文档包的依赖图的包依赖图（这是您共享的图，顺便说一下，它包含许多 dependency cycles）
3. 后处理生成的 HTML 文档以在可能的情况下嵌入类、包和依赖关系图。

由于doclet使用PlantUML，所以生成图表时必须在本地安装Graphviz。

顺便说一句；如果您在我的 github 存储库中的 issue you filed 中包含指向此 Stackoverflow 帖子的链接，我将不胜感激。

很高兴您的问题得到解决，我要感谢 José Pereda 的详尽回答！