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

2 周，4 日 Questions & Answers 322

我在javadoc上使用这个“插件”生成一个带有Gradle:https://github.com/talsma-ict/umldoclet的UML类图这个“插件”使用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'.

Tags:

共 (2) 个答案

# 1 楼答案
请允许我为这个似乎已经解决的问题提供一些背景资料。我是UMLDoclet的作者；它是一个Javadoc Doclet，实际上是Javadoc工具的插件

其工作原理如下：
1. 从Javadoc版本中调用StandardDoclet来生成常规的HTML文档
2. 生成以下PlantUML图：
  1. 每个文档化类的类图
  2. 每个文件包的包图
  3. 包依赖关系图，带有包含所有文档包的依赖关系图（这是您共享的图，顺便说一下，它包含许多dependency cycles）
3. 对生成的HTML文档进行后处理，尽可能嵌入类、包和依赖关系图
因为doclet使用PlantUML，所以在生成图表时必须在本地安装Graphviz

顺便说一下；如果你在我的github repo中的issue you filed中包含一个指向Stackoverflow帖子的链接，我会非常感激

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

# 2 楼答案

首先，您将添加两个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的^{}，方法是：

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图像：

Python中文网

有 Java 编程相关的问题?

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

共 (2) 个答案

# 1 楼答案

# 2 楼答案