如何为 JAR 和调试正确引用资源文件？

Question

在使用 Maven 项目和 Jar 文件时，我遇到了一个严重的资源引用问题...

我将所有资源都放在一个专用文件夹 /src/main/resources 中，该文件夹是 Eclipse 中构建路径的一部分。使用

引用文件

getClass().getResource("/filename.txt")

这在 Eclipse 中运行良好，但在 Jar 文件中失败 - 资源位于 jar 根目录正下方的文件夹中...

有谁知道在 Eclipse 中引用 JAR 和 (!) 中的文件的“最佳实践”？

编辑： 问题是，虽然资源实际上位于顶层文件夹“资源”中的 JAR 中，但上述方法无法找到该文件...

Answer 1

打包 JAR 后，您的资源文件不再是文件，而是流，因此 getResource 将不起作用！

使用getResourceAsStream。

要获取“文件”内容，请使用https://commons.apache.org/proper/commons-io/javadocs/api-release/org/apache/commons/io/IOUtils.html：

static public String getFile(String fileName)
{
        //Get file from resources folder
        ClassLoader classLoader = (new A_CLASS()).getClass().getClassLoader();

        InputStream stream = classLoader.getResourceAsStream(fileName);

        try
        {
            if (stream == null)
            {
                throw new Exception("Cannot find file " + fileName);
            }

            return IOUtils.toString(stream);
        }
        catch (Exception e) {
            e.printStackTrace();

            System.exit(1);
        }

        return null;
}

Answer 2

我遇到了类似的问题。 经过一整天的尝试每种组合和调试后，我尝试了 getClass().getResourceAsStream("resources/filename.txt") 并最终让它工作。 没有其他帮助。

Answer 3

Maven 资源文件夹的内容被复制到目标/类，并从那里复制到生成的 Jar 文件的根目录。这是预期的行为。

我不明白您的方案中存在什么问题。通过getClass().getResource("/filename.txt") 引用资源从类路径的根开始，无论它（或其元素）是target/classes 还是JAR 的根。我看到的唯一可能的错误是您使用了错误的ClassLoader。

确保使用资源的类与资源在同一个工件 (JAR) 中并执行ThatClass.class.getResource("/path/with/slash") 或ThatClass.class.getClassLoader().getResource("path/without/slash")。

但除此之外：如果它不起作用，您可能在构建过程中的某个地方做错了什么。你能验证资源在 JAR 中吗？

Answer 4

如果您在 jar 文件中添加资源目录（因此它位于 jar 中的 /resources 文件夹下，并且如果 /src/main 在 eclipse 中的构建路径中，那么您应该能够将您的文件引用为：

getClass().getResource("/resources/filename.txt");  

应该在两种环境中都可以使用。

Answer 5

问题是在 IDE 中 getClass().getResource("Path");访问文件时字符串不区分大小写，但从 jar 运行时它是。与文件相比，检查您在目录上的大小写。它确实有效。此外，如果您尝试 new File(getClass().getResource("Path"); 该文件将无法在 IDE 之外读取。

Answer 6

也许这种方法在某些情况下会有所帮助。

public static File getResourceFile(String relativePath)
{
    File file = null;
    URL location = <Class>.class.getProtectionDomain().getCodeSource().getLocation();
    String codeLocation = location.toString();
    try{
        if (codeLocation.endsWith(".jar"){
            //Call from jar
            Path path = Paths.get(location.toURI()).resolve("../classes/" + relativePath).normalize();
            file = path.toFile();
        }else{
            //Call from IDE
            file = new File(<Class>.class.getClassLoader().getResource(relativePath).getPath());
        }
    }catch(URISyntaxException ex){
        ex.printStackTrace();
    }
    return file;
}

Answer 7

只需将文件复制到临时目录即可。

String tempDir = System.getProperty("java.io.tmpdir");
File file = new File(tempDir.getAbsolutePath(), "filename.txt");
if (!file.exists()) {
     InputStream is = (getClass().getResourceAsStream("/filename.txt"));
     Files.copy(is, file.getAbsoluteFile().toPath());
}