Java Language
Risorse (sul classpath)

introduzione

Osservazioni

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

Caricamento di un'immagine da una risorsa

Per caricare un'immagine in bundle:

package com.example;

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

Caricamento della configurazione predefinita

Per leggere le proprietà di configurazione predefinite:

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

Caricamento della risorsa con lo stesso nome da più JAR

Risorsa con lo stesso percorso e nome possono esistere in più di un file JAR sul classpath. I casi comuni sono risorse che seguono una convenzione o che fanno parte di una specifica di imballaggio. Esempi per tali risorse sono

• META-INF / MANIFEST.MF
• META-INF / beans.xml (Specifiche CDI)
• Proprietà ServiceLoader contenenti provider di implementazione

Per accedere a tutte queste risorse in diversi jar, è necessario utilizzare ClassLoader, che ha un metodo per questo. L' Enumeration restituita può essere convenientemente convertita in una List utilizzando una funzione Collections.

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

Trovare e leggere le risorse usando un classloader

Il caricamento delle risorse in Java comprende i seguenti passaggi:

1. Trovare la Class o ClassLoader che troverà la risorsa.
2. Trovare la risorsa
3. Ottenere il flusso di byte per la risorsa.
4. Lettura ed elaborazione del flusso di byte.
5. Chiusura del flusso di byte.

Gli ultimi tre passaggi vengono in genere eseguiti passando l'URL a un metodo o costruttore di libreria per caricare la risorsa. In questo caso, in genere utilizzi un metodo getResource . È anche possibile leggere i dati della risorsa nel codice dell'applicazione. In questo caso, in genere si utilizza getResourceAsStream .

Percorsi di risorse assoluti e relativi

Le risorse che possono essere caricate dal classpath sono contraddistinte da un percorso . La sintassi del percorso è simile a un percorso file UNIX / Linux. Consiste di nomi semplici separati da caratteri di barra ( / ). Un percorso relativo inizia con un nome e un percorso assoluto inizia con un separatore.

Come descrivono gli esempi di Classpath, il classpath di una JVM definisce uno spazio dei nomi sovrapponendo gli spazi dei nomi delle directory e dei file JAR o ZIP nel classpath. Quando viene risolto un percorso assoluto, i classloader interpretano l'iniziale / come significato della radice dello spazio dei nomi. Al contrario, un percorso relativo può essere risolto rispetto a qualsiasi "cartella" nello spazio dei nomi. La cartella utilizzata dipenderà dall'oggetto che si utilizza per risolvere il percorso.

Ottenere una classe o un classloader

Una risorsa può essere localizzata usando un oggetto Class o un oggetto ClassLoader . Un oggetto di Class può risolvere percorsi relativi, quindi in genere si utilizzerà uno di questi se si dispone di una risorsa relativa (di classe). Esistono diversi modi per ottenere un oggetto Class . Per esempio:

• Un letterale di classe ti darà l'oggetto Class per qualsiasi classe che puoi nominare nel codice sorgente Java; ad es. String.class fornisce l'oggetto Class per il tipo String .

• Object.getClass() ti darà l'oggetto Class per il tipo od qualsiasi oggetto; ad esempio "hello".getClass() è un altro modo per ottenere la Class del tipo String .

• Il Class.forName(String) (se necessario) carica dinamicamente una classe e restituisce il suo oggetto Class ; ad esempio Class.forName("java.lang.String") .

Un oggetto ClassLoader viene in genere ottenuto chiamando getClassLoader() su un oggetto Class . È anche possibile ottenere il classloader predefinito della JVM utilizzando il metodo ClassLoader.getSystemClassLoader() statico.

I metodi get

Una volta che hai un'istanza Class o ClassLoader , puoi trovare una risorsa, usando uno dei seguenti metodi:

Gli appunti:

• La differenza principale tra le versioni ClassLoader e Class dei metodi è nel modo in cui i percorsi relativi vengono interpretati.

  • I metodi Class risolvono un percorso relativo nella "cartella" che corrisponde al pacchetto classes.
  • I metodi ClassLoader trattano i percorsi relativi come se fossero assoluti; cioè risolvili nella "cartella radice" dello spazio dei nomi del classpath.

• Se non è possibile trovare la risorsa richiesta (o le risorse), i methods return getResource e getResourceAsStream methods return null , and the methods return an empty getResources methods return an empty un'enumerazione vuota`.

• Gli URL restituiti saranno risolvibili utilizzando URL.toStream() . Potrebbero essere file: URL o altri URL convenzionali, ma se la risorsa risiede in un file JAR, saranno jar: URL che identificano il file JAR e una risorsa specifica al suo interno.

• Se il codice utilizza un metodo getResourceAsStream (o URL.toStream() ) per ottenere un InputStream , è responsabile della chiusura dell'oggetto flusso. La mancata chiusura del flusso potrebbe causare una perdita di risorse.