Caricatori di classi in Java

1. Introduzione a Class Loaders

I programmi di caricamento classi sono responsabili del caricamento dinamico delle classi Java durante il runtime sulla JVM (Java Virtual Machine). Inoltre, fanno parte di JRE (Java Runtime Environment). Quindi, la JVM non ha bisogno di conoscere i file o file system sottostanti per eseguire programmi Java grazie ai caricatori di classi.

Inoltre, queste classi Java non vengono caricate in memoria tutte in una volta, ma quando richiesto da un'applicazione. È qui che entrano in gioco i caricatori di classi. Sono responsabili del caricamento delle classi in memoria.

In questo tutorial parleremo dei diversi tipi di class loader incorporati, di come funzionano e di un'introduzione alla nostra implementazione personalizzata.

2. Tipi di caricatori di classe incorporati

Iniziamo imparando come vengono caricate classi diverse utilizzando vari caricatori di classi utilizzando un semplice esempio:

public void printClassLoaders() throws ClassNotFoundException { System.out.println("Classloader of this class:" + PrintClassLoader.class.getClassLoader()); System.out.println("Classloader of Logging:" + Logging.class.getClassLoader()); System.out.println("Classloader of ArrayList:" + ArrayList.class.getClassLoader()); }

Quando viene eseguito, il metodo precedente stampa:

Class loader of this class:[email protected] Class loader of Logging:[email protected] Class loader of ArrayList:null

Come possiamo vedere, ci sono tre differenti class loader qui; applicazione, estensione e bootstrap (visualizzati come nulli ).

Il programma di caricamento classi dell'applicazione carica la classe in cui è contenuto il metodo di esempio. Un'applicazione o un programma di caricamento classi di sistema carica i nostri file nel classpath.

Successivamente, l'estensione carica la classe Logging . I programmi di caricamento classi di estensione caricano classi che sono un'estensione delle classi Java di base standard.

Infine, il bootstrap carica la classe ArrayList . Un bootstrap o un caricatore di classi primordiale è il genitore di tutti gli altri.

Tuttavia, possiamo vedere che l'ultima uscita, per ArrayList mostra null nell'output. Questo perché il programma di caricamento classi bootstrap è scritto in codice nativo, non Java, quindi non viene visualizzato come classe Java. Per questo motivo, il comportamento del programma di caricamento classi bootstrap sarà diverso tra le JVM.

Discutiamo ora più in dettaglio su ciascuno di questi caricatori di classi.

2.1. Caricatore di classi Bootstrap

Le classi Java vengono caricate da un'istanza di java.lang.ClassLoader . Tuttavia, i caricatori di classi sono classi stesse. Quindi, la domanda è: chi carica il java.lang.ClassLoader stesso ?

È qui che entra in gioco il bootstrap o il caricatore di classi primordiale.

È principalmente responsabile del caricamento delle classi interne JDK, in genere rt.jar e altre librerie principali situate nella directory $ JAVA_HOME / jre / lib . Inoltre, il caricatore di classi Bootstrap funge da padre di tutte le altre istanze di ClassLoader .

Questo programma di caricamento classi bootstrap fa parte della JVM di base ed è scritto in codice nativo come indicato nell'esempio precedente. Diverse piattaforme potrebbero avere diverse implementazioni di questo particolare programma di caricamento classi.

2.2. Programma di caricamento classi di estensione

L' estensione class loader è un figlio del bootstrap class loader e si occupa di caricare le estensioni delle classi Java core standard in modo che sia disponibile per tutte le applicazioni in esecuzione sulla piattaforma.

Il programma di caricamento classi delle estensioni viene caricato dalla directory delle estensioni JDK, in genere $ JAVA_HOME / lib / ext o qualsiasi altra directory menzionata nella proprietà di sistema java.ext.dirs .

2.3. Caricatore di classi di sistema

Il programma di caricamento classi del sistema o dell'applicazione, d'altra parte, si occupa di caricare tutte le classi a livello di applicazione nella JVM. Carica i file trovati nella variabile d'ambiente classpath, -classpath o -cp nella riga di comando . Inoltre, è un figlio di Extensions classloader.

3. Come funzionano i programmi di caricamento classi?

I programmi di caricamento classi fanno parte di Java Runtime Environment. Quando la JVM richiede una classe, il programma di caricamento classi tenta di individuare la classe e caricare la definizione della classe nel runtime utilizzando il nome completo della classe.

Il metodo java.lang.ClassLoader.loadClass () è responsabile del caricamento della definizione della classe in runtime . Prova a caricare la classe in base a un nome completo.

Se la classe non è già caricata, delega la richiesta al programma di caricamento della classe padre. Questo processo avviene in modo ricorsivo.

Alla fine, se il programma di caricamento della classe genitore non trova la classe, la classe figlia chiamerà il metodo java.net.URLClassLoader.findClass () per cercare le classi nel file system stesso.

Se anche l'ultimo programma di caricamento classi figlio non è in grado di caricare la classe, genera java.lang.NoClassDefFoundError o java.lang.ClassNotFoundException.

Diamo un'occhiata a un esempio di output quando viene generata ClassNotFoundException.

java.lang.ClassNotFoundException: com.baeldung.classloader.SampleClassLoader at java.net.URLClassLoader.findClass(URLClassLoader.java:381) at java.lang.ClassLoader.loadClass(ClassLoader.java:424) at java.lang.ClassLoader.loadClass(ClassLoader.java:357) at java.lang.Class.forName0(Native Method) at java.lang.Class.forName(Class.java:348)

Se esaminiamo la sequenza di eventi direttamente dalla chiamata a java.lang.Class.forName () , possiamo capire che prima cerca di caricare la classe tramite il caricatore della classe genitore e quindi java.net.URLClassLoader.findClass () per cercare la classe stessa.

Quando ancora non trova la classe, genera un'eccezione ClassNotFoundException.

Ci sono tre importanti caratteristiche dei programmi di caricamento classi.

3.1. Modello di delega

I programmi di caricamento classi seguono il modello di delega in cui, su richiesta per trovare una classe o una risorsa, un'istanza di ClassLoader delegherà la ricerca della classe o della risorsa al programma di caricamento della classe padre .

Let's say we have a request to load an application class into the JVM. The system class loader first delegates the loading of that class to its parent extension class loader which in turn delegates it to the bootstrap class loader.

Only if the bootstrap and then the extension class loader is unsuccessful in loading the class, the system class loader tries to load the class itself.

3.2. Unique Classes

As a consequence of the delegation model, it's easy to ensure unique classes as we always try to delegate upwards.

If the parent class loader isn't able to find the class, only then the current instance would attempt to do so itself.

3.3. Visibility

In addition, children class loaders are visible to classes loaded by its parent class loaders.

For instance, classes loaded by the system class loader have visibility into classes loaded by the extension and Bootstrap class loaders but not vice-versa.

To illustrate this, if Class A is loaded by an application class loader and class B is loaded by the extensions class loader, then both A and B classes are visible as far as other classes loaded by Application class loader are concerned.

Class B, nonetheless, is the only class visible as far as other classes loaded by the extension class loader are concerned.

4. Custom ClassLoader

The built-in class loader would suffice in most of the cases where the files are already in the file system.

However, in scenarios where we need to load classes out of the local hard drive or a network, we may need to make use of custom class loaders.

In this section, we'll cover some other uses cases for custom class loaders and we'll demonstrate how to create one.

4.1. Custom Class Loaders Use-Cases

Custom class loaders are helpful for more than just loading the class during runtime, a few use cases might include:

  1. Helping in modifying the existing bytecode, e.g. weaving agents
  2. Creating classes dynamically suited to the user's needs. e.g in JDBC, switching between different driver implementations is done through dynamic class loading.
  3. Implementing a class versioning mechanism while loading different bytecodes for classes with same names and packages. This can be done either through URL class loader (load jars via URLs) or custom class loaders.

There are more concrete examples where custom class loaders might come in handy.

Browsers, for instance, use a custom class loader to load executable content from a website. A browser can load applets from different web pages using separate class loaders. The applet viewer which is used to run applets contains a ClassLoader that accesses a website on a remote server instead of looking in the local file system.

And then loads the raw bytecode files via HTTP, and turns them into classes inside the JVM. Even if these applets have the same name, they are considered as different components if loaded by different class loaders.

Now that we understand why custom class loaders are relevant, let's implement a subclass of ClassLoader to extend and summarise the functionality of how the JVM loads classes.

4.2. Creating Our Custom Class Loader

For illustration purposes, let's say we need to load classes from a file using a custom class loader.

We need to extend the ClassLoader class and override the findClass() method:

public class CustomClassLoader extends ClassLoader { @Override public Class findClass(String name) throws ClassNotFoundException { byte[] b = loadClassFromFile(name); return defineClass(name, b, 0, b.length); } private byte[] loadClassFromFile(String fileName) { InputStream inputStream = getClass().getClassLoader().getResourceAsStream( fileName.replace('.', File.separatorChar) + ".class"); byte[] buffer; ByteArrayOutputStream byteStream = new ByteArrayOutputStream(); int nextValue = 0; try { while ( (nextValue = inputStream.read()) != -1 ) { byteStream.write(nextValue); } } catch (IOException e) { e.printStackTrace(); } buffer = byteStream.toByteArray(); return buffer; } }

In the above example, we defined a custom class loader that extends the default class loader and loads a byte array from the specified file.

5. Understanding java.lang.ClassLoader

Let's discuss a few essential methods from the java.lang.ClassLoader class to get a clearer picture of how it works.

5.1. The loadClass() Method

public Class loadClass(String name, boolean resolve) throws ClassNotFoundException {

This method is responsible for loading the class given a name parameter. The name parameter refers to the fully qualified class name.

The Java Virtual Machine invokes loadClass() method to resolve class references setting resolve to true. However, it isn't always necessary to resolve a class. If we only need to determine if the class exists or not, then resolve parameter is set to false.

This method serves as an entry point for the class loader.

We can try to understand the internal working of the loadClass() method from the source code of java.lang.ClassLoader:

protected Class loadClass(String name, boolean resolve) throws ClassNotFoundException { synchronized (getClassLoadingLock(name)) { // First, check if the class has already been loaded Class c = findLoadedClass(name); if (c == null) { long t0 = System.nanoTime(); try { if (parent != null) { c = parent.loadClass(name, false); } else { c = findBootstrapClassOrNull(name); } } catch (ClassNotFoundException e) { // ClassNotFoundException thrown if class not found // from the non-null parent class loader } if (c == null) { // If still not found, then invoke findClass in order // to find the class. c = findClass(name); } } if (resolve) { resolveClass(c); } return c; } }

The default implementation of the method searches for classes in the following order:

  1. Invokes the findLoadedClass(String) method to see if the class is already loaded.
  2. Invokes the loadClass(String) method on the parent class loader.
  3. Invoke the findClass(String) method to find the class.

5.2. The defineClass() Method

protected final Class defineClass( String name, byte[] b, int off, int len) throws ClassFormatError

This method is responsible for the conversion of an array of bytes into an instance of a class. And before we use the class, we need to resolve it.

In case data didn't contain a valid class, it throws a ClassFormatError.

Also, we can't override this method since it's marked as final.

5.3. The findClass() Method

protected Class findClass( String name) throws ClassNotFoundException

This method finds the class with the fully qualified name as a parameter. We need to override this method in custom class loader implementations that follow the delegation model for loading classes.

Also, loadClass() invokes this method if the parent class loader couldn't find the requested class.

The default implementation throws a ClassNotFoundException if no parent of the class loader finds the class.

5.4. The getParent() Method

public final ClassLoader getParent()

This method returns the parent class loader for delegation.

Some implementations like the one seen before in Section 2. use null to represent the bootstrap class loader.

5.5. The getResource() Method

public URL getResource(String name)

This method tries to find a resource with the given name.

It will first delegate to the parent class loader for the resource. If the parent is null, the path of the class loader built into the virtual machine is searched.

If that fails, then the method will invoke findResource(String) to find the resource. The resource name specified as an input can be relative or absolute to the classpath.

It returns an URL object for reading the resource, or null if the resource could not be found or if the invoker doesn't have adequate privileges to return the resource.

It's important to note that Java loads resources from the classpath.

Finally, resource loading in Java is considered location-independent as it doesn't matter where the code is running as long as the environment is set to find the resources.

6. Context Classloaders

In general, context class loaders provide an alternative method to the class-loading delegation scheme introduced in J2SE.

Like we've learned before, classloaders in a JVM follow a hierarchical model such that every class loader has a single parent with the exception of the bootstrap class loader.

However, sometimes when JVM core classes need to dynamically load classes or resources provided by application developers, we might encounter a problem.

For example, in JNDI the core functionality is implemented by bootstrap classes in rt.jar. But these JNDI classes may load JNDI providers implemented by independent vendors (deployed in the application classpath). This scenario calls for the bootstrap class loader (parent class loader) to load a class visible to application loader (child class loader).

J2SE delegation doesn't work here and to get around this problem, we need to find alternative ways of class loading. And it can be achieved using thread context loaders.

The java.lang.Thread class has a method getContextClassLoader() that returns the ContextClassLoader for the particular thread. The ContextClassLoader is provided by the creator of the thread when loading resources and classes.

If the value isn't set, then it defaults to the class loader context of the parent thread.

7. Conclusion

Class loaders are essential to execute a Java program. We've provided a good introduction as part of this article.

Abbiamo parlato di diversi tipi di caricatori di classi, ovvero Bootstrap, estensioni e caricatori di classi di sistema. Bootstrap funge da genitore per tutti ed è responsabile del caricamento delle classi interne JDK. Le estensioni e il sistema, d'altra parte, caricano le classi rispettivamente dalla directory delle estensioni Java e dal classpath.

Quindi abbiamo parlato di come funzionano i caricatori di classi e abbiamo discusso di alcune funzionalità come la delega, visibilità e unicità seguite da una breve spiegazione su come crearne uno personalizzato. Infine, abbiamo fornito un'introduzione ai caricatori di classi Context.

Esempi di codice, come sempre, possono essere trovati su GitHub.