将可运行.jar中的本机依赖项与 Maven 捆绑在一起

2022-09-02 13:34:12

我有一个在Maven中管理的项目,它有一些原生依赖项LWJGL)。

在开发过程中一切正常,但现在我想设置Maven,以便它将构建一个可运行的.jar文件,我可以重新分发。特别是,我希望用户能够非常容易地运行该应用程序,而不必弄乱库路径或解压缩本机库等。

目前,我能够构建一个包含所有依赖项的.jar文件,但是如果我运行它,那么(不出所料)我得到一个不满意的链接错误:

Exception in thread "main" java.lang.UnsatisfiedLinkError: no lwjgl in java.libr
ary.path
        at java.lang.ClassLoader.loadLibrary(Unknown Source)
        at java.lang.Runtime.loadLibrary0(Unknown Source)
        at java.lang.System.loadLibrary(Unknown Source)
        at org.lwjgl.Sys$1.run(Sys.java:73)
        at java.security.AccessController.doPrivileged(Native Method)
        at org.lwjgl.Sys.doLoadLibrary(Sys.java:66)
        at org.lwjgl.Sys.loadLibrary(Sys.java:95)
        at org.lwjgl.Sys.<clinit>(Sys.java:112)
        at org.lwjgl.opengl.Display.<clinit>(Display.java:132)
        at glaze.TestApp.start(TestApp.java:10)
        at glaze.TestApp.main(TestApp.java:31)

显然,我可以通过手动安装本机库并运行jar来使其工作,但这不是我可以期望我的用户做的事情。java -Djava.library.path=/path/to/libs

这是pom.xml以防万一它是相关的:https://github.com/mikera/glaze/blob/master/pom.xml

是否可以设置 Maven,以便创建包含本机依赖项的可运行.jar,并在双击时成功运行?


答案 1

这是我过去用来加载的一些代码或捆绑在jar中的库。dllso

必须将库添加为资源。我们使用 maven 并将它们放在这个层次结构中:

src/main/resources/lib/win-x86/<dlls for 32-bit windows>
src/main/resources/lib/linux-x86/<so for 32-bit linux>
src/main/resources/lib/linux-x86_64/<so for 64-bit linux>
src/main/resources/lib/linux-ia64/<so for 64-bit linux on itanium>

共享库将被解压缩到平台的 tmp 目录中,并且在解压缩时也有一个临时名称。这是为了让几个进程加载dll/so而不共享实际提取的dll/so,因为如果具有相同的名称,解压缩可能会覆盖现有的进程(当文件被替换时,在某些平台上具有非常奇怪的行为)。

该文件也设置为已设置,但这不适用于Windows AFAIK。deleteOnExit

NativeLoader.java

public class NativeLoader {

    public static final Logger LOG = Logger.getLogger(NativeLoader.class);

    public NativeLoader() {
    }

    public void loadLibrary(String library) {
        try {
            System.load(saveLibrary(library));
        } catch (IOException e) {
            LOG.warn("Could not find library " + library +
                    " as resource, trying fallback lookup through System.loadLibrary");
            System.loadLibrary(library);
        }
    }


    private String getOSSpecificLibraryName(String library, boolean includePath) {
        String osArch = System.getProperty("os.arch");
        String osName = System.getProperty("os.name").toLowerCase();
        String name;
        String path;

        if (osName.startsWith("win")) {
            if (osArch.equalsIgnoreCase("x86")) {
                name = library + ".dll";
                path = "win-x86/";
            } else {
                throw new UnsupportedOperationException("Platform " + osName + ":" + osArch + " not supported");
            }
        } else if (osName.startsWith("linux")) {
            if (osArch.equalsIgnoreCase("amd64")) {
                name = "lib" + library + ".so";
                path = "linux-x86_64/";
            } else if (osArch.equalsIgnoreCase("ia64")) {
                name = "lib" + library + ".so";
                path = "linux-ia64/";
            } else if (osArch.equalsIgnoreCase("i386")) {
                name = "lib" + library + ".so";
                path = "linux-x86/";
            } else {
                throw new UnsupportedOperationException("Platform " + osName + ":" + osArch + " not supported");
            }
        } else {
            throw new UnsupportedOperationException("Platform " + osName + ":" + osArch + " not supported");
        }

        return includePath ? path + name : name;
    }

    private String saveLibrary(String library) throws IOException {
        InputStream in = null;
        OutputStream out = null;

        try {
            String libraryName = getOSSpecificLibraryName(library, true);
            in = this.getClass().getClassLoader().getResourceAsStream("lib/" + libraryName);
            String tmpDirName = System.getProperty("java.io.tmpdir");
            File tmpDir = new File(tmpDirName);
            if (!tmpDir.exists()) {
                tmpDir.mkdir();
            }
            File file = File.createTempFile(library + "-", ".tmp", tmpDir);
            // Clean up the file when exiting
            file.deleteOnExit();
            out = new FileOutputStream(file);

            int cnt;
            byte buf[] = new byte[16 * 1024];
            // copy until done.
            while ((cnt = in.read(buf)) >= 1) {
                out.write(buf, 0, cnt);
            }
            LOG.info("Saved libfile: " + file.getAbsoluteFile());
            return file.getAbsolutePath();
        } finally {
            if (in != null) {
                try {
                    in.close();
                } catch (IOException ignore) {
                }
            }
            if (out != null) {
                try {
                    out.close();
                } catch (IOException ignore) {
                }
            }
        }
    }
}

通过创建 的实例,然后通过调用而不使用特定于操作系统的前缀和扩展来加载库。NativeLoaderloadLibrary("thelibrary")

这对我们来说效果很好,但您必须手动将共享库添加到不同的资源目录中,然后构建jar。

我意识到这个类中的一些代码可能很奇怪或过时,但请记住,这是我几年前编写的代码,它一直运行得很好。


答案 2

你有没有尝试在这里使用一个例子:maven-assembly-plugin

<build>
   <plugins>
      <plugin>
         <artifactId>maven-assembly-plugin</artifactId>
         <configuration>
         <archive>
             <manifest>
                <mainClass>your.main.Class</mainClass>
             </manifest>
         </archive>
         <descriptorRefs>
             <descriptorRef>jar-with-dependencies</descriptorRef>
         </descriptorRefs>
         </configuration>
       </plugin>
   </plugins>
</build>

对于本机依赖项,您可能希望在清单文件中使用。请参阅 http://wiki.osgi.org/wiki/Bundle-NativeCodeBundle-NativeCode

您可能还想看看:http://felix.apache.org/site/apache-felix-maven-bundle-plugin-bnd.html 使用Maven生成它。maven-bundle-plugin


推荐