Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / Java

Reflexe v Javě: přístup k polím a metodám

V Java SE 21 umožňují `Field` a `Method` číst metadata a anotace, měnit hodnoty polí a volat metody. Nalezení soukromého členu ještě neumožňuje přístup a `setAccessible(true)` se řídí pravidly modulů.

Verze: Java SE 21

Syntaxe

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 a Method z balíčku java.lang.reflect představují členy třídy. getDeclaredField(name) vyhledá pole podle přesného názvu; getDeclaredMethod(name, parameterTypes...) vybere metodu podle přesného názvu a deklarovaných typů parametrů v daném pořadí. int.class a Integer.class označují různá přetížení. JVM umožňuje v téže třídě metody se stejným názvem a stejnými typy parametrů, ale s různými návratovými typy. Pokud je návratový typ jedné z odpovídajících metod specifičtější než všechny ostatní, getDeclaredMethod vybere tuto metodu; jinak vybere libovolnou z odpovídajících metod. Obě vyhledávání zahrnují soukromé, ale ne zděděné členy. Pokud se člen nenajde, nastane NoSuchFieldException, respektive NoSuchMethodException. Nalezení členu neumožňuje přístup.

Úspěšné setAccessible(true) na objektu Field nebo Method potlačí kontroly přístupu jazyka Java pro tento objekt reflexe, ale nezmění modifikátor členu. setAccessible(false) kontroly obnoví. Pro soukromý člen je lze potlačit uvnitř téhož modulu. Mezi moduly musí být balíček deklarující člena otevřen volajícímu modulu (opens); pouhý export (exports) nestačí. Pokud modul potlačení brání, setAccessible(true) vyvolá InaccessibleObjectException, zatímco trySetAccessible() vrátí false. Zamítne-li požadavek nainstalovaný správce zabezpečení, obě metody mohou vyvolat SecurityException.

Field.getName() vrací jednoduchý název pole a getType() jeho deklarovaný typ jako Class<?>, například int.class. get(receiver) zabalí primitivní hodnotu do objektu; set(receiver, value) při zápisu do primitivního pole kompatibilní hodnotu rozbalí. getInt(receiver) vrací int z pole typu int nebo z pole primitivního typu rozšiřitelného na int. setInt(receiver, value) zapisuje int do pole typu int nebo širšího primitivního typu. Zužující převody se neprovádějí. Potlačení kontrol neumožňuje zapisovat do polí static final ani do polí final v záznamech (records) či skrytých třídách.

Method.getName() vrací jednoduchý název metody. invoke(receiver, args...) zavolá již vybranou metodu: podle potřeby rozbalí primitivní argumenty a může rozšířit jejich typ. Primitivní výsledek zabalí a pro void vrátí null. Pro čtení, zápis i volání předej kompatibilní instanci; u členu static se cílový objekt ignoruje a smí být null. Hodnota null místo požadované instance způsobí NullPointerException. Nekompatibilní cílový objekt, hodnota nebo seznam argumentů způsobí IllegalArgumentException. Odepření přístupu při operaci vyvolá IllegalAccessException. Výjimka vyvolaná cílovou metodou je zabalena do InvocationTargetException; získáš ji voláním getCause().

Field.getAnnotation(Label.class) vrátí anotaci deklarace pole nebo null. Method.isAnnotationPresent(Label.class) ověří přítomnost anotace deklarace metody, aniž ji vrátí. Typ anotace definuj pomocí @Retention(RetentionPolicy.RUNTIME), aby byl viditelný přes reflexi. Pro čtení těchto metadat není třeba potlačovat kontroly přístupu.

Příklady

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));
    }
}

Výsledek

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

`Owner` a `ReflectionMembersDemo` jsou samostatné třídy nejvyšší úrovně v témže modulu. První čtení i volání jsou odmítnuty. Po potlačení kontrol příklad zapíše `7` a `11`; `add(5)` vrátí `16` a `count` nezmění.

Související lekce

  • Java · Lekce 54 · Pokročilá · Verze: 2

Zdroje