我正在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'.
对于初学者,您要添加两个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
,方法是:
addStringOption
现在可以从类路径(javadoc {
options.addStringOption('-module-path', ...)
...
}
)中获取模块路径,但是JavaFX插件使用classpath.asPath
而不是已弃用的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")
}
应该可以正常工作。
至少我可以在`build / reports / uml下得到一些漂亮的SVG图像: