Gradle：构建与Java 8 兼容的模块化库

Question

所以 Java 9 就在那里，很快就会有 Java 10。是时候让我们的库准备好在 Java 9 项目中使用了。我是通过以下方式做到的：

提供模块-info.java
在 build.gradle

根据 gradle 站点上的 guide 手动更改，而不是使用拼图插件。

到目前为止，这两种方法都工作正常，我可以在 Java 9 个项目中使用生成的 Jar。

问题是，生成的 Jar 与 Java 8 不兼容，尽管我没有使用 Java 9 的功能，除了 module-info.java。当我设置 targetCompatibility = 8 时，一条错误消息告诉我也相应地设置 sourceCompatibility = 8。然后拒绝我应该设置 sourceCompatibility = 9.

的 module-info.java

如何解决？

我再次删除了拼图插件，并尝试了这个，但卡住了：

设置sourceCompatibility = 8和targetCompatibility = 8
创建一个包含单个文件 module-info.java

moduleInfo

为新的源集设置 sourceCompatibility = 9 和 targetCompatibility = 9

现在可以编译了，Gradle 在尝试编译 module-info.java 时使用 Java 9。但是，缺少模块（在本例中为 log4j），我收到此错误：

:compileJava UP-TO-DATE
:processResources NO-SOURCE
:classes UP-TO-DATE
:jar UP-TO-DATE
:sourcesJar UP-TO-DATE
:assemble UP-TO-DATE
:spotbugsMain UP-TO-DATE
:compileModuleInfoJava
classpath:
compilerArgs: [--module-path, , --add-modules, ALL-SYSTEM]
D:\git\utility\src\module-info\java\module-info.java:14: error: module not found: org.apache.logging.log4j
    requires org.apache.logging.log4j;
                               ^
warning: using incubating module(s): jdk.incubator.httpclient
1 error
1 warning
:compileModuleInfoJava FAILED

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':compileModuleInfoJava'.
> Compilation failed; see the compiler error output for details.

* 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
5 actionable tasks: 1 executed, 4 up-to-date

这是build.gradle使用的（Gradle版本是4.5.1）：

plugins {
  id "com.github.spotbugs" version "1.6.0"
}

apply plugin: 'maven'
apply plugin: 'maven-publish'
apply plugin: 'java-library'
apply plugin: 'com.github.spotbugs'

sourceCompatibility = 8
targetCompatibility = 8

group = 'com.dua3.utility'

repositories {
    mavenLocal()
    jcenter()
}

dependencies {
  compile     group: 'org.apache.logging.log4j', name: 'log4j-api', version: '2.10.0'
  testRuntime group: 'org.apache.logging.log4j', name: 'log4j-core', version: '2.10.0'

  // Use JUnit test framework
  testImplementation 'junit:junit:4.12'
}

ext.moduleName = 'com.dua3.utility' 

sourceSets {
    moduleInfo {
        java {
            srcDir 'src/module-info/java'            
        }
    }
}

compileModuleInfoJava {
    sourceCompatibility = 9
    targetCompatibility = 9

    inputs.property("moduleName", moduleName)

    doFirst {
        options.compilerArgs = [
            '--module-path', classpath.asPath,
            '--add-modules', 'ALL-SYSTEM'
        ]
        classpath = files()  
        System.out.println("classpath: "+classpath.asPath)
        System.out.println("compilerArgs: "+options.compilerArgs)
    }
}

tasks.withType(com.github.spotbugs.SpotBugsTask) {
    reports {
        xml.enabled false
        html.enabled true
    }
}

task sourcesJar(type: Jar, dependsOn: classes) {
    classifier = 'sources'
    from sourceSets.main.allSource
}

task javadocJar(type: Jar, dependsOn: javadoc) {
    classifier = 'javadoc'
    from javadoc.destinationDir
}

artifacts {
    archives sourcesJar
// fails with jigsaw:    archives javadocJar
}

defaultTasks 'build', 'publishToMavenLocal', 'install'

这是module-info.java:

module com.dua3.utility {
    exports com.dua3.utility;
    exports com.dua3.utility.io;
    exports com.dua3.utility.jfx;
    exports com.dua3.utility.swing;
    exports com.dua3.utility.lang;
    exports com.dua3.utility.math;
    exports com.dua3.utility.text;

    requires javafx.controls;
    requires javafx.web;
    requires java.xml;
    requires java.desktop;
    requires org.apache.logging.log4j;
}

Answer 1

好的，我终于让它工作了。如果其他人想知道怎么做，这就是我所做的：

将 Java 版本设置为 8，这样该库将可供 Java 8 个应用程序使用：

来源兼容性 = 8
targetCompatibility = 8
配置模块名称

ext.moduleName = com.dua3.utility

添加仅包含 module-info.java:

的新源集

 sourceSets {
        moduleInfo {
            java {
                srcDir 'src/module-info/java'            
            }
        }
    }

将moduleInfo、sourceSet的兼容性设置为Java9，配置模块，并设置输出目录：

 compileModuleInfoJava {
    sourceCompatibility = 9    
    targetCompatibility = 9

inputs.property("moduleName", moduleName)

doFirst {
    classpath += sourceSets.main.compileClasspath

    options.compilerArgs = [
        '--module-path', classpath.asPath,
        '--add-modules', 'ALL-SYSTEM,org.apache.logging.log4j',
        '-d', sourceSets.main.output.classesDirs.asPath
    ]
}
}

配置 jar 任务以包含 moduleInfo:

jar 
{
  from sourceSets.main.output
  from sourceSets.moduleInfo.output
}

如果您使用 SpotBugs 插件，您还必须显式配置 sourceSet，否则它在尝试处理 ModuleInfo sourceSet 时会失败。

我终于得到了这个版本的 build.gradle:

plugins {
  id "com.github.spotbugs" version "1.6.0"
}

apply plugin: 'maven'
apply plugin: 'maven-publish'
apply plugin: 'java-library'
apply plugin: 'com.github.spotbugs'

sourceCompatibility = 8
targetCompatibility = 8

group = 'com.dua3.utility'

repositories {
    mavenLocal()
    jcenter()
}

dependencies {
  compile group: 'org.apache.logging.log4j', name: 'log4j-api', version: '2.10.0'
  testRuntime group: 'org.apache.logging.log4j', name: 'log4j-core', version: '2.10.0'

  // Use JUnit test framework
  testImplementation 'junit:junit:4.12'
}

ext.moduleName = 'com.dua3.utility' 

sourceSets {
    moduleInfo {
        java {
            srcDir 'src/module-info/java'            
        }
    }
}

compileModuleInfoJava {
    sourceCompatibility = 9
    targetCompatibility = 9

    inputs.property("moduleName", moduleName)

    doFirst {
        classpath += sourceSets.main.compileClasspath

        options.compilerArgs = [
            '--module-path', classpath.asPath,
            '--add-modules', 'ALL-SYSTEM',
            '-d', sourceSets.main.output.classesDirs.asPath
        ]
    }
}

jar 
{
    from sourceSets.main.output
    from sourceSets.moduleInfo.output
}

spotbugs {
    sourceSets = [sourceSets.main]
}

tasks.withType(com.github.spotbugs.SpotBugsTask) {
    reports {
        xml.enabled false
        html.enabled true
    }
}

task sourcesJar(type: Jar, dependsOn: classes) {
    classifier = 'sources'
    from sourceSets.main.allSource
}

task javadocJar(type: Jar, dependsOn: javadoc) {
    classifier = 'javadoc'
    from javadoc.destinationDir
}

artifacts {
    archives sourcesJar
    archives javadocJar
}

defaultTasks 'build', 'publishToMavenLocal', 'install'

Answer 2

这个问题已经存在一年多了，但为了防止有人在这里绊倒，此功能现在由 Gradle 模块插件 自版本 1.5.0 支持.

使用此插件，您无需创建自定义源集，只需调用modularity.mixedJavaRelease方法即可。

下面是如何将插件应用到主程序的示例build.gradle：

plugins {
  // your remaining plugins here

  id 'org.javamodularity.moduleplugin' version '1.5.0' apply false
}

subprojects {
  // your remaining subproject configuration here

  apply plugin: 'org.javamodularity.moduleplugin'
  modularity.mixedJavaRelease 8 // sets "--release 8" for main code, and "--release 9" for "module-info.java"

  // test.moduleOptions.runOnClasspath = true // optional (if you want your tests to still run on classpath)
}

Answer 3

我为此开发了一个 Gradle 插件：https://github.com/Glavo/module-info-compiler

我试过GradleModules Plugin，但是还是有些麻烦的问题，所以开发了这个插件，一个专门用来编译module-info.java.

的编译器

不是调用javac实现的。是一个完整的编译器，可以运行以上Java 8.识别module-info.java的语法，并根据它生成对应的module-info.class文件。

它只检查语法，并不实际检查那些包，类或模块，所以它可以在不配置任何模块路径的情况下工作。

这个 Gradle 插件已经为您处理了一切。对于一个包含module-info.java的Java8项目，你只需要这样做：

plugins {
    id("java")
    id("org.glavo.compile-module-info-plugin") version "2.0"
}

tasks.compileJava {
    options.release.set(8)
}

此答案复制自己在另一个问题()下写的答案。

Gradle：构建与Java 8 兼容的模块化库

Gradle: Building a modularized library that is compatible with Java 8

java

gradle

java-platform-module-system

build.gradle

java-9