Як перелічити файли всередині файлу JAR?

У мене є цей код, який читає всі файли з каталогу.

    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 змінної довжини.)

EDIT

Тож я здогадуюсь, що моєю основною проблемою буде: Як дізнатися ім'я файлу 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 для пошуку по ньому. Це полегшило б написання коду, який обробляє JAR та "вибухали" каталоги.

Код, який працює як для файлів 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). Можливо, є вагома причина, щоб він був таким; Я не знаю, я не досліджував реалізації.

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

Якщо припустити, що ваш проект упакований в Jar (не обов'язково правда!), Ви можете використовувати ClassLoader.getResource () або findResource () з назвою класу (далі - .class), щоб отримати банку, що містить заданий клас. Вам доведеться розібрати назву банку з поверненої URL-адреси (не така вже й жорстка), яку я залишу читачеві як вправу :-)

Обов’язково перевіряйте на випадок, коли клас не є частиною банку.

Я переніс відповідь acheron55 на Java 7 і закрив FileSystemоб'єкт. Цей код працює в IDE, в файлах jar і в банці всередині війни на Tomcat 7; але зауважте, що він не працює в банці всередині війни на 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;
                }
            });
        }
    }
}

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

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);
    }
}

Ось приклад використання бібліотеки Reflections для рекурсивного сканування classpath за допомогою шаблону імен regex, доповненого парою Guava perks для отримання вмісту ресурсів:

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);
}

Це працює як з банками, так і з вибухаючими класами.

Файл jar - це лише поштовий файл зі структурованим маніфестом. Ви можете відкрити jar-файл за допомогою звичайних інструментів java zip та сканувати вміст файлу таким чином, надути потоки тощо. Потім використовуйте це у виклику getResourceAsStream, і він повинен бути всім фактом.

EDIT / після уточнення

Знадобилося мені хвилину, щоб запам'ятати всі шматочки та шматки, і я впевнений, що є більш чисті способи зробити це, але я хотів побачити, що я не божевільний. У моєму проекті image.jpg - це файл у деякій частині основного файлу jar. Я отримую завантажувач класу основного класу (SomeClass - точка входу) і використовую його для виявлення ресурсу image.jpg. Потім якась магія потоку, щоб увійти в цю Image Image InputStream і все в порядку.

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"), але це може бути крихітно ненависне.

Деякий час тому я зробив функцію, яка отримує класифікацію зсередини 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;
}

public static ArrayList<String> listItems(String path) throws Exception{
    InputStream in = ClassLoader.getSystemClassLoader().getResourceAsStream(path);
    byte[] b = new byte[in.available()];
    in.read(b);
    String data = new String(b);
    String[] s = data.split("\n");
    List<String> a = Arrays.asList(s);
    ArrayList<String> m = new ArrayList<>(a);
    return m;
}

Є дві дуже корисні утиліти, які називаються JarScan:

1. www.inetfeedback.com/jarscan

2. jarscan.dev.java.net

Дивіться також це питання: JarScan, скануйте всі файли JAR у всіх папках для конкретного класу

Найбільш надійний механізм для перерахування всіх ресурсів на classpath - це використання даного шаблону з ClassGraph , оскільки він обробляє максимально широкий масив механізмів специфікації classpath , включаючи нову модульну систему JPMS. (Я автор ClassGraph.)

Як дізнатися ім'я файлу JAR, де живе мій основний клас?

URI mainClasspathElementURI;
try (ScanResult scanResult = new ClassGraph().whitelistPackages("x.y.z")
        .enableClassInfo().scan()) {
    mainClasspathElementURI =
            scanResult.getClassInfo("x.y.z.MainClass").getClasspathElementURI();
}

Як я можу аналогічно читати вміст каталогу у файлі JAR?

List<String> classpathElementResourcePaths;
try (ScanResult scanResult = new ClassGraph().overrideClasspath(mainClasspathElementURI)
        .scan()) {
    classpathElementResourcePaths = scanResult.getAllResources().getPaths();
}

Існує маса інших способів поводження з ресурсами .

Просто інший спосіб лістингу / читання файлів з URL-адреси 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 
    }
});

Ще один на дорогу:

import java.io.IOException;
import java.net.URISyntaxException;
import java.nio.file.*;
import java.util.ArrayList;
import java.util.List;

import static java.nio.file.FileSystems.newFileSystem;
import static java.util.Collections.emptyMap;

public class ResourceWalker {
  private static final PathMatcher FILE_MATCHER =
      FileSystems.getDefault().getPathMatcher( "glob:**.ttf" );

  public static List<Path> walk( final String directory )
      throws URISyntaxException, IOException {
    final List<Path> filenames = new ArrayList<>();
    final var resource = ResourceWalker.class.getResource( directory );

    if( resource != null ) {
      final var uri = resource.toURI();
      final var path = uri.getScheme().equals( "jar" )
          ? newFileSystem( uri, emptyMap() ).getPath( directory )
          : Paths.get( uri );
      final var walk = Files.walk( path, 10 );

      for( final var it = walk.iterator(); it.hasNext(); ) {
        final Path p = it.next();
        if( FILE_MATCHER.matches( p ) ) {
          filenames.add( p );
        }
      }
    }

    return filenames;
  }
}

Це трохи гнучкіше для підбору конкретних імен файлів, оскільки він використовує шаблони підстановки.

Більш функціональний стиль:

import java.io.IOException;
import java.net.URISyntaxException;
import java.nio.file.*;
import java.util.function.Consumer;

import static java.nio.file.FileSystems.newFileSystem;
import static java.util.Collections.emptyMap;

/**
 * Responsible for finding file resources.
 */
public class ResourceWalker {
  private static final PathMatcher FILE_MATCHER =
      FileSystems.getDefault().getPathMatcher( "glob:**.ttf" );

  public static void walk( final String dirName, final Consumer<Path> f )
      throws URISyntaxException, IOException {
    final var resource = ResourceWalker.class.getResource( dirName );

    if( resource != null ) {
      final var uri = resource.toURI();
      final var path = uri.getScheme().equals( "jar" )
          ? newFileSystem( uri, emptyMap() ).getPath( dirName )
          : Paths.get( uri );
      final var walk = Files.walk( path, 10 );

      for( final var it = walk.iterator(); it.hasNext(); ) {
        final Path p = it.next();
        if( FILE_MATCHER.matches( p ) ) {
          f.accept( p );
        }
      }
    }
  }
}