Java Language
Zasoby (na ścieżce klasy)

Wprowadzenie

Uwagi

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

Ładowanie obrazu z zasobu

Aby załadować dołączony obraz:

package com.example;

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

Ładowanie domyślnej konfiguracji

Aby odczytać domyślne właściwości konfiguracji:

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

Ładowanie zasobu o tej samej nazwie z wielu plików JAR

Zasób o tej samej ścieżce i nazwie może znajdować się w więcej niż jednym pliku JAR w ścieżce klasy. Typowe przypadki to zasoby zgodne z konwencją lub będące częścią specyfikacji opakowania. Przykładami takich zasobów są

• META-INF / MANIFEST.MF
• META-INF / beans.xml (specyfikacja CDI)
• Właściwości ServiceLoader zawierające dostawców implementacji

Aby uzyskać dostęp do wszystkich tych zasobów w różnych słoikach, należy użyć ClassLoadera, który ma do tego odpowiednią metodę. Zwrócone Enumeration można wygodnie przekonwertować na List za pomocą funkcji Kolekcje.

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

Znajdowanie i czytanie zasobów za pomocą modułu ładującego klasy

Ładowanie zasobów w Javie obejmuje następujące kroki:

1. Znalezienie Class lub ClassLoader , który znajdzie zasób.
2. Znalezienie zasobu.
3. Uzyskiwanie strumienia bajtów dla zasobu.
4. Odczytywanie i przetwarzanie strumienia bajtów.
5. Zamykanie strumienia bajtów.

Ostatnie trzy kroki zwykle wykonuje się przez przekazanie adresu URL do metody bibliotecznej lub konstruktora w celu załadowania zasobu. W takim przypadku zazwyczaj używasz metody getResource . Możliwe jest również odczytanie danych zasobów w kodzie aplikacji. W takim przypadku zwykle używasz getResourceAsStream .

Bezwzględne i względne ścieżki zasobów

Zasoby, które można załadować ze ścieżki klas, są oznaczone ścieżką . Składnia ścieżki jest podobna do ścieżki pliku UNIX / Linux. Składa się z prostych nazw oddzielonych ukośnikiem ( / ). Ścieżka względna zaczyna się od nazwy, a ścieżka bezwzględna zaczyna się od separatora.

Jak opisano w przykładach Classpath, ścieżka klasy JVM definiuje przestrzeń nazw poprzez nałożenie przestrzeni nazw katalogów i plików JAR lub ZIP w ścieżce klasy. Po rozstrzygnięciu ścieżki bezwzględnej moduły ładujące klasy interpretują wartość początkową / jako oznaczającą katalog główny przestrzeni nazw. Natomiast ścieżka względna może zostać rozstrzygnięta względem dowolnego „folderu” w przestrzeni nazw. Używany folder będzie zależał od obiektu użytego do rozwiązania ścieżki.

Uzyskiwanie klasy lub modułu ładującego klasy

Zasób można zlokalizować przy użyciu obiektu Class lub obiektu ClassLoader . Obiekt Class może rozpoznawać ścieżki względne, dlatego zazwyczaj używasz jednej z nich, jeśli masz zasób względny (klasy). Istnieje wiele sposobów uzyskania obiektu Class . Na przykład:

• Literał klasy da ci obiekt Class dla dowolnej klasy, którą możesz nazwać w kodzie źródłowym Java; np. String.class daje ci obiekt Class dla typu String .

• Object.getClass() da ci obiekt Class dla typu dowolnego obiektu; np. "hello".getClass() to inny sposób na uzyskanie Class typu String .

• Metoda Class.forName(String) razie potrzeby dynamicznie załaduje klasę i zwróci jej obiekt Class ; np. Class.forName("java.lang.String") .

Obiekt ClassLoader jest zwykle uzyskiwany przez wywołanie getClassLoader() na obiekcie Class . Możliwe jest również przejęcie domyślnego modułu ClassLoader.getSystemClassLoader() JVM za pomocą statycznej metody ClassLoader.getSystemClassLoader() .

get metody

Po utworzeniu instancji Class lub ClassLoader możesz znaleźć zasób, korzystając z jednej z następujących metod:

Uwagi:

• Główna różnica między wersjami metod ClassLoader i Class polega na sposobie interpretacji ścieżek względnych.

  • Metody Class rozwiązują ścieżkę względną w „folderze”, która odpowiada pakietowi klas.
  • Metody ClassLoader traktują ścieżki względne tak, jakby były absolutne; tzn. rozwiąż je w „folderze głównym” przestrzeni nazw ścieżki klasy.

• Jeśli nie można znaleźć żądanego zasobu (lub zasobów), metody getResource i getResourceAsStream methods return wartość null , and the methods return an empty getResources methods return an empty Wyliczenie`.

• Zwrócone adresy URL można rozwiązać za pomocą URL.toStream() . Mogą to być file: adresy URL lub inne konwencjonalne adresy URL, ale jeśli zasób znajduje się w pliku JAR, będą to jar: adresy URL identyfikujące plik JAR i określony zasób w jego obrębie.

• Jeśli kod używa metody getResourceAsStream (lub URL.toStream() ) do uzyskania InputStream , odpowiada za zamknięcie obiektu strumienia. Brak zamknięcia strumienia może doprowadzić do wycieku zasobów.