CKTIS / Java
Reflectie in Java: toegang tot velden en methoden
In Java SE 21 kun je met `Field` en `Method` metadata en annotaties opvragen, velden wijzigen en methoden aanroepen. Een privélid vinden geeft nog geen toegang, en `setAccessible(true)` is gebonden aan moduleregels.
Versie: 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 en Method uit java.lang.reflect vertegenwoordigen leden van een klasse. getDeclaredField(name) zoekt op de exacte veldnaam; getDeclaredMethod(name, parameterTypes...) selecteert op de exacte methodenaam en de gedeclareerde parametertypen in hun volgorde. int.class en Integer.class selecteren verschillende overloads. De JVM staat in dezelfde klasse methoden toe met dezelfde naam en parametertypen, maar met verschillende retourtypen. Als het retourtype van één overeenkomende methode specifieker is dan alle andere, kiest getDeclaredMethod die methode; anders kiest het willekeurig een van de overeenkomende methoden. Beide zoekacties omvatten privéleden, maar geen geërfde leden. Zonder treffer krijg je respectievelijk NoSuchFieldException of NoSuchMethodException. Een lid vinden geeft nog geen toegang.
Als setAccessible(true) op een Field of Method slaagt, schakelt het de toegangscontroles van de Java-taal uit voor dat reflectieobject, zonder de modifier van het lid te wijzigen. setAccessible(false) schakelt de controles weer in. Voor een privélid kan dit binnen dezelfde module. Tussen modules moet het pakket waarin het lid is gedeclareerd openstaan voor de aanroepende module (opens); exporteren (exports) is niet genoeg. Als de module dit verhindert, gooit setAccessible(true) een InaccessibleObjectException, terwijl trySetAccessible() false teruggeeft. Als een geïnstalleerde securitymanager het verzoek weigert, kunnen beide methoden SecurityException gooien.
Field.getName() geeft de eenvoudige veldnaam en getType() het gedeclareerde type als Class<?>, bijvoorbeeld int.class. get(receiver) verpakt een primitieve waarde in een wrapperobject; set(receiver, value) pakt een compatibele waarde uit voor een primitief veld. getInt(receiver) leest een int uit een int-veld of uit een primitief veld waarvan het type naar int kan worden verbreed. setInt(receiver, value) schrijft een int naar een int-veld of een veld van een breder primitief type. Deze bewerkingen versmallen geen waarden. Het uitschakelen van controles maakt schrijven naar static final-velden of final-velden in records of verborgen klassen niet mogelijk.
Method.getName() geeft de eenvoudige methodenaam. invoke(receiver, args...) roept de al geselecteerde methode aan: het pakt waar nodig primitieve argumentwaarden uit en kan hun type verbreden. Het verpakt een primitief resultaat en geeft null terug voor void. Geef voor lezen, schrijven en aanroepen een compatibele instantie op; voor een static lid wordt het doelobject genegeerd en mag het null zijn. null als doelobject voor een instantielid veroorzaakt NullPointerException; een ongeschikt doelobject, een ongeschikte waarde of een ongeschikte argumentenlijst veroorzaakt IllegalArgumentException. Geweigerde toegang tijdens de bewerking geeft IllegalAccessException. Gooit de doelmethode een uitzondering, dan verpakt InvocationTargetException die; vraag ze op met getCause().
Field.getAnnotation(Label.class) geeft de declaratieannotatie van het veld terug, of null. Method.isAnnotationPresent(Label.class) controleert of de declaratieannotatie op de methode aanwezig is zonder haar terug te geven. Definieer het annotatietype met @Retention(RetentionPolicy.RUNTIME) zodat het via reflectie zichtbaar is. Voor deze metadatavragen hoef je de toegangscontroles niet uit te schakelen.
Voorbeelden
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));
}
}Resultaat
field access denied method access denied count:int label=items get=7 getInt=11 add annotated=true invoke=16
`Owner` en `ReflectionMembersDemo` zijn afzonderlijke top-levelklassen in dezelfde module. De eerste leesbewerking en aanroep worden geweigerd. Na het uitschakelen van de controles schrijft het voorbeeld `7` en `11`; `add(5)` geeft `16` terug zonder `count` te wijzigen.
Gerelateerde lessen
- Java · Les 54 · Gevorderd · Versie: 2