Reflection API и JavaDoc в Java. Практические Задания

Тест на рефлексии упал, а в отчёте вместо причины — null. Так бывает, если поймать исключение из Method.invoke() и напечатать его сообщение:

// в классе Calculator: public int divide(int a, int b) { return a / b; }
Method divide = Calculator.class.getMethod("divide", int.class, int.class);
try {
    divide.invoke(new Calculator(), 1, 0);
} catch (InvocationTargetException e) {
    System.out.println(e.getMessage()); // Вывод: null
    System.out.println(e.getCause());   // Вывод: java.lang.ArithmeticException: / by zero
}

Задачи по рефлексии в Java на этой странице закрепляют модуль «Reflection API и JavaDoc»: вы выведете структуру класса по его имени, напишете универсальный toString() и DTO-маппер, которые читают private-поля, загрузите плагины по имени класса из файла настроек, соберёте мини-тест-раннер на Method.invoke() и задокументируете класс так, чтобы команда javadoc сгенерировала HTML без ошибок doclint. К каждой задаче есть подсказка, а после задач собраны промахи, на которых такие решения ломаются чаще всего.

Что повторить перед решением

Для пяти задач по Reflection API нужно уметь получать объект Class по имени, перебирать поля, конструкторы и методы через getDeclared*() и работать с ними через newInstance(), invoke(), get() и set(). Для шестой задачи — знать теги Javadoc и опции команды javadoc. Каждое правило с примером разобрано в разделах уроков из таблицы.

Структура класса по его имени

Интернет-магазин · часть 9 из 12 · ← часть 8 · часть 10 →

Напишите программу, которая читает с консоли полное имя класса (например, shop.Product) и печатает его структуру:

1. модификаторы и полное имя класса; слово class или interface выберите по isInterface();
2. суперкласс и реализованные интерфейсы;
3. все объявленные в классе поля: модификаторы, тип, имя;
4. все объявленные конструкторы: модификаторы и типы параметров;
5. все объявленные методы: модификаторы, тип возвращаемого значения, имя и типы параметров.

Учитывайте и private-члены. Поля и методы выводите отсортированными по имени, конструкторы — по числу параметров, типы членов — простыми именами (getSimpleName()). Если класса нет, программа выводит Класс не найден: ..., а не stack trace.

Проверьте программу на классе:

package shop;

public class Product implements Comparable<Product> {
    public static final int MAX_NAME = 100;
    private String name;
    protected double price;

    public Product() {
    }

    private Product(String name, double price) {
        this.name = name;
        this.price = price;
    }

    public String getName() {
        return name;
    }

    @Override
    public int compareTo(Product other) {
        return Double.compare(price, other.price);
    }

    private static void log(String message) {
        System.out.println(message);
    }
}

Ожидаемый вывод для ввода shop.Product:

public class shop.Product
Суперкласс: java.lang.Object
Интерфейсы: java.lang.Comparable
Поля:
  public static final int MAX_NAME
  private String name
  protected double price
Конструкторы:
  public Product()
  private Product(String, double)
Методы:
  public int compareTo(Product)
  public String getName()
  private static void log(String)

Для ввода shop.Prodcut: Класс не найден: shop.Prodcut

Универсальный toString() через рефлексию

Напишите класс ReflectionToString со статическим методом String toString(Object obj), который для любого объекта строит строку вида ИмяКласса{поле1=значение1, поле2=значение2}:

1. выводятся все поля объекта, включая private и унаследованные от суперклассов; поля суперкласса идут первыми;
2. static-поля не выводятся — они принадлежат классу, а не объекту;
3. для null метод возвращает строку null;
4. значения полей превращаются в строку через String.valueOf(), вложенные объекты рекурсивно не разбираются.

Проверьте метод на классах Student и Aspirant из задачи «Наследование Student, Aspirant». Если вы её решали, возьмите свои классы и добавьте в Aspirant поле с темой научной работы, а в Student — статический счётчик созданных объектов. Если нет — используйте эти:

class Student {
    private static int count;
    private String firstName;
    private String lastName;
    private String group;
    protected double averageMark;

    Student(String firstName, String lastName, String group, double averageMark) {
        this.firstName = firstName;
        this.lastName = lastName;
        this.group = group;
        this.averageMark = averageMark;
        count++;
    }

    double getScholarship() {
        return averageMark == 5 ? 2000 : 1900;
    }
}

class Aspirant extends Student {
    private String researchWork;

    Aspirant(String firstName, String lastName, String group, double averageMark, String researchWork) {
        super(firstName, lastName, group, averageMark);
        this.researchWork = researchWork;
    }

    @Override
    double getScholarship() {
        return averageMark == 5 ? 2500 : 2200;
    }
}

Student[] students = {
        new Student("Анна", "Иванова", "КН-11", 4.5),
        new Aspirant("Иван", "Петров", "ФИ-21", 5.0, null)
};
for (Student s : students) {
    System.out.println(ReflectionToString.toString(s));
}
System.out.println(ReflectionToString.toString(null));

Ожидаемый вывод:

Student{firstName=Анна, lastName=Иванова, group=КН-11, averageMark=4.5}
Aspirant{firstName=Иван, lastName=Петров, group=ФИ-21, averageMark=5.0, researchWork=null}
null

Элемент массива объявлен как Student, но во второй строке имя класса — Aspirant: getClass() возвращает фактический тип объекта, а не тип переменной.

Затем переопределите toString() только в Student одной строкой return ReflectionToString.toString(this); и убедитесь, что System.out.println(s) в том же цикле печатает то же самое — Aspirant унаследует этот метод, и его новое поле всё равно попадёт в строку.

Фабрика плагинов: класс по имени из файла настроек

Приложение должно подключать обработчики строк (плагины), не зная их классов при компиляции: имена классов лежат в файле настроек. Создайте в пакете plugins интерфейс и три класса:

package plugins;

public interface Plugin {
    String execute(String input);
}

package plugins;

public class UpperCasePlugin implements Plugin {
    @Override
    public String execute(String input) {
        return input.toUpperCase();
    }
}

package plugins;

public class ReversePlugin implements Plugin {
    @Override
    public String execute(String input) {
        return new StringBuilder(input).reverse().toString();
    }
}

package plugins;

public class GreetingPlugin implements Plugin {
    private final String greeting;

    public GreetingPlugin(String greeting) {
        this.greeting = greeting;
    }

    @Override
    public String execute(String input) {
        return greeting + ", " + input;
    }
}

Файл plugins.properties в корне проекта:

plugin.1=plugins.UpperCasePlugin
plugin.2=plugins.ReversePlugin
plugin.3=plugins.GreetingPlugin
plugin.4=plugins.Missing
plugin.5=java.lang.StringBuilder

Напишите программу, которая:

1. читает файл и обходит записи в порядке ключей;
2. получает класс через Class.forName() и проверяет, что он реализует Plugin, ещё до создания объекта;
3. создаёт объект через getDeclaredConstructor().newInstance();
4. находит метод execute через getMethod("execute", String.class), вызывает его через invoke() со строкой "Hello" и печатает [ПростоеИмяКласса] результат;
5. на каждую проблему выводит своё сообщение и переходит к следующему плагину: ClassNotFoundException, NoSuchMethodException (нет конструктора без параметров) и класс, не реализующий Plugin.

Ожидаемый вывод:

[UpperCasePlugin] HELLO
[ReversePlugin] olleH
Нет конструктора без параметров: plugins.GreetingPlugin
Класс не найден: plugins.Missing
Не является плагином: java.lang.StringBuilder

DTO-маппер: копирование одноимённых полей

Напишите класс FieldMapper с методом static <T> T copy(Object source, Class<T> targetClass), который создаёт объект класса targetClass и переносит в него значения полей из source:

1. копируются только поля, которые есть в обоих классах с одинаковым именем и одинаковым типом;
2. если имя совпадает, а тип нет, поле не копируется, а в консоль выводится Пропущено: имя (тип -> тип);
3. static- и final-поля не копируются;
4. остальные поля нового объекта сохраняют значения по умолчанию.

Проверьте маппер на классах:

class User {
    private long id;
    private String login;
    private String passwordHash;
    private int age;

    User(long id, String login, String passwordHash, int age) {
        this.id = id;
        this.login = login;
        this.passwordHash = passwordHash;
        this.age = age;
    }
}

class UserDto {
    private long id;
    private String login;
    private String age;
    private boolean active;

    @Override
    public String toString() {
        return "UserDto{id=" + id + ", login=" + login + ", age=" + age + ", active=" + active + "}";
    }
}

UserDto dto = FieldMapper.copy(new User(7, "anna", "5f4dcc3b", 30), UserDto.class);
System.out.println(dto);

Ожидаемый вывод: поле passwordHash в DTO не попадает, age пропущено из-за разных типов:

Пропущено: age (int -> String)
UserDto{id=7, login=anna, age=null, active=false}

Мини-тест-раннер на рефлексии

Напишите программу, которая запускает тесты класса, имя которого читается с консоли. Тестом считается public, не static метод без параметров, возвращающий void, имя которого начинается с test. Остальные методы игнорируются.

1. Каждый тест вызывается через invoke() на новом экземпляре класса.
2. Тест прошёл (PASSED), если метод завершился без исключения, и упал (FAILED), если бросил любое исключение, включая AssertionError. Для упавшего теста выведите исключение, которое бросил сам тестовый метод.
3. Тесты выполняются в алфавитном порядке, в конце печатается итог.

Тест-класс для проверки:

public class CalculatorTest {
    public void testAdd() {
        check(2 + 2 == 4, "2 + 2 должно быть 4");
    }

    public void testSubtract() {
        check(5 - 3 == 1, "5 - 3 должно быть 1");
    }

    public void testParse() {
        Integer.parseInt("abc");
    }

    public void helper() {            // не тест: имя не начинается с test
    }

    public void testWithParam(int x) { // не тест: есть параметр
    }

    public int testReturnsValue() {   // не тест: возвращает int
        return 1;
    }

    public static void testStatic() { // не тест: static
    }

    private void testPrivate() {      // не тест: не public
    }

    private static void check(boolean condition, String message) {
        if (!condition) {
            throw new AssertionError(message);
        }
    }
}

Ожидаемый вывод для ввода CalculatorTest:

PASSED testAdd
FAILED testParse: java.lang.NumberFormatException: For input string: "abc"
FAILED testSubtract: java.lang.AssertionError: 5 - 3 должно быть 1
Итого: 3, passed: 1, failed: 2

Документирование класса в Javadoc и генерация HTML

Класс банковского счёта задокументирован с ошибками: комментарий класса — обычный, имена в @param не совпадают с параметрами, в тексте есть знак < и дженерики, а описание withdraw() противоречит коду.

package com.example.bank;

import java.util.ArrayList;
import java.util.List;

/*
 * Банковский счёт
 */
public class Account {

    public static final double MIN_DEPOSIT = 10.0;

    private double balance;
    private final List<String> history = new ArrayList<>();

    /**
     * Создаёт счёт.
     * @param initial начальный баланс
     */
    public Account(double initialBalance) {
        this.balance = initialBalance;
    }

    public void deposit(double amount) {
        if (amount < MIN_DEPOSIT) {
            throw new IllegalArgumentException("Минимальная сумма: " + MIN_DEPOSIT);
        }
        balance += amount;
        history.add("+" + amount);
    }

    /**
     * Снимает деньги, если amount < balance.
     * @param sum сумма
     */
    public double withdraw(double amount) {
        if (amount > balance) {
            throw new IllegalStateException("Недостаточно средств");
        }
        balance -= amount;
        history.add("-" + amount);
        return balance;
    }

    /**
     * Возвращает List<String> операций.
     */
    public List<String> getHistory() {
        return List.copyOf(history);
    }
}

1. Положите класс в src/com/example/bank/Account.java и сгенерируйте документацию командой javadoc -d docs -sourcepath src -subpackages com.example -author -version -encoding UTF-8. Сохраните список ошибок и предупреждений doclint.
2. Превратите комментарий класса в Javadoc: краткое первое предложение, теги @author, @version, @since.
3. Задокументируйте константу MIN_DEPOSIT так, чтобы её значение подставлялось в текст тегом {@value}.
4. Исправьте @param у конструктора и withdraw(); добавьте @return и @throws везде, где они нужны, включая unchecked-исключения.
5. Напишите комментарий для deposit(), а в описании getHistory() сошлитесь на deposit() и withdraw() через {@link} и укажите, что возвращается неизменяемая копия.
6. Приведите описание withdraw() в соответствие с кодом (снять можно и весь баланс), а условия и дженерики оформите через {@code}.
7. Запустите ту же команду ещё раз: в выводе не должно остаться строк error и warning. Отключать проверку опцией -Xdoclint:none нельзя.
8. Откройте docs/index.html и найдите на странице Account автора, версию, значение 10.0 в описании константы и разделы Parameters, Returns и Throws.

Где решения ломаются без предупреждения

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