如何从Java中读取jar文件?

时间:2010-07-30 08:27:33

标签: java file-io jar

我想读取位于我的类路径中包含的jar之一的XML文件。如何阅读jar中包含的任何文件?

5 个答案:

答案 0 :(得分:104)

如果您想从应用程序内部读取该文件,请使用:

InputStream input = getClass().getResourceAsStream("/classpath/to/my/file");

路径以“/”开头,但这不是文件系统中的路径,而是在类路径中。因此,如果您的文件位于类路径“org.xml”并且名为myxml.xml,则您的路径看起来像“/org/xml/myxml.xml”。

InputStream读取文件的内容。如果需要,可以将其包装到Reader中。

我希望有所帮助。

答案 1 :(得分:52)

啊,这是我最喜欢的科目之一。基本上有两种方法可以通过类路径加载资源:

Class.getResourceAsStream(resource)

ClassLoader.getResourceAsStream(resource)

(还有其他方法涉及以类似的方式获取资源的URL,然后打开与它的连接,但这是两种直接的方式。)

第一种方法在修改资源名称后实际委托给第二种方法。基本上有两种资源名称:绝对(例如“/ path / to / resource / resource”)和relative(例如“resource”)。绝对路径以“/”开头。

这是一个应该说明的例子。考虑一个类com.example.A。考虑两个资源,一个位于/ com / example / nested,另一个位于/ path,位于类路径中。以下程序显示了访问这两种资源的九种可能方式:

package com.example;

public class A {

    public static void main(String args[]) {

        // Class.getResourceAsStream
        Object resource = A.class.getResourceAsStream("nested");
        System.out.println("1: A.class nested=" + resource);

        resource = A.class.getResourceAsStream("/com/example/nested");
        System.out.println("2: A.class /com/example/nested=" + resource);

        resource = A.class.getResourceAsStream("top");
        System.out.println("3: A.class top=" + resource);

        resource = A.class.getResourceAsStream("/top");
        System.out.println("4: A.class /top=" + resource);

        // ClassLoader.getResourceAsStream
        ClassLoader cl = A.class.getClassLoader();
        resource = cl.getResourceAsStream("nested");        
        System.out.println("5: cl nested=" + resource);

        resource = cl.getResourceAsStream("/com/example/nested");
        System.out.println("6: cl /com/example/nested=" + resource);
        resource = cl.getResourceAsStream("com/example/nested");
        System.out.println("7: cl com/example/nested=" + resource);

        resource = cl.getResourceAsStream("top");
        System.out.println("8: cl top=" + resource);

        resource = cl.getResourceAsStream("/top");
        System.out.println("9: cl /top=" + resource);
    }

}

该计划的输出是:

1: A.class nested=java.io.BufferedInputStream@19821f
2: A.class /com/example/nested=java.io.BufferedInputStream@addbf1
3: A.class top=null
4: A.class /top=java.io.BufferedInputStream@42e816
5: cl nested=null
6: cl /com/example/nested=null
7: cl com/example/nested=java.io.BufferedInputStream@9304b1
8: cl top=java.io.BufferedInputStream@190d11
9: cl /top=null

大多数情况下,你会做出你期望的事情。 Case-3失败,因为类相对解析是关于Class的,所以“top”表示“/ com / example / top”,但“/ top”表示它所说的内容。

案例5失败,因为类加载器相对解析是关于类加载器的。但是,出乎意料的是Case-6也失败了:有人可能会期望“/ com / example / nested”正确解析。要通过类加载器访问嵌套资源,您需要使用Case-7,即嵌套路径相对于类加载器的根。同样,Case-9失败了,但Case-8失败了。

记住:对于java.lang.Class,getResourceAsStream()会委托给类加载器:

     public InputStream getResourceAsStream(String name) {
        name = resolveName(name);
        ClassLoader cl = getClassLoader0();
        if (cl==null) {
            // A system class.
            return ClassLoader.getSystemResourceAsStream(name);
        }
        return cl.getResourceAsStream(name);
    }

所以resolveName()的行为很重要。

最后,由于类加载器的行为加载了本质上控制getResourceAsStream()的类,并且类加载器通常是自定义加载器,因此资源加载规则可能更复杂。例如对于Web应用程序,在Web应用程序的上下文中从WEB-INF / classes或WEB-INF / lib加载,但不从其他隔离的Web应用程序加载。此外,行为良好的类加载器委托给父类,因此使用此机制可能无法访问类路径中的重复资源。

答案 2 :(得分:8)

首先检查你的班级装载机。

ClassLoader classLoader = Thread.currentThread().getContextClassLoader();

if (classLoader == null) {
    classLoader = Class.class.getClassLoader();
}

classLoader.getResourceAsStream("xmlFileNameInJarFile.xml");

// xml file location at xxx.jar
// + folder
// + folder
// xmlFileNameInJarFile.xml

答案 3 :(得分:2)

JAR基本上是一个ZIP文件,所以请对其进行处理。下面包含一个如何从WAR文件中提取一个文件(也将其视为ZIP文件)并输出字符串内容的示例。对于二进制文件,您需要修改提取过程,但有很多示例可供使用。

public static void main(String args[]) {
    String relativeFilePath = "style/someCSSFile.css";
    String zipFilePath = "/someDirectory/someWarFile.war";
    String contents = readZipFile(zipFilePath,relativeFilePath);
    System.out.println(contents);
}

public static String readZipFile(String zipFilePath, String relativeFilePath) {
    try {
        ZipFile zipFile = new ZipFile(zipFilePath);
        Enumeration<? extends ZipEntry> e = zipFile.entries();

        while (e.hasMoreElements()) {
            ZipEntry entry = (ZipEntry) e.nextElement();
            // if the entry is not directory and matches relative file then extract it
            if (!entry.isDirectory() && entry.getName().equals(relativeFilePath)) {
                BufferedInputStream bis = new BufferedInputStream(
                        zipFile.getInputStream(entry));
                // Read the file
                    // With Apache Commons I/O
                 String fileContentsStr = IOUtils.toString(bis, "UTF-8");

                    // With Guava
                //String fileContentsStr = new String(ByteStreams.toByteArray(bis),Charsets.UTF_8);
                // close the input stream.
                bis.close();
                return fileContentsStr;
            } else {
                continue;
            }
        }
    } catch (IOException e) {
        logger.error("IOError :" + e);
        e.printStackTrace();
    }
    return null;
}

在这个例子中我使用的是Apache Commons I / O,如果你在使用Maven,那么依赖:

<dependency>
    <groupId>commons-io</groupId>
    <artifactId>commons-io</artifactId>
    <version>2.4</version>
</dependency>

答案 4 :(得分:0)

为了完整起见,最近在Jython邮件列表上有一个question,其中一个答案引用了这个帖子。

问题是如何从Jython中调用包含在.jar文件中的Python脚本,建议的答案如下(使用“InputStream”,如上面的一个答案所述:

PythonInterpreter.execfile(InputStream)