Znalostná bázaCentrum skúšok
SKSlovenčina
Vybrať jazyk13

CKTIS / Java

Reflexia v Jave: prístup k poliam a metódam

V Java SE 21 umožňujú `Field` a `Method` čítať metadáta a anotácie, meniť hodnoty polí a volať metódy. Nájdenie súkromného člena neudeľuje prístup a `setAccessible(true)` podlieha pravidlám modulov.

Verzia: Java SE 21

Syntax

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íka java.lang.reflect reprezentujú členy triedy. getDeclaredField(name) hľadá pole podľa presného názvu; getDeclaredMethod(name, parameterTypes...) vyberá metódu podľa presného názvu a deklarovaných typov parametrov v danom poradí. int.class a Integer.class vyberajú rôzne preťaženia. JVM umožňuje v tej istej triede metódy s rovnakým názvom a rovnakými typmi parametrov, ale s rôznymi návratovými typmi. Ak je návratový typ jednej zo zodpovedajúcich metód špecifickejší než všetky ostatné, getDeclaredMethod vyberie túto metódu; inak vyberie ľubovoľnú zo zodpovedajúcich metód. Obe vyhľadávania zahŕňajú súkromné, ale nie zdedené členy. Ak sa člen nenájde, vyvolá sa NoSuchFieldException, respektíve NoSuchMethodException. Nájdenie člena neudeľuje prístup.

Úspešné setAccessible(true) na objekte Field alebo Method potlačí kontroly prístupu jazyka Java pre tento objekt reflexie bez zmeny modifikátora člena. setAccessible(false) kontroly obnoví. Pre súkromný člen ich možno potlačiť v rámci toho istého modulu. Medzi modulmi musí byť balík, v ktorom je člen deklarovaný, otvorený volajúcemu modulu (opens); samotný export (exports) nestačí. Ak to modul neumožní, setAccessible(true) vyvolá InaccessibleObjectException, zatiaľ čo trySetAccessible() vráti false. Ak požiadavku zamietne nainštalovaný správca zabezpečenia, obe metódy môžu vyvolať SecurityException.

Field.getName() vráti jednoduchý názov poľa a getType() jeho deklarovaný typ ako Class<?>, napríklad int.class. get(receiver) zabalí primitívnu hodnotu do objektu; set(receiver, value) pri zápise do poľa primitívneho typu rozbalí kompatibilnú hodnotu. getInt(receiver) vráti int z poľa typu int alebo z poľa primitívneho typu rozšíriteľného na int. setInt(receiver, value) zapíše int do poľa typu int alebo širšieho primitívneho typu. Tieto operácie nevykonávajú zužujúce konverzie. Potlačenie kontrol neumožní zapisovať do polí static final ani do polí final v záznamoch (records) alebo skrytých triedach.

Method.getName() vráti jednoduchý názov metódy. invoke(receiver, args...) zavolá už vybranú metódu: podľa potreby rozbalí primitívne argumenty a môže rozšíriť ich typ. Primitívny výsledok zabalí a pre void vráti null. Pri čítaní, zápise aj volaní použi kompatibilnú inštanciu; pri člene static sa cieľový objekt ignoruje a môže byť null. Hodnota null namiesto požadovanej inštancie spôsobí NullPointerException. Nekompatibilný cieľový objekt, hodnota alebo zoznam argumentov spôsobí IllegalArgumentException. Odmietnutie prístupu pri operácii vyvolá IllegalAccessException. Výnimku z cieľovej metódy zabalí InvocationTargetException; získaš ju volaním getCause().

Field.getAnnotation(Label.class) vráti anotáciu deklarácie poľa alebo null. Method.isAnnotationPresent(Label.class) overí prítomnosť anotácie deklarácie metódy bez jej vrátenia. Typ anotácie definuj pomocou @Retention(RetentionPolicy.RUNTIME), aby bol dostupný cez reflexiu. Čítanie týchto metadát nevyžaduje potlačenie kontrol prístupu.

Prí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ýsledok

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

`Owner` a `ReflectionMembersDemo` sú samostatné triedy najvyššej úrovne v tom istom module. Prvé čítanie aj volanie sú odmietnuté. Po potlačení kontrol príklad zapíše `7` a `11`; `add(5)` vráti `16` bez zmeny `count`.

Súvisiace lekcie

  • Java · Lekcia 54 · Pokročilá · Verzia: 2

Zdroje