Baza znanjaIzpitno središče
SLSlovenščina
Izberi jezik13

CKTIS / Java

Refleksija v Javi: dostop do polj in metod

V Java SE 21 objekta `Field` in `Method` omogočata pregled metapodatkov in anotacij, spreminjanje polj in klicanje metod. Najdba zasebnega člana še ne dovoli dostopa, za `setAccessible(true)` pa veljajo pravila modulov.

Različica: Java SE 21

Sintaksa

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 in Method iz paketa java.lang.reflect predstavljata člane razreda. getDeclaredField(name) poišče polje po natančnem imenu; getDeclaredMethod(name, parameterTypes...) izbere metodo po natančnem imenu in deklariranih tipih parametrov v njihovem vrstnem redu. int.class in Integer.class izbereta različni preobremenitvi. JVM v istem razredu dovoljuje metode z enakim imenom in enakimi tipi parametrov, vendar z različnimi povratnimi tipi. Če je povratni tip ene od ujemajočih se metod bolj specifičen od vseh drugih, getDeclaredMethod izbere to metodo; sicer izbere poljubno ujemajočo se metodo. Obe iskanji vključujeta zasebne člane, ne pa podedovanih. Če ni zadetka, se sproži NoSuchFieldException oziroma NoSuchMethodException. Najdba člana še ne omogoča dostopa.

Uspešen setAccessible(true) na objektu Field ali Method izključi preverjanja dostopa jezika Java za ta refleksijski objekt, ne da bi spremenil modifikator člana. setAccessible(false) preverjanja znova vključi. Za zasebnega člana jih lahko izključiš znotraj istega modula. Med moduli mora biti paket, v katerem je član deklariran, odprt kličočemu modulu (opens); sam izvoz (exports) ne zadošča. Če modul tega ne dovoli, setAccessible(true) sproži InaccessibleObjectException, trySetAccessible() pa vrne false. Če nameščeni upravljalnik varnosti zahtevo zavrne, lahko obe metodi sprožita SecurityException.

Field.getName() vrne preprosto ime polja, getType() pa deklarirani tip kot Class<?>, na primer int.class. get(receiver) ovije primitivno vrednost v objekt; set(receiver, value) za primitivno polje odvije združljivo vrednost iz objekta. getInt(receiver) vrne int iz polja tipa int ali iz polja primitivnega tipa, ki ga je mogoče razširiti v int. setInt(receiver, value) zapiše int v polje tipa int ali širšega primitivnega tipa. Te operacije ne ožijo tipov. Izključitev preverjanj ne omogoča pisanja v polja static final ali v polja final zapisov (records) in skritih razredov.

Method.getName() vrne preprosto ime metode. invoke(receiver, args...) pokliče že izbrano metodo: po potrebi odvije primitivne argumente in lahko razširi njihov tip. Primitivni rezultat ovije, za void pa vrne null. Pri branju, pisanju in klicu podaj združljiv primerek; pri članu static se ciljni objekt prezre in je lahko null. Vrednost null namesto zahtevanega primerka sproži NullPointerException, nezdružljiv ciljni objekt, vrednost ali seznam argumentov pa IllegalArgumentException. Zavrnitev dostopa pri operaciji sproži IllegalAccessException. Izjemo ciljne metode ovije InvocationTargetException; razkrije jo getCause().

Field.getAnnotation(Label.class) vrne anotacijo deklaracije polja ali null. Method.isAnnotationPresent(Label.class) preveri prisotnost anotacije deklaracije metode, ne da bi jo vrnil. Tip anotacije opredeli z @Retention(RetentionPolicy.RUNTIME), da bo viden z refleksijo. Branje teh metapodatkov ne zahteva izključitve preverjanj dostopa.

Primeri

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

Rezultat

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

`Owner` in `ReflectionMembersDemo` sta ločena vrhnja razreda v istem modulu. Prvo branje in prvi klic sta zavrnjena. Po izključitvi preverjanj primer zapiše `7` in `11`; `add(5)` vrne `16`, ne da bi spremenil `count`.

Povezane lekcije

  • Java · Lekcija 54 · Napredna · Različica: 2

Viri