База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / Java

Рефлексия в Java: достъп до полета и методи

В Java SE 21 `Field` и `Method` позволяват да четеш метаданни и анотации, да променяш полета и да извикваш методи. Намирането на частен член не дава достъп, а `setAccessible(true)` се подчинява на правилата на модулите.

Версия: Java SE 21

Синтаксис

Java SE 21 — java.lang.reflect
Field f = Owner.class.getDeclaredField("count");
Method m = Owner.class.getDeclaredMethod("add", int.class);
f.setAccessible(true);
m.setAccessible(true);

// Field instance methods
void setAccessible(boolean flag)
void set(Object receiver, Object value)
Object get(Object receiver)
String getName()
Class<?> getType()
void setInt(Object receiver, int value)
int getInt(Object receiver)
<T extends Annotation> T getAnnotation(Class<T> annotationType)

// Method instance methods
void setAccessible(boolean flag)
Object invoke(Object receiver, Object... args) throws IllegalAccessException, InvocationTargetException
boolean isAnnotationPresent(Class<? extends Annotation> annotationType)
String getName()

Field и Method от пакета java.lang.reflect представят членове на клас. getDeclaredField(name) търси поле по точното му име, а getDeclaredMethod(name, parameterTypes...) избира метод по точното му име и декларираните типове на параметрите в съответния ред. int.class и Integer.class избират различни претоварени варианти. JVM допуска в един и същ клас методи с еднакво име и еднакви типове на параметрите, но с различни типове на връщаната стойност. Ако типът на връщаната стойност на един от съвпадащите методи е по-специфичен от всички останали, getDeclaredMethod избира този метод; в противен случай избира произволен от съвпадащите методи. И двете търсения включват частни, но не и наследени членове. При липса на съвпадение се хвърля съответно NoSuchFieldException или NoSuchMethodException. Намирането на член не дава достъп до него.

Успешно извикване на setAccessible(true) върху Field или Method изключва проверките за достъп на езика Java за този обект за рефлексия, без да променя модификатора на члена. setAccessible(false) възстановява проверките. За частен член те могат да се изключат в рамките на един и същ модул. Между модули пакетът, в който членът е деклариран, трябва да е отворен за извикващия модул (opens); само експортиране (exports) не е достатъчно. Ако модулът не позволява изключването, setAccessible(true) хвърля InaccessibleObjectException, а trySetAccessible() връща false. Ако инсталиран мениджър на сигурността откаже заявката, и двата метода могат да хвърлят SecurityException.

Field.getName() връща простото име на полето, а getType() — декларирания му тип като Class<?>, например int.class. get(receiver) опакова примитивна стойност в обект, а set(receiver, value) разопакова съвместима стойност за поле от примитивен тип. getInt(receiver) връща int от поле от тип int или от поле с примитивен тип, който може да се разшири до int. setInt(receiver, value) записва int в поле от тип int или от по-широк примитивен тип. Тези операции не извършват стесняващи преобразувания. Изключването на проверките не позволява запис в полета static final или в полета final на записи (records) и скрити класове.

Method.getName() връща простото име на метода. invoke(receiver, args...) извиква вече избрания метод: при нужда разопакова аргументите за примитивни параметри и може да разшири типовете им. Опакова примитивния резултат и връща null за void. При четене, запис и извикване подай съвместим екземпляр; за член static целевият обект се игнорира и може да е null. null вместо изисквания екземпляр води до NullPointerException, а несъвместим целеви обект, стойност или списък с аргументи — до IllegalArgumentException. Отказът за достъп при операцията води до IllegalAccessException. Изключение от извикания метод се обвива в InvocationTargetException; вземи го чрез getCause().

Field.getAnnotation(Label.class) връща анотацията на декларацията на полето или null. Method.isAnnotationPresent(Label.class) проверява дали анотацията присъства в декларацията на метода, без да я връща. Дефинирай типа на анотацията с @Retention(RetentionPolicy.RUNTIME), за да е видим чрез рефлексия. Четенето на тези метаданни не изисква изключване на проверките за достъп.

Примери

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.reflect.Field;
import java.lang.reflect.Method;

@Retention(RetentionPolicy.RUNTIME)
@interface Label {
    String value();
}

final class Owner {
    @Label("items")
    private int count = 1;

    @Label("operation")
    private int add(int delta) {
        return count + delta;
    }
}

public class ReflectionMembersDemo {
    public static void main(String[] args) throws ReflectiveOperationException {
        Owner owner = new Owner();
        Field field = Owner.class.getDeclaredField("count");
        Method method = Owner.class.getDeclaredMethod("add", int.class);

        try {
            field.get(owner);
            throw new AssertionError("Private field was readable before override");
        } catch (IllegalAccessException expected) {
            System.out.println("field access denied");
        }
        try {
            method.invoke(owner, 5);
            throw new AssertionError("Private method was callable before override");
        } catch (IllegalAccessException expected) {
            System.out.println("method access denied");
        }

        field.setAccessible(true);
        method.setAccessible(true);

        System.out.println(field.getName() + ":" + field.getType().getName()
                + " label=" + field.getAnnotation(Label.class).value());
        field.set(owner, Integer.valueOf(7));
        System.out.println("get=" + field.get(owner));
        field.setInt(owner, 11);
        System.out.println("getInt=" + field.getInt(owner));
        System.out.println(method.getName() + " annotated="
                + method.isAnnotationPresent(Label.class));
        System.out.println("invoke=" + method.invoke(owner, 5));
    }
}

Резултат

field access denied
method access denied
count:int label=items
get=7
getInt=11
add annotated=true
invoke=16

`Owner` и `ReflectionMembersDemo` са отделни класове от най-високо ниво в един и същ модул. Първото четене и първото извикване са отказани. След изключване на проверките примерът записва `7` и `11`, а `add(5)` връща `16`, без да променя `count`.

Свързани уроци

  • Java · Урок 54 · Напреднало · Версия: 2

Източници