Загрузчики классов в Java

1. Введение в загрузчики классов

Загрузчики классов отвечают за динамическую загрузку классов Java во время выполнения в JVM (виртуальную машину Java). Кроме того, они являются частью JRE (Java Runtime Environment). Следовательно, JVM не нужно знать о лежащих в основе файлах или файловых системах, чтобы запускать программы Java благодаря загрузчикам классов.

Кроме того, эти классы Java загружаются в память не сразу, а по требованию приложения. Здесь на сцену выходят загрузчики классов. Они отвечают за загрузку классов в память.

В этом руководстве мы поговорим о различных типах встроенных загрузчиков классов, о том, как они работают, и познакомимся с нашей собственной реализацией.

2. Типы встроенных загрузчиков классов

Начнем с изучения того, как загружаются разные классы с помощью различных загрузчиков классов, на простом примере:

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

При выполнении вышеуказанного метода выводится:

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

Как мы видим, здесь есть три разных загрузчика классов; приложение, расширение и начальная загрузка (отображается как null ).

Загрузчик классов приложения загружает класс, в котором содержится пример метода. Загрузчик классов приложения или системы загружает наши собственные файлы в путь к классам.

Затем расширение загружает класс Logging . Загрузчики классов расширения загружают классы, которые являются расширением стандартных базовых классов Java.

Наконец, начальная загрузка загружает класс ArrayList . Первоначальный загрузчик классов является родительским для всех остальных.

Тем не менее, мы видим, что последний вывод для ArrayList отображает ноль на выходе. Это связано с тем, что загрузчик классов начальной загрузки написан в машинном коде, а не на Java, поэтому он не отображается как класс Java. По этой причине поведение загрузчика классов начальной загрузки будет отличаться в зависимости от JVM.

Давайте теперь более подробно обсудим каждый из этих загрузчиков классов.

2.1. Загрузчик классов начальной загрузки

Классы Java загружаются экземпляром java.lang.ClassLoader . Однако загрузчики классов сами являются классами. Следовательно, вопрос в том, кто загружает java.lang.Classloader сам ?

Здесь на сцену выходит начальный загрузчик классов.

Он в основном отвечает за загрузку внутренних классов JDK, обычно rt.jar и других основных библиотек, расположенных в каталоге $ JAVA_HOME / jre / lib . Кроме того, загрузчик классов Bootstrap служит родительским элементом для всех других экземпляров ClassLoader .

Этот загрузчик классов начальной загрузки является частью ядра JVM и написан в машинном коде, как указано в приведенном выше примере. На разных платформах могут быть разные реализации этого загрузчика классов.

2.2. Загрузчик классов расширения

Класс расширения погрузчик является потомком класса начальной загрузки загрузчика и заботится о загрузке расширения стандартных базовых классов Java , так что он доступен для всех приложений , работающих на платформе.

Загрузчик классов расширений загружается из каталога расширений JDK, обычно каталога $ JAVA_HOME / lib / ext или любого другого каталога, указанного в системном свойстве java.ext.dirs .

2.3. Загрузчик системного класса

С другой стороны, загрузчик классов системы или приложения заботится о загрузке всех классов уровня приложения в JVM. Он загружает файлы найдены в переменном окружении, классов -classpath или -cp опции командной строки . Кроме того, это дочерний элемент загрузчика классов Extensions.

3. Как работают загрузчики классов?

Загрузчики классов являются частью среды выполнения Java. Когда JVM запрашивает класс, загрузчик классов пытается найти класс и загрузить определение класса в среду выполнения, используя полное имя класса.

Метод java.lang.ClassLoader.loadClass () отвечает за загрузку определения класса в среду выполнения . Он пытается загрузить класс на основе полного имени.

Если класс еще не загружен, он делегирует запрос загрузчику родительского класса. Этот процесс происходит рекурсивно.

В конце концов, если загрузчик родительского класса не найдет класс, тогда дочерний класс вызовет метод java.net.URLClassLoader.findClass () для поиска классов в самой файловой системе.

Если последний загрузчик дочернего класса также не может загрузить класс, он выдает исключение java.lang.NoClassDefFoundError или java.lang.ClassNotFoundException.

Давайте посмотрим на пример вывода, когда выбрасывается 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)

Если мы пройдемся по последовательности событий прямо от вызова java.lang.Class.forName () , мы сможем понять, что сначала он пытается загрузить класс через загрузчик родительского класса, а затем java.net.URLClassLoader.findClass () для поиска сам класс.

Когда он все еще не находит класс, он выдает исключение ClassNotFoundException.

Загрузчики классов обладают тремя важными особенностями.

3.1. Модель делегирования

Загрузчики классов следуют модели делегирования, при которой по запросу на поиск класса или ресурса экземпляр ClassLoader делегирует поиск класса или ресурса загрузчику родительского класса .

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.

Мы говорили о различных типах загрузчиков классов, а именно - Bootstrap, Extensions и System class loaders. Bootstrap служит родительским для всех из них и отвечает за загрузку внутренних классов JDK. Расширения и система, с другой стороны, загружают классы из каталога расширений Java и пути к классам соответственно.

Затем мы поговорили о том, как работают загрузчики классов, и обсудили некоторые функции, такие как делегирование, видимость и уникальность, а затем краткое объяснение того, как создать собственный. Наконец, мы представили загрузчики классов контекста.

Примеры кода, как всегда, можно найти на GitHub.