Как составить список файлов внутри JAR-файла?

StackOverflow https://stackoverflow.com/questions/1429172

Вопрос

У меня есть этот код, который считывает все файлы из каталога.

    File textFolder = new File("text_directory");

    File [] texFiles = textFolder.listFiles( new FileFilter() {
           public boolean accept( File file ) {
               return file.getName().endsWith(".txt");
           }
    });

Это отлично работает.Он заполняет массив всеми файлами, которые заканчиваются на ".txt" из каталога "text_directory".

Как я могу аналогичным образом прочитать содержимое каталога внутри файл JAR?

Итак, что я действительно хочу сделать, так это перечислить все изображения внутри моего JAR-файла, чтобы я мог загрузить их с помощью: 

ImageIO.read(this.getClass().getResource("CompanyLogo.png"));

(Это работает, потому что "CompanyLogo" является "жестко запрограммированным", но количество изображений внутри файла JAR может быть от 10 до 200 переменной длины.)

Редактировать

Так что, я думаю, моей главной проблемой было бы:Как узнать, что имя файла JAR где живет мой основной класс?

Конечно, я мог бы прочитать это с помощью java.util.Zip.

Моя структура выглядит следующим образом:

Они похожи:

my.jar!/Main.class
my.jar!/Aux.class
my.jar!/Other.class
my.jar!/images/image01.png
my.jar!/images/image02a.png
my.jar!/images/imwge034.png
my.jar!/images/imagAe01q.png
my.jar!/META-INF/manifest

Прямо сейчас я могу загрузить, например, "images / image01.png", используя: 

    ImageIO.read(this.getClass().getResource("images/image01.png));

Но только потому, что я знаю имя файла, в остальном я должен загружать их динамически.

Это было полезно?

Решение 

CodeSource src = MyClass.class.getProtectionDomain().getCodeSource();
if (src != null) {
  URL jar = src.getLocation();
  ZipInputStream zip = new ZipInputStream(jar.openStream());
  while(true) {
    ZipEntry e = zip.getNextEntry();
    if (e == null)
      break;
    String name = e.getName();
    if (name.startsWith("path/to/your/dir/")) {
      /* Do something with this entry. */
      ...
    }
  }
} 
else {
  /* Fail... */
}

Обратите внимание, что в Java 7 вы можете создать FileSystem из файла JAR (zip), а затем используйте механизмы обхода каталогов и фильтрации NIO для поиска по нему.Это упростило бы написание кода, который обрабатывает банки и "разнесенные" каталоги.

Другие советы

Код, который работает как для IDE, так и для файлов .jar:

import java.io.*;
import java.net.*;
import java.nio.file.*;
import java.util.*;
import java.util.stream.*;

public class ResourceWalker {
    public static void main(String[] args) throws URISyntaxException, IOException {
        URI uri = ResourceWalker.class.getResource("/resources").toURI();
        Path myPath;
        if (uri.getScheme().equals("jar")) {
            FileSystem fileSystem = FileSystems.newFileSystem(uri, Collections.<String, Object>emptyMap());
            myPath = fileSystem.getPath("/resources");
        } else {
            myPath = Paths.get(uri);
        }
        Stream<Path> walk = Files.walk(myPath, 1);
        for (Iterator<Path> it = walk.iterator(); it.hasNext();){
            System.out.println(it.next());
        }
    }
}

болезнь Эриксона ответ сработало отлично:

Вот рабочий код.

CodeSource src = MyClass.class.getProtectionDomain().getCodeSource();
List<String> list = new ArrayList<String>();

if( src != null ) {
    URL jar = src.getLocation();
    ZipInputStream zip = new ZipInputStream( jar.openStream());
    ZipEntry ze = null;

    while( ( ze = zip.getNextEntry() ) != null ) {
        String entryName = ze.getName();
        if( entryName.startsWith("images") &&  entryName.endsWith(".png") ) {
            list.add( entryName  );
        }
    }

 }
 webimages = list.toArray( new String[ list.size() ] );

И я только что изменил свой метод загрузки на основе этого:

File[] webimages = ... 
BufferedImage image = ImageIO.read(this.getClass().getResource(webimages[nextIndex].getName() ));

К этому:

String  [] webimages = ...

BufferedImage image = ImageIO.read(this.getClass().getResource(webimages[nextIndex]));

Я хотел бы подробнее остановиться на acheron55 ответ, поскольку это очень небезопасное решение, по нескольким причинам:

  1. Это не закрывает FileSystem объект.
  2. Это не проверяет, является ли FileSystem объект уже существует.
  3. Это не потокобезопасно.

Это в некоторой степени более безопасное решение:

private static ConcurrentMap<String, Object> locks = new ConcurrentHashMap<>();

public void walk(String path) throws Exception {

    URI uri = getClass().getResource(path).toURI();
    if ("jar".equals(uri.getScheme()) {
        safeWalkJar(path, uri);
    } else {
        Files.walk(Paths.get(path));
    }
}

private void safeWalkJar(String path, URI uri) throws Exception {

    synchronized (getLock(uri)) {    
        // this'll close the FileSystem object at the end
        try (FileSystem fs = getFileSystem(uri)) {
            Files.walk(fs.getPath(path));
        }
    }
}

private Object getLock(URI uri) {

    String fileName = parseFileName(uri);  
    locks.computeIfAbsent(fileName, s -> new Object());
    return locks.get(fileName);
}

private String parseFileName(URI uri) {

    String schemeSpecificPart = uri.getSchemeSpecificPart();
    return schemeSpecificPart.substring(0, schemeSpecificPart.indexOf("!"));
}

private FileSystem getFileSystem(URI uri) throws IOException {

    try {
        return FileSystems.getFileSystem(uri);
    } catch (FileSystemNotFoundException e) {
        return FileSystems.newFileSystem(uri, Collections.<String, String>emptyMap());
    }
}

На самом деле нет необходимости синхронизировать по имени файла;можно было бы просто синхронизировать один и тот же объект каждый раз (или создать метод synchronized), это чисто оптимизация.

Я бы сказал, что это все еще проблематичное решение, поскольку в коде могут быть другие части, которые используют FileSystem взаимодействуйте с одними и теми же файлами, и это может создавать помехи для них (даже в однопоточном приложении).
Кроме того, он не проверяет наличие nulls (например, на getClass().getResource().

Этот конкретный интерфейс Java NIO довольно ужасен, поскольку он вводит глобальный / одноэлементный не потокобезопасный ресурс, а его документация крайне расплывчата (много неизвестных из-за специфичных для поставщика реализаций).Результаты могут отличаться для других FileSystem поставщики (не JAR).Может быть, есть веская причина для того, чтобы все было именно так;Я не знаю, я не изучал реализацию.

Вот метод, который я написал для "запуска всех юнитов в пакете".Вы должны быть в состоянии адаптировать его к своим потребностям.

private static void findClassesInJar(List<String> classFiles, String path) throws IOException {
    final String[] parts = path.split("\\Q.jar\\\\E");
    if (parts.length == 2) {
        String jarFilename = parts[0] + ".jar";
        String relativePath = parts[1].replace(File.separatorChar, '/');
        JarFile jarFile = new JarFile(jarFilename);
        final Enumeration<JarEntry> entries = jarFile.entries();
        while (entries.hasMoreElements()) {
            final JarEntry entry = entries.nextElement();
            final String entryName = entry.getName();
            if (entryName.startsWith(relativePath)) {
                classFiles.add(entryName.replace('/', File.separatorChar));
            }
        }
    }
}

Редактировать:Ах, в таком случае, вам может понадобиться и этот фрагмент (тот же вариант использования :))

private static File findClassesDir(Class<?> clazz) {
    try {
        String path = clazz.getProtectionDomain().getCodeSource().getLocation().getFile();
        final String codeSourcePath = URLDecoder.decode(path, "UTF-8");
        final String thisClassPath = new File(codeSourcePath, clazz.getPackage().getName().repalce('.', File.separatorChar));
    } catch (UnsupportedEncodingException e) {
        throw new AssertionError("impossible", e);
    }
}

Так что я предполагаю, что моя главная проблема будет заключаться в том, как узнать название банки, в которой живет мой основной класс.

Предполагая, что ваш проект упакован в Jar (не обязательно true!), вы можете использовать ClassLoader.getResource() или FindResource() с именем класса (за которым следует .class), чтобы получить jar, содержащий данный класс.Вам нужно будет разобрать имя jar из возвращаемого URL-адреса (не так сложно), который я оставлю в качестве упражнения для читателя :-)

Обязательно протестируйте для случая, когда класс не является частью jar.

Jar-файл - это просто zip-файл со структурированным манифестом.Вы можете открыть файл jar с помощью обычных инструментов Java zip и таким образом сканировать содержимое файла, раздувать потоки и т.д.Затем используйте это в вызове getResourceAsStream, и все должно быть в порядке.

РЕДАКТИРОВАТЬ / после уточнения

Мне потребовалась минута, чтобы вспомнить все по крупицам, и я уверен, что есть более чистые способы сделать это, но я хотел убедиться, что я не сумасшедший.В моем проекте image.jpg это файл в некоторой части основного файла jar.Я получаю загрузчик классов основного класса (SomeClass является точкой входа) и использую его для обнаружения ресурса image.jpg.Затем немного потоковой магии, чтобы поместить ее в эту штуку ImageInputStream, и все в порядке.

InputStream inputStream = SomeClass.class.getClassLoader().getResourceAsStream("image.jpg");
JPEGImageReaderSpi imageReaderSpi = new JPEGImageReaderSpi();
ImageReader ir = imageReaderSpi.createReaderInstance();
ImageInputStream iis = new MemoryCacheImageInputStream(inputStream);
ir.setInput(iis);
....
ir.read(0); //will hand us a buffered image

Учитывая фактический файл JAR, вы можете перечислить содержимое, используя JarFile.entries().Однако вам нужно будет знать расположение файла JAR - вы не можете просто попросить загрузчик классов перечислить все, к чему он может получить доступ.

Вы должны быть в состоянии определить местоположение файла JAR на основе URL, возвращаемого с ThisClassName.class.getResource("ThisClassName.class"), но это может быть немного неудобно.

Некоторое время назад я создал функцию, которая получает classess изнутри JAR:

public static Class[] getClasses(String packageName) 
throws ClassNotFoundException{
    ArrayList<Class> classes = new ArrayList<Class> ();

    packageName = packageName.replaceAll("\\." , "/");
    File f = new File(jarName);
    if(f.exists()){
        try{
            JarInputStream jarFile = new JarInputStream(
                    new FileInputStream (jarName));
            JarEntry jarEntry;

            while(true) {
                jarEntry=jarFile.getNextJarEntry ();
                if(jarEntry == null){
                    break;
                }
                if((jarEntry.getName ().startsWith (packageName)) &&
                        (jarEntry.getName ().endsWith (".class")) ) {
                    classes.add(Class.forName(jarEntry.getName().
                            replaceAll("/", "\\.").
                            substring(0, jarEntry.getName().length() - 6)));
                }
            }
        }
        catch( Exception e){
            e.printStackTrace ();
        }
        Class[] classesA = new Class[classes.size()];
        classes.toArray(classesA);
        return classesA;
    }else
        return null;
}

Вот пример использования Размышления библиотека для рекурсивного сканирования пути к классу по шаблону имени регулярного выражения, дополненная парой Гуава привилегии для извлечения содержимого ресурсов:

Reflections reflections = new Reflections("com.example.package", new ResourcesScanner());
Set<String> paths = reflections.getResources(Pattern.compile(".*\\.template$"));

Map<String, String> templates = new LinkedHashMap<>();
for (String path : paths) {
    log.info("Found " + path);
    String templateName = Files.getNameWithoutExtension(path);
    URL resource = getClass().getClassLoader().getResource(path);
    String text = Resources.toString(resource, StandardCharsets.UTF_8);
    templates.put(templateName, text);
}

Это работает как с банками, так и с разнесенными классами.

Я портировал ответ ашерона55 перешел на Java 7 и закрыл FileSystem объект.Этот код работает в IDE, в файлах jar и в jar внутри war на Tomcat 7;но обратите внимание, что это так не работа в jar внутри war на JBoss 7 (это дает FileSystemNotFoundException: Provider "vfs" not installed, смотрите также этот пост).Кроме того, как и исходный код, он не является потокобезопасным, как это было предложено ошибка.По этим причинам я отказался от этого решения;однако, если вы можете согласиться с этими проблемами, вот мой готовый код:

import java.io.IOException;
import java.net.*;
import java.nio.file.*;
import java.nio.file.attribute.BasicFileAttributes;
import java.util.Collections;

public class ResourceWalker {

    public static void main(String[] args) throws URISyntaxException, IOException {
        URI uri = ResourceWalker.class.getResource("/resources").toURI();
        System.out.println("Starting from: " + uri);
        try (FileSystem fileSystem = (uri.getScheme().equals("jar") ? FileSystems.newFileSystem(uri, Collections.<String, Object>emptyMap()) : null)) {
            Path myPath = Paths.get(uri);
            Files.walkFileTree(myPath, new SimpleFileVisitor<Path>() { 
                @Override
                public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
                    System.out.println(file);
                    return FileVisitResult.CONTINUE;
                }
            });
        }
    }
}

Есть две очень полезные утилиты, обе называются JarScan:

  1. www.inetfeedback.com/jarscan

  2. jarscan.dev.java.net

Смотрите также этот вопрос: JarScan, сканирует все файлы JAR во всех вложенных папках на предмет определенного класса

Просто другой способ перечисления / чтения файлов из URL-адреса jar, и он делает это рекурсивно для вложенных jar

https://gist.github.com/trung/2cd90faab7f75b3bcbaa

URL urlResource = Thead.currentThread().getContextClassLoader().getResource("foo");
JarReader.read(urlResource, new InputStreamCallback() {
    @Override
    public void onFile(String name, InputStream is) throws IOException {
        // got file name and content stream 
    }
});
Лицензировано под: CC-BY-SA с атрибуция
Не связан с StackOverflow
scroll top