Apache Maven JDeps插件3.0.0版本发布

jopen 8年前
 

一个全新的maven插件 刚刚发布 ,可利用jdeps实用程序查找JDK内部API的使用情况。当该插件被激活时,在代码中如果发现任何内部API的调用都会导致maven构建失败。从Java 9开始,内部API将变为不可访问,因此这个插件可以帮助开发者让他们的代码与下一版本的Java兼容。尽管标注为3.0.0,实际上这是该插件的第一个发布版本。

正如在其 项目主页 中所描述的,该插件为用户提供两个可用的目标:jdkinternals和test-jdkinternals。前一个目标会检查主代码中是否包含对内部API的引用,而后一个则对测试代码做同样的检查;jdkinternals默认情况下会与maven的process-classes阶段(在编译后立即执行)相关联,而test-jdkinternals则会与process-test-classes阶段相关联(在测试代码编译后立即执行)。默认的配置可以引用该插件并以如下方式同时激活两个目标:

<build>   <plugins>    <plugin>     <groupid>org.apache.maven.plugins</groupid>     <artifactid>maven-jdeps-plugin</artifactid>     <version>3.0.0</version>     <executions>      <execution>       <goals>          <goal>jdkinternals</goal>          <goal>test-jdkinternals</goal>       </goals>      </execution>     </executions>    </plugin>    <!— Other plugins —>   </plugins>  </build>

举例来说,假设一个项目使用了内部类 sun.misc.BASE64Decoder 。当该项目配置使用了JDeps插件,maven会构建失败并提示如下原因:

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-jdeps-plugin:3.0.0:jdkinternals (default) on project   : Found offending packages:  [ERROR] sun.misc -> JDK internal API (rt.jar)  [ERROR] -> [Help 1]

作为其中一部分输出,对于项目中的每个包,maven还会列示出所有引用了该段代码的包,以及该包的源码。作为上个示例输出的一部分,我们会发现如下包中使用了BASE64Decoder:

package.name (classes)        [... other packages ...]        -> sun.misc                                           JDK internal API (rt.jar)

这能够帮助开发人员定位出现问题的地方。不过有另外一种方法能够获取到更多细节。 如之前所述,这个插件基于由Oracle提供的,作为JDK 8一部分的 jdeps 工具包。如果插件由于查找到对内部API的引用,强制构建失败,用户就可以使用jdeps尝试找出与导致问题的API相关的更多信息;有时,如果有非内部API可替换,jdeps甚至可以为用户指出该非内部API。继续上面提到的BASE64Decoder的例子,运行带有合适选项的jdeps将会得出如下结果:

jdeps -jdkinternals target/classes/*      [...]    JDK Internal API                         Suggested Replacement  ----------------                         ---------------------  sun.misc.BASE64Decoder                   Use java.util.Base64 @since 1.8

不过,如果某个内部API还不存在可替代品,就像sun.misc.Unsafe,这个插件有可能会阻断开发。由于这个缘故,该插件对于那些目前尚未使用任何内部API并且希望确保将来也不会使用它们的用户来说最为实用。Martijn Verburg,jClarity的联合创始人,自2012年以来的Java冠军程序员,在 最近的一次交流 当中,鼓励所有的开发者使用Apache Maven JDeps插件,以减少将来向Java 9迁移所需投入的精力。

查看英文原文: Apache Maven JDeps Plugin 3.0.0 Released