Java Reflection API: методы и примеры использования

Java Reflection API — инструмент, с помощью которого можно анализировать и изменять структуру программы во время выполнения. Рефлексия — это мощный механизм, который может быть полезен в различных ситуациях. Например, когда вы разрабатываете фреймворки, библиотеки или инструменты, чтобы работать с кодом.

Что такое Java Reflection API

Java Reflection — это особенная функция, благодаря которой программа получает доступ к приватным частям объектов или может изменить поведение некоторых методов классов. Такой код адаптируется к входным данным и не зависит от типов, с которыми работает.

Главные преимущества рефлексии в Java — это доступ к закрытым частям класса и динамическая работа с кодом. Например, можно:

• вызвать приватный метод класса, даже если он недоступен в обычных условиях;
• проанализировать структуру класса во время выполнения: поля, методы, аннотации;
• создать объект или вызвать метод, имя которого неизвестно до запуска программы.

Работать с рефлексией нужно аккуратно — она обходит проверки компилятора и может привести к ошибкам в рантайме.

Для чего используется рефлексия

Есть много примеров, когда рефлексия становится полезной в проектах. Рассмотрим несколько вариантов ее использования:

• Тестирование кода. Есть два пути, если нужно проверить корректность работы приватной функции. Первый — сделать ее на время публичной, а потом снова приватной. Второй вариант проще и быстрее — вызвать ее в тесте через рефлексию.
• Фреймы и библиотеки. В популярном Spring Framework рефлексия помогает создать бины. Во время работы программы фреймворк собирает данные о классах, которые помечены аннотацией `@Component`, и создает для них экземпляры. Бины не нужно прописывать в конфигурации, а можно создавать автоматически.
• Поиск и запуск тестов. Например, так применяет рефлексию библиотека JUnit. Опытные пользователи замечали, что тесты помечены аннотацией `@Test`. Это сделано как раз для того, чтобы во время работы JUnit прошелся по всем классам и запустил всё с этой аннотацией.
• Сериализация и десериализация объектов. Например, библиотека Jackson использует рефлексию для сериализации и десериализации объектов в стандарте JSON. Без нее Jackson не смог бы прочитать значения приватных полей и корректно сохранить их в JSON-формате. То же касается и десериализации, когда Jackson должен восстановить значения всех полей, в том числе приватных, — это было бы невозможно без рефлексии.

Больше узнать об этих библиотеках и научиться программировать поможет курс «Java-разработчик» онлайн-университета Skypro. Он включает 440 часов теории и практики, видеоуроки и вебинары с преподавателями — экспертами в области Java-разработки. Еще вас ждут мастер-классы с реальными рабочими задачами и поддержка наставников. После учебы получите диплом о профессиональной переподготовке.

Особенности Java Reflection

Java Reflection API — это часть языка, а не библиотеки. Это означает, что использовать рефлексию можно над любым классом, который написан на Java. Для этого достаточно импортировать пакет `java.lang.reflect` в свой код.

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

Примитивные типы данных, например int, не поддерживают Java Reflection. Придется создавать классы-обертки вокруг них, чтобы использовать рефлексию.

История рефлексии в Java

Само понятие рефлексии в Java появилось еще в версии 1.1. До этого можно было работать только предопределенными классами. Но теперь появился класс `Class`, который дает доступ к структуре любого объекта в Java.

«`java
Class<?> stringClass = String.class;
Method[] methods = stringClass.getMethods();
«`

Пример инициации класса `String` и получения всех методов `String`

С тех пор Java постоянно улучшала рефлексию. Например, в версии 5 добавили оператор instanceof — он проверяет, относится ли объект к нужному классу. А в Java 8 появился метод getDeclaredMethods() — он показывает все методы класса, даже приватные.

В Java рефлексия умеет создавать динамические прокси — специальные объекты, которые могут перехватывать вызовы методов. Это может пригодиться, чтобы автоматически логировать все вызовы к методам класса.

Примеры использования Java Reflection

Разберем, как применять рефлексию в Java. Все примеры будут использовать класс `Human`, в котором есть приватное поле `name`, публичный геттер `getName()` и приватная функция `generateSecret()`. Приватная функция берет слово Secret и добавляет к нему входную строку, которую мы называем `salt`. На выходе получаем число из строки.
Класс `Human` приведен ниже:

```java
public class Human {

private String name;

public Human(String name, String address) {
this.name = name;
this.address = address;
}

private int generateSecret(String salt) {
return "secret".concat(salt).hashCode();
}

public String getName() {
return name;
}
}
```

Получение метаданных класса

Класс `Class` — это основа рефлексии. В нём видно всё: что класс умеет, из чего состоит и как работает. В качестве примера создадим класс `ReflectionExample` и в методе `main()` добавим объект класса `Human`. Чтобы получить соответствующий Class, достаточно вызвать функцию `getClass()` на любом объекте:

```java
public class ReflectionExample {
public static void main(String[] args) {
Human john = new Human("John", "London");
Class<?> humanClass = john.getClass();
}
}
```

Теперь используем переменную `humanClass`, чтобы получить конкретные данные о классе. Для этого можно вызвать следующие методы на объекте `humanClass`:

• `getName()` — возвращает имя и пакет класса;
• `getSimpleName()` — возвращает имя класса без пакета;
• `getModifiers()` — возвращает модификаторы класса;
• `getSuperclass()` — возвращает родительский класс;
• `getInterfaces()` — возвращает список интерфейсов, которые наследует класс;
• `getConstructors()` — возвращает список конструкторов класса;
• `getFields()` — возвращает список публичных полей класса;
• `getDeclaredFields()` — возвращает список всех полей класса, в том числе приватных;
• `getMethods()` — возвращает массив публичных методов класса;
• `getDeclaredMethods()` — возвращает массив всех методов класса, в том числе приватных;
• `getPackage()` — возвращает имя пакета класса.

Методы `getFields()` и `getMethods()` нужны, чтобы изменить приватные поля и вызвать приватные методы.

Узнать о других методах и классах в языке и научиться их использовать можно на курсе Skypro «Java-разработчик». Программа разбита на тематические блоки, в конце которых студенты выполняют курсовую работу. Опытные наставники и кураторы всегда готовы ответить на вопросы.

Получение метаданных переменной

Покажем, как получить доступ и изменить то, что хранится в приватной переменной `name` в классе `Human`, даже если у нее нет сеттера.
Снова создадим объект класса `Human` и `Class`. Используем функцию `getDeclaredFields()`, чтобы получить все поля класса, даже приватные. Далее пройдемся по массиву переменных и найдем ту, которую хотим изменить. Используем функции `setAccessible()`, чтобы снять ограничения доступа, `set()`, чтобы изменить переменную, или `get()`, чтобы прочитать значение.

«`java

public class ReflectionVarExample {

public static void main(String[] args) throws Exception {

Human john = new Human("John", 25);

Field[] flds = Human.class.getDeclaredFields();

for (Field fld : flds) {
if (fld.getName().equals("name")) {
fld.setAccessible(true);
fld.set(john, "Bob");
}

}

System.out.println(john.getName());

}

}

«`

Получение метаданных метода

Теперь посмотрим, как получить метаданные обо всех методах класса, в том числе приватных, и вызвать любой из них.
Создадим объект класса `Human` и извлечем его метаданные. Далее используем `getDeclaredMethods` и получим список всех методов в этом классе. Среди этого списка найдем нужный и вызовем этот метод с собственными данными. Используем функцию `setAccessible()`, чтобы снять ограничения доступа, и `invoke()`, чтобы вызвать метод.

«`java

public class ReflectionMethodExample {

public static void main(String[] args) throws Exception {

Human john = new Human("John", 25);

Method[] mthds = Human.class.getDeclaredMethods();

for (Method mthd : mthds) {
if (mthd.getName().equals("getSecret")) {
mthd.setAccessible(true);
String secret = (int) mthd.invoke(john, "broken");
System.out.println(secret);
}
}

}

}

«`

Освойте Java на курсе Skypro «Java-разработчик». Учебе нужно будет уделять всего 10 часов в неделю — сможете совмещать с работой и личными делами. Вас ждут 440 часов теории и практики, мастер-классы с реальными рабочими задачами, опытные преподаватели, кураторы и наставники. За время учебы сделаете два полноценных проекта для портфолио и множество домашних заданий, чтобы отработать навыки.

Преимущества и недостатки рефлексии в Java

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

Ограничения Java Reflection API

Рефлексия в Java — это удобно, но не всегда безопасно и эффективно. Главные ограничения, которые стоит учитывать:

• Низкая производительность. Не подходит для высоконагруженных участков кода.
• Проблемы с безопасностью. SecurityManager может заблокировать рефлексивный доступ. В новых версиях Java постепенно усиливают ограничения.
• Есть ограничения в новых версиях Java. Например, в Java 9+ нельзя использовать Reflection для модулей без разрешения, ограничен доступ к внутренним API JDK.
• Нет поддержки в некоторых средах. Android и некоторые security-ориентированные окружения частично ограничивают Reflection.

Краткие итоги

• Java Reflection API — мощный инструмент, с помощью которого можно анализировать и менять структуру классов во время выполнения, включая доступ к приватным полям и методам.
• Рефлексия помогает программистам создавать различные фреймворки и библиотеки и писать гибкий код.
• Использовать рефлексию нужно с осторожностью, так как она может сильно замедлить работу программы.