Как читать файл из jar в Java?

Я хочу прочитать XML файл, который находится внутри одного из jar, включенных в мой путь к классу. Как я могу прочитать любой файл, который включен в jar?

Ответ 1

Если вы хотите прочитать этот файл из вашего приложения, используйте:

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

Путь начинается с "/", но это не путь в вашей файловой системе, а в вашем пути к классам. Поэтому, если ваш файл находится в пути к классам "org.xml" и называется myxml.xml, ваш путь выглядит как "/org/xml/myxml.xml".

InputStream считывает содержимое вашего файла. Вы можете поместить его в Reader, если хотите.

Я надеюсь, что это поможет.

Ответ 2

А, это один из моих любимых предметов. Существует два способа загрузки ресурса через путь к классам:

Class.getResourceAsStream(resource)

и

ClassLoader.getResourceAsStream(resource)

(есть другие способы, которые включают получение URL-адреса ресурса аналогичным образом, а затем открытие связи с ним, но это два прямых способа).

Первый метод на самом деле делегирует второй, после изменения имени ресурса. Существует, по существу, два типа имен ресурсов: абсолютный (например, "/path/to/resource/resource" ) и относительный (например, "ресурс" ). Абсолютные пути начинаются с "/".

Вот пример, который должен проиллюстрировать. Рассмотрим класс com.example.A. Рассмотрим два ресурса, один из которых находится в /com/example/nested, другой в /top, в пути к классам. Следующая программа показывает девять возможных способов доступа к двум ресурсам:

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 [email protected]
2: A.class /com/example/[email protected]
3: A.class top=null
4: A.class /[email protected]
5: cl nested=null
6: cl /com/example/nested=null
7: cl com/example/[email protected]
8: cl [email protected]
9: cl /top=null

В основном все делает то, что вы ожидаете. Случай-3 терпит неудачу, поскольку относительное разрешение класса относится к классу, поэтому "top" означает "/com/example/top", но "/top" означает, что он говорит.

Случай-5 выходит из строя, потому что относительное разрешение класса loader относится к загрузчику классов. Но неожиданно Case-6 также терпит неудачу: можно было бы ожидать, что "/com/example/nested" будет корректно разрешаться. Чтобы получить доступ к вложенному ресурсу через загрузчик классов, вам необходимо использовать Case-7, то есть вложенный путь относится к корню загрузчика классов. Аналогично, случай-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-INF/classes или WEB-INF/lib в контексте веб-приложения, но не из других изолированных веб-приложений. Кроме того, корректные классные загрузчики делегируют родителям, так что дублированные ресурсы в пути к классам могут быть недоступны с помощью этого механизма.

Ответ 3

Сначала проверьте загрузчик вашего класса.

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

Ответ 4

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>

Ответ 5

Просто для полноты, недавно был вопрос в списке рассылки Jython, где один из ответов относится к этому потоку.

Вопрос заключался в том, как вызвать Python script, который содержится в файле .jar из Jython, предлагаемый ответ следующий (с "InputStream", как описано в одном из ответов выше:

PythonInterpreter.execfile(InputStream)