JRebel Unloaded

Добро пожаловать во второй выпуск серии  Discotek.ca  по разработке байт-кода. Первая статья, обзор разработки байт-кода, может быть найдена  здесь .

JRebel бесспорно , является в отрасли  перегрузочного класса  программного обеспечения. Это полезный продукт заработал свою репутацию, помогая ускорить разработку Java для многих организаций. Как работает этот продукт — загадка для большинства. Я хотел бы объяснить, как я думаю, что это работает и предоставить  базовый прототип  (с  исходным кодом ).

Со времени принятия серверов приложений для изоляции бизнес-логики от универсальной логики подключения разработчики страдали от трудоемкого процесса создания и повторного развертывания перед тестированием изменений кода на стороне сервера. Чем больше приложение, тем длиннее цикл сборки / повторного развертывания. Для разработчика, который часто тестирует, время, потраченное на сборку и перенос, может занять значительную часть рабочего дня. Фактическая стоимость проекта может быть приравнена к числу разработчиков * зарплата / в час * количество часов, потраченных на строительство и повторное развертывание. Эта цифра не должна быть просто стоимость ведения бизнеса.

Некоторое время назад, когда я изучал инструментарий, я написал продукт под названием  Feenix , который, как я думал, поможет людям преодолеть ту же перезагрузку классов, что и JRebel, но этого не произошло. Продукт все еще существует на моем веб-сайте, но я сомневаюсь, что кто-нибудь на самом деле его использует. Пока я держу это там как болезненное напоминание о моей неудаче, которая должна вдохновить меня на создание лучшей. Я не понимал, почему мой продукт потерпел неудачу, пока  Антон Архипов , автор JRebel, не  дал несколько проницательных критических замечаний :

Feenix может сделать столько, сколько позволяет API Java Instrumentation API. Что в основном означает, что это не добавляет ценности по сравнению со стандартным HotSwap JVM. 

Существует несколько продуктов, которые предоставляют механизм изменения функциональности классов в работающей JVM, но не все они созданы равными. Вероятно, наиболее известным является встроенная горячая замена Java, которой IDE, как Eclipse, пользуются в режиме отладки. Другие, такие как Feenix, используют встроенный инструментарий Java API. Из-за ограничений JVM большинство из этих попыток терпят неудачу. В частности, JVM ограничивает типы изменений, разрешенных для загруженного класса. Например, JVM не позволит вам изменить схему класса. Это означает, что вы не можете изменить количество полей или методов или их подписей. Вы также не можете изменить иерархию наследования. Они также не могут изменить поведение существующих объектов. К сожалению, это резко снижает полезность этих продуктов.

Введите JRebel. JRebel, по-видимому, является самым функциональным и высоко оцениваемым продуктом класса перезарядки на рынке. У него очень мало недостатков, и, похоже, он очень хорошо поддерживается. JRebel является коммерческим продуктом и, вероятно, будет чрезмерно дорогим для большинства разработчиков, которые платят за инструменты из своего кармана. Сторонники JRebel опубликовали несколько статей, в которых обсуждается, как они решили различные проблемы перезагрузки классов, но, поскольку они являются коммерческим продуктом, они, естественно, не обсуждают реализацию в деталях. Знание деталей может привести к появлению альтернативного продукта с открытым исходным кодом. Если будет достаточно интереса, я интегрирую перезагрузку класса стиля JRebel в Feenix и открою его.

Создание механизма перезагрузки классов (CRM) должно решить несколько проблем:

1. CRM должен знать, где находятся новые версии классов. Эти классы могут находиться на локальном диске или в удаленном месте. Они могут быть связаны в банке, войне или ухе.
2. Хотя технически это не классовая загрузка, CRM также должен поддерживать перезагрузку неклассовых ресурсов, таких как изображения или HTML-файлы.
3. CRM должен гарантировать, что когда загрузчик классов загружает класс в первый раз, он загружает последнюю версию. Несмотря на то, что класс уже загружен загрузчиком классов, CRM должен гарантировать, что новые экземпляры класса будут использовать функциональные возможности последней версии класса.
4. CRM должен гарантировать, что функциональность существующих объектов должна использовать функциональность последней версии своего класса.
5. Хотя перезагрузка классов, несомненно, является основной функциональностью, требуемой для любого CRM, во многих приложениях используются общие платформы, для изменения конфигурации которых потребуется цикл сборки / повторного развертывания. Эти изменения должны быть менее частыми, чем изменения кода, но все же имеет смысл обеспечить функциональность такой перезагрузки.

Четвертая проблема выше затмевает другие с точки зрения сложности, но и полезности. Для серверов приложений дешевле использовать повторно объединенные объекты, чем всегда создавать новые экземпляры. Если CRM не может сообщать объединенным экземплярам об изменениях класса, это будет служить очень малой цели. Разработчики JRebel заявляют, что для решения этих проблем они используют «управление версиями классов», но оставляют много места для интерпретации реализации. Мы знаем, что загрузчики классов могут загружать класс только один раз. Исключением из этого правила является инструментарий, но мы знаем, что это не то, как JRebel решил эту проблему (в основном потому, что они открыто об этом, но также), потому что инструментарий не позволит изменить схему класса. Другой подход к проектированию CRM обычно известен как «одноразовые загрузчики классов»,который использует новый загрузчик классов для загрузки каждой новой версии класса. Эта конструкция имеет много недостатков, но, прежде всего, не может решить проблему введения новых функциональных возможностей в существующие объекты.

Чтобы представить новые функциональные возможности существующим объектам, их выполнение должно быть передано методу, который содержит новые функциональные возможности. Поскольку загрузчик классов может загрузить данный класс только один раз, новая функциональность должна быть размещена в классе с новым уникальным именем. Однако класс не может знать имя своего преемника во время компиляции или выполнения. Мы можем использовать инструментарий для изменения класса по мере его загрузки, но мы не будем знать имена его преемников, пока CRM не обнаружит новые скомпилированные классы и не сделает их доступными для JVM. Для пересылки выполнения его преемнику можно использовать два механизма: отражение или интерфейс. Reflection может проверять методы класса и вызывать метод с соответствующим именем и сигнатурой. Известно, что отражение медленное и не подходит для каждого вызова метода. С другой стороны,может быть создан интерфейс, который определяет метод, позволяющий в общем случае вызывать любой метод в классе наследника. Такой метод может иметь следующие имя и подпись:

public Object invoke(int methodId, Object invoker, Object args[]);

Если более новая версия данного класса реализует этот интерфейс, выполнение может быть передано соответствующему методу. Параметр  methodId  используется для определения метода. Параметр  invoker  обеспечивает доступ к состоянию (полям) исходного объекта, а   параметр args предоставляет новому методу доступ к аргументам исходного метода.

Рабочее решение имеет гораздо больше движущихся частей, чем приведенный выше контур. Это также вводит две дополнительные проблемы для решения. Каждый вызов метода перезагруженного объекта создает дополнительный неожиданный кадр в стеке, что может сбивать с толку разработчиков. Любое использование отражения в перезагруженных классах может вести себя некорректно (учитывая, что имя класса изменилось и   был добавлен метод invoke , иерархия наследования не существует и т. Д.). Выявление таких проблем важно, а также предоставление рабочих решений. Решение всех вышеперечисленных проблем в одной статье, вероятно, приведет к тяжелым векам. Вместо этого давайте сосредоточимся на элементарной реализации функциональности пересылки классов. Мы всегда можем вернуться к другим вопросам в другой статье, если есть интерес.

В этой статье будут рассмотрены следующие функциональные части механизма перезагрузки классов:

1. Центральный компонент для обнаружения и управления версиями классов
2. Создайте класс-преемник и интерфейс для ссылки на него
3. Изменить класс приложения для пересылки вызовов методов его преемникам
4. Измените java.lang.ClassLoader для установки вышеуказанных функций.

Прежде чем углубляться в детали, я хотел бы предупредить вас, что я переписал эту статью дважды. Несмотря на мой живой интерес к проектированию байт-кода, даже мне было до слез скучно писать объяснения кода ASM. Следовательно, этот третий и, надеюсь, окончательный проект будет содержать гораздо меньше кода ASM, чем другие. В нем будет больше внимания тому, как работает перезагрузка классов, но вы всегда можете обратиться к исходному коду в разделе Ресурсы,  чтобы увидеть подробности реализации.

Класс перегрузочного механизма Design

Менеджер версий классов (AKA ClassManager) будет иметь несколько заданий:

• Загрузите конфигурацию, которая указывает пространство имен для перезагрузки и где их найти
• Определите, устарела ли версия класса
• Укажите байт-код для:
  
  • новые версии данного класса
  • универсальный вызываемый интерфейсный класс
  • класс реализации интерфейса (который содержит новую функциональность)

Если я подробно остановлюсь на всем вышеперечисленном, эта статья будет длиннее, чем «  Война и мир» . Вместо этого я замаскирую детали, которые не имеют прямого отношения к разработке байт-кода. Для получения подробной информации
о конфигурации вы можете обратиться к  ca.discotek.feenix.Configuraton  и статическому инициализатору  ca.discotek.feenix.ClassManager . Вот пример файла конфигурации:

<feenix-configuration project-name="example">
    <classpath>
        <entry>C:/eclipse/workspace/my-project/bin</entry>

        <!-- alternatively, you can use jar, war, and ear files -->
        <entry>C:/eclipse/workspace/my-project/dist/example.jar</entry>
        <entry>C:/eclipse/workspace/my-project/dist/example.war</entry>
        <entry>C:/eclipse/workspace/my-project/dist/example.ear</entry>

        <!--  Use the exclude tag to exclude namespaces. It uses a Java regular expression. -->
        <exclude>ca\.discotek\.feenix2\.example\.Example</exclude>
    </classpath>
</feenix-configuration>

static Map<String, Long> classTimestampMap = new HashMap<String, Long>();

static boolean isOutDated(String className, long timestamp) {
    Long l = classTimestampMap.get(className);
    if (l == null) {
        classTimestampMap.put(className, timestamp);
        return false;
    }
    else {
        classTimestampMap.put(className, timestamp);
        return timestamp > l;
    }
}

class Printer {
    public void printMessage(String message) {
        System.out.println(message);
    }
}

class Printer {

    Printer_interface printerInterface = null;

    static void check_update() {
        Printer_interface localPrinterInterface = ClassManager.getUpdate(ca.discotek.feenix.example.Printer.class);
        if (localPrinterInterface != null)
            printerInterface = localPrinterInterface;
    }

    public void printMessage(String message) {
        check_update();
        if (printerInterface != null) {
            printerInterface.invoke(0, this, new Object[]{message});
            return;
        }
        else {
            System.out.println(message);
        }
    }
}

public static Object getUpdate(Class type) {
    String dotClassName = type.getName();
    String slashClassName = dotClassName.replace('.', '/');

    File file = db.getFile(slashClassName + ".class");
    if (file != null && file.isFile()) {
        long lastModified = file.lastModified();
        if (isOutDated(dotClassName, lastModified)) {
            String newName = slashClassName + IMPLEMENTATION_SUFFIX + getNextVersion(slashClassName);
            byte bytes[] = getClassBytes(newName);
            try {
                Method method = ClassLoader.class.getDeclaredMethod("defineMyClass", new Class[]{String.class, byte[].class});
                Class newType = (Class) method.invoke(type.getClassLoader(), new Object[]{newName.replace('/', '.'), bytes});
                return newType.newInstance();
            }
            catch (Exception e) {
                e.printStackTrace();
            }
        }
    }

    return null;
}

public static byte[] getClassBytes(String slashClassName) {
    if (isInterface(slashClassName))
        return InterfaceGenerator.generate(slashClassName, trimInterfaceSuffix(slashClassName));
    else if (isImplementation(slashClassName)) {
        String rootClassName = trimImplementationSuffix(slashClassName);
        File file = db.getFile(rootClassName.replace('.', '/') + ".class");
        if (file != null)
            return ImplementationGenerator.generate(slashClassName, file);
    }
    else {
        File file = db.getFile(slashClassName + ".class");
        if (file != null)
            return ModifyClassVisitor.generate(slashClassName, file);
    }

    return null;
}

public java.lang.Object __invoke__(int index, ca.discotek.feenix.example.gui.Printer__interface__, java.lang.Object[]) 

public MethodVisitor visitMethod(int access,
        String name,
        String desc,
        String signature,
        String[] exceptions) {

    MethodVisitor mv = super.visitMethod(access, METHOD_NAME_UTIL.processName(name), desc, signature, exceptions);
    if (name.equals(LOAD_CLASS_METHOD_NAME) && desc.equals("(Ljava/lang/String;)Ljava/lang/Class;"))
        return new InvokeMethodNameReplacerMethodVisitor(mv, methodNameUtil);
    else if (name.equals(DEFINE_CLASS_METHOD_NAME))
        return new InvokeMethodNameReplacerMethodVisitor(mv, methodNameUtil);
    else
        return mv;
}

public void visitEnd() {
    try {
        InputStream is =
            Thread.currentThread().getContextClassLoader().getResourceAsStream(ClassLoaderTargeted.class.getName().replace('.', '/') + ".class");
        ClassReader cr = new ClassReader(is);
        ClassNode node = new UpdateMethodInvocationsClassNode();
        cr.accept(node, ClassReader.SKIP_FRAMES);

        Iterator<MethodNode> it = node.methods.listIterator();
        MethodNode method;
        String exceptions[];
        while (it.hasNext()) {
            method = it.next();
            if (method.name.equals(DEFINE_CLASS_METHOD_NAME) ||
                method.name.equals(LOAD_CLASS_METHOD_NAME) ||
                method.name.equals(DEFINE_MY_CLASS_METHOD_NAME)) {

                exceptions = method.exceptions == null ? null : method.exceptions.toArray(new String[method.exceptions.size()]);
                MethodVisitor mv = super.visitMethod(method.access, method.name, method.desc, method.signature, exceptions);
                method.accept(mv);
            }
        }
    }
    catch (Exception e) {
        throw new Error("Unable to create classloader.", e);
    }

    super.visitEnd();
}

/java/jdk1.7.0/bin/java -jar /projects/feenix-2.0/discotek.feenix-2.0.jar /java/jdk1.7.0/jre/lib/rt.jar /projects/feenix-2.0 

 -Xbootclasspath/p:C:\projects\feenix-2.0\feenix-classloader.jar;C:\projects\feenix-2.0\discotek.feenix-2.0.jar -noverify -Dfeenix-config=C:\projects\feenix-example\cfg\feenix.xml