Поиск по сайту:

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

Java ClassLoader — один из важнейших, но редко используемых компонентов при разработке проектов. Я никогда не расширял ClassLoader ни в одном из своих проектов. Но идея иметь собственный ClassLoader, который может настраивать загрузку классов Java, захватывающая. В этой статье будет представлен обзор Java ClassLoader, а затем мы перейдем к созданию пользовательского загрузчика классов в Java.

Что такое Java ClassLoader?

Мы знаем, что программа Java работает на виртуальной машине Java (JVM). Когда мы компилируем класс Java, JVM создает байт-код, который не зависит от платформы и машины. Байт-код хранится в файле .class. Когда мы пытаемся использовать класс, ClassLoader загружает его в память.

Встроенные типы ClassLoader

В Java есть три типа встроенного ClassLoader.

  1. Загрузчик классов Bootstrap — загружает внутренние классы JDK. Он загружает rt.jar и другие базовые классы, например классы пакетов java.lang.*.
  2. Загрузчик классов расширений. Он загружает классы из каталога расширений JDK, обычно это каталог $JAVA_HOME/lib/ext.
  3. Системный загрузчик классов. Этот загрузчик классов загружает классы из текущего пути к классам. Мы можем установить путь к классам при вызове программы с помощью параметра командной строки -cp или -classpath.

Иерархия ClassLoader

ClassLoader иерархически загружает класс в память. Всякий раз, когда возникает запрос на загрузку класса, он делегирует его родительскому загрузчику классов. Именно так поддерживается уникальность в среде выполнения. Если загрузчик родительского класса не находит класс, то сам загрузчик класса пытается загрузить класс. Давайте разберемся в этом, выполнив приведенную ниже Java-программу.

package com.journaldev.classloader;

public class ClassLoaderTest {

    public static void main(String[] args) {

        System.out.println("class loader for HashMap: "
                + java.util.HashMap.class.getClassLoader());
        System.out.println("class loader for DNSNameService: "
                + sun.net.spi.nameservice.dns.DNSNameService.class
                        .getClassLoader());
        System.out.println("class loader for this class: "
                + ClassLoaderTest.class.getClassLoader());

        System.out.println(com.mysql.jdbc.Blob.class.getClassLoader());

    }

}

Выход:

class loader for HashMap: null
class loader for DNSNameService: sun.misc.Launcher$ExtClassLoader@7c354093
class loader for this class: sun.misc.Launcher$AppClassLoader@64cbbe37
sun.misc.Launcher$AppClassLoader@64cbbe37

Как работает Java ClassLoader?

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

  • Загрузчик классов java.util.HashMap имеет значение null, что отражает загрузчик классов Bootstrap. ClassLoader класса DNSNameService — это ExtClassLoader. Поскольку сам класс находится в CLASSPATH, System ClassLoader загружает его.
  • Когда мы пытаемся загрузить HashMap, наш системный загрузчик классов делегирует это загрузчику классов расширения. Загрузчик класса расширения делегирует его Bootstrap ClassLoader. Загрузчик классов начальной загрузки находит класс HashMap и загружает его в память JVM.
  • Тот же процесс выполняется для класса DNSNameService. Но Bootstrap ClassLoader не может найти его, так как он находится в $JAVA_HOME/lib/ext/dnsns.jar. Следовательно, он загружается загрузчиком классов Extensions.
  • Класс Blob включен в файл jar MySql JDBC Connector (mysql-connector-java-5.0.7-bin.jar), который указан в пути сборки проекта. Он также загружается системным загрузчиком классов.
  • Классы, загруженные загрузчиком дочерних классов, имеют видимость классов, загруженных загрузчиками родительских классов. Таким образом, классы, загруженные системным загрузчиком классов, видны классам, загруженным расширениями и загрузчиком классов Bootstrap.
  • Если есть одноуровневые загрузчики классов, они не могут получить доступ к классам, загружаемым друг другом.

Зачем писать собственный ClassLoader на Java?

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

Методы загрузчика классов Java

  • Когда JVM запрашивает класс, она вызывает функцию loadClass() загрузчика классов, передавая полностью классифицированное имя класса.
  • Функция loadClass() вызывает метод findLoadedClass(), чтобы проверить, был ли уже загружен класс. Это необходимо, чтобы не загружать один и тот же класс несколько раз.
  • Если класс еще не загружен, он делегирует запрос родительскому загрузчику классов для загрузки класса.
  • Если родительский загрузчик классов не находит класс, он вызывает метод findClass() для поиска классов в файловой системе.

Пример пользовательского загрузчика классов Java

1. CCLoader.java

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

  1. private byte[] loadClassFileData(String name): этот метод считывает файл класса из файловой системы в массив байтов.
  2. private Class getClass(String name): этот метод вызовет функцию loadClassFileData() и, вызвав родительский метод defineClass(), сгенерирует класс и вернет его.< /li>
  3. public Class loadClass(String name): этот метод отвечает за загрузку класса. Если имя класса начинается с com.journaldev (наши примеры классов), то он загрузит его с помощью метода getClass() или вызовет родительскую функцию loadClass() для его загрузки.
  4. public CCLoader (родительский ClassLoader): это конструктор, который отвечает за установку родительского ClassLoader.

import java.io.DataInputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
 
/**
 * Our Custom ClassLoader to load the classes. Any class in the com.journaldev
 * package will be loaded using this ClassLoader. For other classes, it will delegate the request to its Parent ClassLoader.
 *
 */
public class CCLoader extends ClassLoader {
 
    /**
     * This constructor is used to set the parent ClassLoader
     */
    public CCLoader(ClassLoader parent) {
        super(parent);
    }
 
    /**
     * Loads the class from the file system. The class file should be located in
     * the file system. The name should be relative to get the file location
     *
     * @param name
     *            Fully Classified name of the class, for example, com.journaldev.Foo
     */
    private Class getClass(String name) throws ClassNotFoundException {
        String file = name.replace('.', File.separatorChar) + ".class";
        byte[] b = null;
        try {
            // This loads the byte code data from the file
            b = loadClassFileData(file);
            // defineClass is inherited from the ClassLoader class
            // that converts byte array into a Class. defineClass is Final
            // so we cannot override it
            Class c = defineClass(name, b, 0, b.length);
            resolveClass(c);
            return c;
        } catch (IOException e) {
            e.printStackTrace();
            return null;
        }
    }
 
    /**
     * Every request for a class passes through this method. If the class is in
     * com.journaldev package, we will use this classloader or else delegate the
     * request to parent classloader.
     *
     *
     * @param name
     *            Full class name
     */
    @Override
    public Class loadClass(String name) throws ClassNotFoundException {
        System.out.println("Loading Class '" + name + "'");
        if (name.startsWith("com.journaldev")) {
            System.out.println("Loading Class using CCLoader");
            return getClass(name);
        }
        return super.loadClass(name);
    }
 
    /**
     * Reads the file (.class) into a byte array. The file should be
     * accessible as a resource and make sure that it's not in Classpath to avoid
     * any confusion.
     *
     * @param name
     *            Filename
     * @return Byte array read from the file
     * @throws IOException
     *             if an exception comes in reading the file
     */
    private byte[] loadClassFileData(String name) throws IOException {
        InputStream stream = getClass().getClassLoader().getResourceAsStream(
                name);
        int size = stream.available();
        byte buff[] = new byte[size];
        DataInputStream in = new DataInputStream(stream);
        in.readFully(buff);
        in.close();
        return buff;
    }
}

2. CCRun.java

Это наш тестовый класс с Java Reflection API для вызова его методов.

import java.lang.reflect.Method;
 
public class CCRun {
 
    public static void main(String args[]) throws Exception {
        String progClass = args[0];
        String progArgs[] = new String[args.length - 1];
        System.arraycopy(args, 1, progArgs, 0, progArgs.length);

        CCLoader ccl = new CCLoader(CCRun.class.getClassLoader());
        Class clas = ccl.loadClass(progClass);
        Class mainArgType[] = { (new String[0]).getClass() };
        Method main = clas.getMethod("main", mainArgType);
        Object argsArray[] = { progArgs };
        main.invoke(null, argsArray);

        // Below method is used to check that the Foo is getting loaded
        // by our custom class loader i.e CCLoader
        Method printCL = clas.getMethod("printCL", null);
        printCL.invoke(null, new Object[0]);
    }
 
}

3. Foo.java и Bar.java

Это наши тестовые классы, которые загружаются нашим пользовательским загрузчиком классов. У них есть метод printCL(), который вызывается для печати информации ClassLoader. Класс Foo будет загружен нашим пользовательским загрузчиком классов. Foo использует класс Bar, поэтому класс Bar также будет загружен нашим пользовательским загрузчиком классов.

package com.journaldev.cl;
 
public class Foo {
    static public void main(String args[]) throws Exception {
        System.out.println("Foo Constructor >>> " + args[0] + " " + args[1]);
        Bar bar = new Bar(args[0], args[1]);
        bar.printCL();
    }
 
    public static void printCL() {
        System.out.println("Foo ClassLoader: "+Foo.class.getClassLoader());
    }
}

package com.journaldev.cl;
 
public class Bar {
 
    public Bar(String a, String b) {
        System.out.println("Bar Constructor >>> " + a + " " + b);
    }
 
    public void printCL() {
        System.out.println("Bar ClassLoader: "+Bar.class.getClassLoader());
    }
}

4. Шаги выполнения Java Custom ClassLoader

Первым делом скомпилируем все классы через командную строку. После этого мы запустим класс CCRun, передав три аргумента. Первый аргумент — это полностью классифицированное имя класса Foo, которое будет загружено нашим загрузчиком классов. Два других аргумента передаются основной функции класса Foo и конструктору Bar. Шаги выполнения и вывод будут такими, как показано ниже.

$ javac -cp . com/journaldev/cl/Foo.java
$ javac -cp . com/journaldev/cl/Bar.java
$ javac CCLoader.java
$ javac CCRun.java
CCRun.java:18: warning: non-varargs call of varargs method with inexact argument type for last parameter;
cast to java.lang.Class<?> for a varargs call
cast to java.lang.Class<?>[] for a non-varargs call and to suppress this warning
Method printCL = clas.getMethod("printCL", null);
^
1 warning
$ java CCRun com.journaldev.cl.Foo 1212 1313
Loading Class 'com.journaldev.cl.Foo'
Loading Class using CCLoader
Loading Class 'java.lang.Object'
Loading Class 'java.lang.String'
Loading Class 'java.lang.Exception'
Loading Class 'java.lang.System'
Loading Class 'java.lang.StringBuilder'
Loading Class 'java.io.PrintStream'
Foo Constructor >>> 1212 1313
Loading Class 'com.journaldev.cl.Bar'
Loading Class using CCLoader
Bar Constructor >>> 1212 1313
Loading Class 'java.lang.Class'
Bar ClassLoader: CCLoader@71f6f0bf
Foo ClassLoader: CCLoader@71f6f0bf
$

Если вы посмотрите на вывод, он пытается загрузить класс com.journaldev.cl.Foo. Поскольку он расширяет класс java.lang.Object, он пытается сначала загрузить класс Object. Итак, запрос поступает в метод loadClass CCLoader, который делегирует его родительскому классу. Таким образом, загрузчики родительских классов загружают Object, String и другие классы Java. Наш ClassLoader загружает только классы Foo и Bar из файловой системы. Это видно из вывода функции printCL(). Мы можем изменить функциональность loadClassFileData() для чтения массива байтов с FTP-сервера или вызвать любую стороннюю службу для получения массива байтов класса на лету. Я надеюсь, что статья будет полезна для понимания работы Java ClassLoader и того, как мы можем расширить его, чтобы он мог делать гораздо больше, чем просто брать его из файловой системы.

Создание пользовательского ClassLoader в качестве ClassLoader по умолчанию

Мы можем сделать наш собственный загрузчик классов загрузчиком по умолчанию при запуске JVM с помощью параметров Java. Например, я снова запущу программу ClassLoaderTest после предоставления опции загрузчика классов java.

$ javac -cp .:../lib/mysql-connector-java-5.0.7-bin.jar com/journaldev/classloader/ClassLoaderTest.java
$ java -cp .:../lib/mysql-connector-java-5.0.7-bin.jar -Djava.system.class.loader=CCLoader com.journaldev.classloader.ClassLoaderTest
Loading Class 'com.journaldev.classloader.ClassLoaderTest'
Loading Class using CCLoader
Loading Class 'java.lang.Object'
Loading Class 'java.lang.String'
Loading Class 'java.lang.System'
Loading Class 'java.lang.StringBuilder'
Loading Class 'java.util.HashMap'
Loading Class 'java.lang.Class'
Loading Class 'java.io.PrintStream'
class loader for HashMap: null
Loading Class 'sun.net.spi.nameservice.dns.DNSNameService'
class loader for DNSNameService: sun.misc.Launcher$ExtClassLoader@24480457
class loader for this class: CCLoader@38503429
Loading Class 'com.mysql.jdbc.Blob'
sun.misc.Launcher$AppClassLoader@2f94ca6c
$

CCLoader загружает класс ClassLoaderTest, потому что он находится в пакете com.journaldev.

Вы можете загрузить пример кода ClassLoader из нашего репозитория GitHub.