Java Language
Ressourcen (auf Klassenpfad)

Einführung

Bemerkungen

package com.example;

public class ExampleApplication {
    public void readImage()
    throws IOException {

        URL imageURL = ExampleApplication.class.getResource("icon.png");

        // The above statement is identical to:
        // ClassLoader loader = ExampleApplication.class.getClassLoader();
        // URL imageURL = loader.getResource("com/example/icon.png");

        Image image = ImageIO.read(imageURL);
    }
}

Laden eines Bildes von einer Ressource

So laden Sie ein gebündeltes Bild:

package com.example;

public class ExampleApplication {
    private Image getIcon() throws IOException {
        URL imageURL = ExampleApplication.class.getResource("icon.png");
        return ImageIO.read(imageURL);
    }
}

Standardkonfiguration wird geladen

So lesen Sie die Standardkonfigurationseigenschaften:

package com.example;

public class ExampleApplication {
    private Properties getDefaults() throws IOException {
        Properties defaults = new Properties();

        try (InputStream defaultsStream =
            ExampleApplication.class.getResourceAsStream("config.properties")) {

            defaults.load(defaultsStream);
        }

        return defaults;
    }
}

Laden der gleichnamigen Ressource aus mehreren JARs

Eine Ressource mit demselben Pfad und Namen kann in mehr als einer JAR-Datei im Klassenpfad vorhanden sein. Häufige Fälle sind Ressourcen, die einer Konvention folgen oder Teil einer Verpackungsspezifikation sind. Beispiele für solche Ressourcen sind

• META-INF / MANIFEST.MF
• META-INF / beans.xml (CDI-Spezifikation)
• ServiceLoader-Eigenschaften, die Implementierungsanbieter enthalten

Um auf alle diese Ressourcen in verschiedenen Gläsern zugreifen zu können , muss ein ClassLoader verwendet werden, der über eine Methode dafür verfügt. Die zurückgegebene Enumeration kann bequem mit einer Collections-Funktion in eine List konvertiert werden.

Enumeration<URL> resEnum = MyClass.class.getClassLoader().getResources("META-INF/MANIFEST.MF");
ArrayList<URL> resources = Collections.list(resEnum);

Ressourcen mit einem Classloader finden und lesen

Das Laden von Ressourcen in Java umfasst die folgenden Schritte:

1. Die Class oder den ClassLoader finden, die die Ressource finden.
2. Die Ressource finden
3. Abrufen des Byte-Streams für die Ressource.
4. Lesen und Verarbeiten des Byte-Streams.
5. Den Bytestrom schließen.

Die letzten drei Schritte werden normalerweise ausgeführt, indem die URL an eine Bibliotheksmethode oder einen Konstruktor übergeben wird, um die Ressource zu laden. In diesem Fall verwenden Sie normalerweise eine getResource Methode. Es ist auch möglich, die Ressourcendaten im Anwendungscode zu lesen. In diesem Fall verwenden Sie normalerweise getResourceAsStream .

Absolute und relative Ressourcenpfade

Ressourcen, die aus dem Klassenpfad geladen werden können, werden durch einen Pfad angegeben . Die Syntax des Pfads ähnelt einem UNIX / Linux-Dateipfad. Es besteht aus einfachen Namen, die durch Schrägstrich ( / ) getrennt sind. Ein relativer Pfad beginnt mit einem Namen und ein absoluter Pfad beginnt mit einem Trennzeichen.

Wie in den Classpath-Beispielen beschrieben, definiert der Classpath einer JVM einen Namespace, indem die Namespaces der Verzeichnisse und JAR- oder ZIP-Dateien im Classpath eingeblendet werden. Wenn ein absoluter Pfad aufgelöst wird, interpretieren die Klassenladeprogramme den Anfang / als die Wurzel des Namespaces. Im Gegensatz dazu kann ein relativer Pfad im Namensraum relativ zu einem beliebigen „Ordner“ gelöst werden. Der verwendete Ordner hängt von dem Objekt ab, mit dem Sie den Pfad auflösen.

Eine Klasse oder einen Klassenlader erhalten

Eine Ressource kann entweder über ein Class Objekt oder ein ClassLoader Objekt ClassLoader werden. Ein Class Objekt kann relative Pfade auflösen, sodass Sie normalerweise einen dieser Pfade verwenden, wenn Sie über eine (Klassen-) relative Ressource verfügen. Es gibt verschiedene Möglichkeiten, ein Class Objekt zu erhalten. Zum Beispiel:

• Eine Klasse wörtliche wird Ihnen das Class - Objekt für jede Klasse , die Sie in Java - Quellcode nennen kann; zB String.class gibt Ihnen das Class Objekt für den String Typ.

• Das Object.getClass() gibt Ihnen das Class Objekt für den Typ eines beliebigen Objekts. "hello".getClass() Beispiel "hello".getClass() ist eine andere Möglichkeit, Class vom String Typ zu erhalten.

• Die Class.forName(String) -Methode Class.forName(String) falls erforderlich) eine Klasse dynamisch und gibt ihr Class Objekt zurück. zB Class.forName("java.lang.String") .

Ein ClassLoader Objekt wird normalerweise durch Aufrufen von getClassLoader() für ein Class Objekt abgerufen. Es ist auch möglich, den Standard-Classloader der JVM mithilfe der statischen ClassLoader.getSystemClassLoader() -Methode zu erhalten.

Die get Methoden

Sobald Sie eine haben Class oder ClassLoader - Instanz können Sie eine Ressource finden, eine der folgenden Methoden verwenden:

Anmerkungen:

• Der Hauptunterschied zwischen den ClassLoader und Class Versionen der Methoden besteht in der Art und Weise, wie relative Pfade interpretiert werden.

  • Die Class lösen einen relativen Pfad im "Ordner" auf, der dem Klassenpaket entspricht.
  • Die ClassLoader Methoden behandeln relative Pfade so, als wären sie absolut. dh sie lösen sie im "Root-Ordner" des Classpath-Namespaces auf.

• Wenn die angeforderte Ressource (oder Ressourcen) nicht gefunden werden können, geben die methods return getResource und getResourceAsStream null zurück , and the methods return an empty getResources methods return an empty Enumeration` zurück.

• Die zurückgegebenen URLs können mit URL.toStream() . Sie können file: URLs oder andere herkömmliche URLs sein. Wenn sich die Ressource jedoch in einer JAR-Datei befindet, handelt es sich um jar: URLs, die die JAR-Datei und eine bestimmte Ressource darin angeben.

• Wenn Ihr Code eine getResourceAsStream Methode (oder URL.toStream() ) verwendet, um einen InputStream zu erhalten, ist er für das Schließen des Stream-Objekts verantwortlich. Wenn der Stream nicht geschlossen wird, kann dies zu einem Ressourcenleck führen.