Maven 不包括 LWJGL 安装的清单属性

Question

我正在尝试使用 Maven 设置 LWJGL 项目。我正在使用来自the official website 的示例“入门”源代码。

这包括访问 LWJGL 清单属性的几行代码，例如简单的版本检查：

System.out.println("Hello LWJGL " + Version.getVersion() + "!");

这在Eclipse环境下运行没有任何问题（当然是在使用Maven构建项目之后），但是当运行clean install然后通过cmd运行**-jar-with-dependencies.jar时，会抛出以下异常：

java.lang.NullPointerException
        at org.lwjgl.system.APIUtil.apiGetManifestValue(APIUtil.java:97)
        at org.lwjgl.Version.getVersion(Version.java:33)
        at HelloWorld.run(HelloWorld.java:43)
        at HelloWorld.main(HelloWorld.java:130)

这是因为 APIUtil 创建的 Manifest 对象不包含任何属性 - 但仅在 Maven 构建的版本中。

这是为什么呢？是我的 pom.xml 有问题，还是 LWJGL 3.0.0 还没有为此做好准备？

这是我的pom.xml：

<properties>
    <mainClass>HelloWorld</mainClass>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <finalName>${project.artifactId}-${project.version}.jar</finalName>
</properties>

<dependencies>
    <dependency>
        <groupId>org.lwjgl</groupId>
        <artifactId>lwjgl</artifactId>
        <version>3.0.0</version>
    </dependency>
    <dependency>
        <groupId>org.lwjgl</groupId>
        <artifactId>lwjgl-platform</artifactId>
        <version>3.0.0</version>
        <classifier>natives-windows</classifier>
    </dependency>
    <dependency>
        <groupId>org.lwjgl</groupId>
        <artifactId>lwjgl-platform</artifactId>
        <version>3.0.0</version>
        <classifier>natives-linux</classifier>
    </dependency>
    <dependency>
        <groupId>org.lwjgl</groupId>
        <artifactId>lwjgl-platform</artifactId>
        <version>3.0.0</version>
        <classifier>natives-osx</classifier>
    </dependency>
</dependencies>

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.5.1</version>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
            </configuration>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-assembly-plugin</artifactId>
            <executions>
                <execution>
                    <phase>package</phase>
                    <goals>
                        <goal>single</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <descriptorRefs>
                    <descriptorRef>jar-with-dependencies</descriptorRef>
                </descriptorRefs>
                <archive>
                    <manifest>
                        <mainClass>${mainClass}</mainClass>
                    </manifest>
                </archive>
            </configuration>
        </plugin>
    </plugins>
</build>

Answer 1

出现此错误是因为 LWJGL 3.0.0 is looking inside the Manifest a property called "Implementation-Version"，但是当您制作 uber-jar 时，未设置此属性。

这并不是你如何制作 uber-jar 的问题：maven-assembly-plugin 创建的 Manifest 看起来像：

Manifest-Version: 1.0
Archiver-Version: Plexus Archiver
Built-By: Me
Created-By: Apache Maven 3.3.9
Build-Jdk: 1.8.0_102
Main-Class: HelloWorld

您可以在jar-with-dependencies 的META-INF/MANIFEST.MF 中看到它。此文件没有"Implementation-Version" 属性。这是正常的：当这个可执行 JAR 被创建时，所有依赖项的所有 MANIFEST 都（正确地）被忽略了，只生成一个包含 "Main-Class" 的文件，只是为了使 JAR 是可执行的。

uber-jar 不能包含每个依赖项清单中的内容。例如，"Implementation-Version" 是一个存在于多个库的清单中的属性，那么它应该保留哪个？ （最后只能有一个清单，在 uber-jar 中）。所以问题出现了，因为我们正在制作一个可执行的 JAR，它只能有 1 个 Manifest，因此它无法聚合每个依赖项清单中的所有属性。

有两种可能的解决方案：

1. 忽略它。毕竟，这并不是真正的错误。

2. 不要通过将所有依赖项嵌入到单个 JAR 中来创建可执行 jar，而是创建一个 ZIP 程序集，其中每个依赖项都位于 lib 文件夹中：这样，每个 Manifest 都会被保留。这是通过告诉maven-jar-plugin 为主类添加一个清单条目并添加类路径并创建自定义程序集描述符来完成的。

   <plugin>
       <artifactId>maven-jar-plugin</artifactId>
       <version>3.0.2</version>
       <configuration>
           <archive>
               <manifest>
                   <mainClass>${mainClass}</mainClass>
                   <addClasspath>true</addClasspath>
               </manifest>
           </archive>
       </configuration>
   </plugin>
   <plugin>
       <artifactId>maven-assembly-plugin</artifactId>
       <version>2.6</version>
       <executions>
           <execution>
               <phase>package</phase>
               <goals>
                   <goal>single</goal>
               </goals>
           </execution>
       </executions>
       <configuration>
           <descriptors>
               <descriptor>/path/to/assembly.xml</descriptor>
           </descriptors>
       </configuration>
   </plugin>
   

   其中/path/to/assembly.xml 是程序集描述符的路径，相对于 POM 的位置，即：

   <assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3" 
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3 http://maven.apache.org/xsd/assembly-1.1.3.xsd">
     <id>dist</id>
     <formats>
       <format>zip</format>
     </formats>
     <dependencySets>
       <dependencySet>
         <outputDirectory>lib</outputDirectory>
         <useProjectArtifact>true</useProjectArtifact>
       </dependencySet>
     </dependencySets>
   </assembly>
   

   通过这样的配置，运行mvn clean install 将创建一个ZIP 文件artifactId-version-dist.zip。解压并运行（将 <finalName> 替换为 JAR 的 finalName）

   java -jar lib\<finalName>.jar
   

   将打印版本没有任何问题。