java - 在自定义 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 图像: