我有一个javagradle项目,它使用openapi指定的api。我用过 org.openapi.generator
插件,生成源代码以及一个完整的gradle模块。
我希望有一种方法可以定义generate、compile和jar步骤,这样我就可以让其他模块依赖于生成的模块。
即
# api/build.gradle:
plugins {
id 'java'
id "org.openapi.generator" version "5.0.0"
}
repositories {
mavenCentral()
}
dependencies {
testImplementation group: 'junit', name: 'junit', version: '4.12'
}
compileJava.dependsOn "openApiGenerate"
openApiGenerate {
generatorName = "java"
inputSpec = "$projectDir/src/main/openapi/spec.yaml".toString()
outputDir = "$buildDir/generated"
apiPackage = "com.example.api"
invokerPackage = "com.example.api.invoker"
modelPackage = "com.example.api.model"
configOptions = [
dateLibrary: "java8",
library : "native"
]
groupId = "com.example"
id = "api"
}
``` `gradlew api:openApiGenerate` 生成(删除无关文件):
api/build/generated/
├── build.gradle
├── pom.xml
├── settings.gradle
└── src
├── main/java/...
└── test/java/...
是否有某种方式可以委托给、包含或依赖项目中其他模块生成的模块?生成的模块具有可靠的 `group:artifact:version` 协调。
i、 我想具体说明一下 `com.example:api:1.0` 在项目的其他地方。
我已经通读了https://docs.gradle.org/current/userguide/composite_builds.html 因为这似乎接近我的预期,但我是新来grad尔,这是有点深。
我尝试过重写中的主源代码集和测试源代码集 `api/build.gradle` 但是我不喜欢从 `api/build/generated/build.gradle` .
我发现https://docs.gradle.org/current/userguide/declaring_dependencies.html#sec:依赖类型,包括一个诱人的例子,但下降,因为它是一个源唯一的依赖。
dependencies {
implementation files("$buildDir/classes") {
builtBy 'compile'
}
}
我看了这个例子,但我如何依赖于一个项目( `api/build/generated/` )那还不存在?
dependencies {
implementation project(':shared')
}
2条答案
按热度按时间qvtsj1bj1#
好问题!我没有一个完美的答案,但希望以下仍然会有所帮助。
建议的方法
我会将依赖于生成的api的模块的构建与生成api的构建完全分开。此类生成之间的唯一连接应该是依赖关系声明。这意味着,您必须手动确保先构建api生成项目,然后才构建依赖项目。
默认情况下,这意味着在构建依赖项目之前也要发布api模块。这种默认设置的替代方法实际上是组合构建,例如,允许您在发布新生成的api之前先在本地测试它。但是,在创建/运行复合构建之前,您必须在每次openapi文档更改时手动运行api生成构建。
示例
假设您有一个项目,具体取决于生成的api。它的渐变结构将包含如下内容:
在运行a的构建之前,首先必须运行
./gradlew openApiGenerate
从你的api
项目。./gradlew publish
从api/build/generated/
目录。然后,a的构建可以从发布存储库中获取已发布的依赖项。
或者,您可以在本地删除步骤2,并使用附加的gradle cli选项运行a的构建:
减少体力劳动的想法
我想了很多,但没有想出任何完整的解决方案-因此我不完美的建议上面。让我总结一下我的想法。
您将拥有一个gradle构建,它生成api–类似于
api
项目。这个版本也会被提交给你的风投。该构建将发布生成的api,即使它本身不会生成它。相反,它将以某种方式委托给
openApiGenerate
任务。代表团必须通过GradleBuild
任务。关键在于:必须通过gradlecli有效地检索有关依赖项和已发布工件的所有信息。我怀疑这目前是可能的。
依赖于api的项目可以包括
api
-就像gradle项目中的一个复合构建,而不需要上述方法的手动麻烦。czfnxgou2#
以@chriki的答案展开我实际使用的内容:
定义
api/
因为这是一个空的项目api/settings.gradle
文件。这告诉gradle这是一个独立的项目。
使用以下内容定义api模块:
注意
group
以及id
(和version
)显式定义其maven坐标。包含包含替换的构建,以便依赖项可以使用其maven坐标:
... 在其他模块中:
它的主要优点是
./gradlew --include-build api/build/generated
是不是我的ide也会把它“链接”起来。生成api库:
构建/运行主项目: