java - 如何在 JAR 中捆绑原生库和 JNI 库？

Question

有问题的图书馆是东京内阁。

我希望将本机库、JNI 库和所有 Java API 类放在一个 JAR 文件中，以避免重新分发的麻烦。

在 GitHub 上似乎有一个尝试，但是

1. 它不包括实际的本机库，仅包括 JNI 库。
2. 它似乎特定于Leiningen的本机依赖项插件（它不能作为可再发行组件工作）。

问题是，我可以将所有内容捆绑在一个 JAR 中并重新分发吗？如果是，如何？

PS：是的，我意识到它可能会影响可移植性。

Answer 1

可以创建一个包含所有依赖项的单个 JAR 文件，包括一个或多个平台的本机 JNI 库。基本机制是使用 System.load(File) 来加载库，而不是使用典型的 System.loadLibrary(String) 来搜索 java.library.path 系统属性。这种方法使安装更加简单，因为用户不必在他的系统上安装 JNI 库，但代价是可能不支持所有平台，因为平台的特定库可能不包含在单个 JAR 文件中.

过程如下：

• 在平台特定位置的 JAR 文件中包含本机 JNI 库，例如 NATIVE/${os.arch}/${os.name}/libname.lib
• 在主类的静态初始化器中创建代码以
  • 计算当前的 os.arch 和 os.name
  • 使用 Class.getResource(String) 在预定义位置的 JAR 文件中查找库
  • 如果存在，将其解压缩到一个临时文件并使用 System.load(File) 加载它。

我为 jzmq 添加了功能，它是 ZeroMQ 的 Java 绑定（无耻插件）。代码可以在这里找到。jzmq 代码使用混合解决方案，因此如果无法加载嵌入式库，代码将恢复为沿 java.library.path 搜索 JNI 库。

Answer 2

https://www.adamheinrich.com/blog/2012/12/how-to-load-native-jni-library-from-jar/

是很棒的文章，它解决了我的问题..

就我而言，我有以下代码用于初始化库：

static {
    try {
        System.loadLibrary("crypt"); // used for tests. This library in classpath only
    } catch (UnsatisfiedLinkError e) {
        try {
            NativeUtils.loadLibraryFromJar("/natives/crypt.dll"); // during runtime. .DLL within .JAR
        } catch (IOException e1) {
            throw new RuntimeException(e1);
        }
    }
}

Answer 3

看看One-JAR。它将使用专门的类加载器将您的应用程序包装在一个 jar 文件中，该类加载器处理“jars within jars”等。

它通过根据需要将本机 (JNI) 库解包到临时工作文件夹来处理它们。

（免责声明：我从未使用过 One-JAR，暂时还不需要，只是将它添加为书签以备不时之需。）

Answer 4

1) 将本机库作为资源包含到您的 JAR 中。例如。使用 Maven 或 Gradle，以及标准项目布局，将原生库放入main/resources目录。

2) 在与这个库相关的 Java 类的静态初始化器中的某处，将代码如下：

String libName = "myNativeLib.so"; // The name of the file in resources/ dir
URL url = MyClass.class.getResource("/" + libName);
File tmpDir = Files.createTempDirectory("my-native-lib").toFile();
tmpDir.deleteOnExit();
File nativeLibTmpFile = new File(tmpDir, libName);
nativeLibTmpFile.deleteOnExit();
try (InputStream in = url.openStream()) {
    Files.copy(in, nativeLibTmpFile.toPath());
}
System.load(nativeLibTmpFile.getAbsolutePath());

Answer 5

JarClassLoader是一个类加载器，用于从单个怪物 JAR 和怪物 JAR 中的 JAR 加载类、本机库和资源。

Answer 6

Kotlin 的解决方案：

• build.gradle.dsl: 将 kotlin 运行时 (kotlin-stdlib-1.4.0.jar) 和本机库 (librust_kotlin.dylib) 复制到 JAR

  tasks.withType<Jar> {
      manifest {
          attributes("Main-Class" to "MainKt")
      }
  
      val libs = setOf("kotlin-stdlib-1.4.0.jar")
  
      from(configurations.runtimeClasspath.get()
          .filter { it.name in libs }
          .map { zipTree(it) })
  
      from("librust_kotlin.dylib")
  }
  

• main方法：将库复制到临时文件以使用绝对路径加载它

   with(createTempFile()) {
       deleteOnExit()
       val bytes = My::class.java.getResource("librust_kotlin.dylib")
           .readBytes()
  
       outputStream().write(bytes)
       System.load(path)
   }
  

Answer 7

您可能必须将本机库解压缩到本地文件系统。据我所知，执行本机加载的代码是查看文件系统的。

这段代码应该可以帮助您入门（我有一段时间没看它了，它有不同的目的，但应该可以解决问题，我现在很忙，但是如果您有任何问题，请发表评论我会尽快回答）。

import java.io.Closeable;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.net.URLDecoder;
import java.security.CodeSource;
import java.security.ProtectionDomain;
import java.util.zip.ZipEntry;
import java.util.zip.ZipException;
import java.util.zip.ZipFile;


public class FileUtils
{
    public static String getFileName(final Class<?>  owner,
                                     final String    name)
        throws URISyntaxException,
               ZipException,
               IOException
    {
        String    fileName;
        final URI uri;

        try
        {
            final String external;
            final String decoded;
            final int    pos;

            uri      = getResourceAsURI(owner.getPackage().getName().replaceAll("\\.", "/") + "/" + name, owner);
            external = uri.toURL().toExternalForm();
            decoded  = external; // URLDecoder.decode(external, "UTF-8");
            pos      = decoded.indexOf(":/");
            fileName = decoded.substring(pos + 1);
        }
        catch(final FileNotFoundException ex)
        {
            fileName = null;
        }

        if(fileName == null || !(new File(fileName).exists()))
        {
            fileName = getFileNameX(owner, name);
        }

        return (fileName);
    }

    private static String getFileNameX(final Class<?> clazz, final String name)
        throws UnsupportedEncodingException
    {
        final URL    url;
        final String fileName;

        url = clazz.getResource(name);

        if(url == null)
        {
            fileName = name;
        }
        else
        {
            final String decoded;
            final int    pos;

            decoded  = URLDecoder.decode(url.toExternalForm(), "UTF-8");
            pos      = decoded.indexOf(":/");
            fileName = decoded.substring(pos + 1);
        }

        return (fileName);
    }

    private static URI getResourceAsURI(final String    resourceName,
                                       final Class<?> clazz)
        throws URISyntaxException,
               ZipException,
               IOException
    {
        final URI uri;
        final URI resourceURI;

        uri         = getJarURI(clazz);
        resourceURI = getFile(uri, resourceName);

        return (resourceURI);
    }

    private static URI getJarURI(final Class<?> clazz)
        throws URISyntaxException
    {
        final ProtectionDomain domain;
        final CodeSource       source;
        final URL              url;
        final URI              uri;

        domain = clazz.getProtectionDomain();
        source = domain.getCodeSource();
        url    = source.getLocation();
        uri    = url.toURI();

        return (uri);
    }

    private static URI getFile(final URI    where,
                               final String fileName)
        throws ZipException,
               IOException
    {
        final File location;
        final URI  fileURI;

        location = new File(where);

        // not in a JAR, just return the path on disk
        if(location.isDirectory())
        {
            fileURI = URI.create(where.toString() + fileName);
        }
        else
        {
            final ZipFile zipFile;

            zipFile = new ZipFile(location);

            try
            {
                fileURI = extract(zipFile, fileName);
            }
            finally
            {
                zipFile.close();
            }
        }

        return (fileURI);
    }

    private static URI extract(final ZipFile zipFile,
                               final String  fileName)
        throws IOException
    {
        final File         tempFile;
        final ZipEntry     entry;
        final InputStream  zipStream;
        OutputStream       fileStream;

        tempFile = File.createTempFile(fileName.replace("/", ""), Long.toString(System.currentTimeMillis()));
        tempFile.deleteOnExit();
        entry    = zipFile.getEntry(fileName);

        if(entry == null)
        {
            throw new FileNotFoundException("cannot find file: " + fileName + " in archive: " + zipFile.getName());
        }

        zipStream  = zipFile.getInputStream(entry);
        fileStream = null;

        try
        {
            final byte[] buf;
            int          i;

            fileStream = new FileOutputStream(tempFile);
            buf        = new byte[1024];
            i          = 0;

            while((i = zipStream.read(buf)) != -1)
            {
                fileStream.write(buf, 0, i);
            }
        }
        finally
        {
            close(zipStream);
            close(fileStream);
        }

        return (tempFile.toURI());
    }

    private static void close(final Closeable stream)
    {
        if(stream != null)
        {
            try
            {
                stream.close();
            }
            catch(final IOException ex)
            {
                ex.printStackTrace();
            }
        }
    }
}