CKTIS / Java
Réflexion Java : accéder aux champs et aux méthodes
Dans Java SE 21, `Field` et `Method` permettent d’inspecter les métadonnées et les annotations, de modifier des champs et d’appeler des méthodes. Trouver un membre privé ne donne pas le droit d’y accéder, et `setAccessible(true)` reste soumis aux règles des modules.
Version : 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()Dans java.lang.reflect, Field et Method représentent des membres d’une classe. getDeclaredField(name) recherche le nom exact du champ ; getDeclaredMethod(name, parameterTypes...) sélectionne la méthode selon son nom exact et les types de paramètres déclarés, dans l’ordre. int.class et Integer.class sélectionnent des surcharges différentes. La JVM autorise, dans une même classe, des méthodes de même nom et de mêmes types de paramètres, mais de types de retour différents. Si le type de retour d’une méthode correspondante est plus spécifique que tous les autres, getDeclaredMethod choisit cette méthode ; sinon, elle choisit arbitrairement l’une des méthodes correspondantes. Ces recherches incluent les membres privés, mais pas les membres hérités. Sans correspondance, elles lèvent respectivement NoSuchFieldException et NoSuchMethodException. Trouver un membre n’autorise pas son accès.
Sur un Field ou un Method, si setAccessible(true) réussit, les contrôles d’accès du langage Java sont désactivés pour cet objet de réflexion, sans modifier le membre. setAccessible(false) rétablit ces contrôles. Pour un membre privé, cette désactivation est possible dans le même module ; entre modules, le paquetage déclarant doit être ouvert au module appelant (opens), et non simplement exporté (exports). Si le module bloque l’opération, setAccessible(true) lève InaccessibleObjectException, tandis que trySetAccessible() renvoie false. Si un gestionnaire de sécurité installé refuse la demande, les deux méthodes peuvent lever SecurityException.
Field.getName() renvoie le nom simple du champ, et getType() son type déclaré sous forme de Class<?>, par exemple int.class. get(receiver) encapsule une valeur primitive dans son objet enveloppe ; set(receiver, value) extrait la valeur d’un objet enveloppe compatible si le champ est primitif. getInt(receiver) renvoie un int lu dans un champ int ou dans un champ de type primitif convertible par élargissement vers int. setInt(receiver, value) écrit un int dans un champ int ou de type primitif plus large. Ces opérations ne font pas de conversion rétrécissante. Désactiver les contrôles ne permet pas d’écrire dans des champs static final ni dans des champs final de records ou de classes cachées.
Method.getName() renvoie le nom simple de la méthode. invoke(receiver, args...) appelle la méthode déjà sélectionnée : pour les paramètres primitifs, il peut déballer et élargir les arguments. Il encapsule un résultat primitif et renvoie null pour void. En lecture, en écriture et à l’appel, fournissez une instance compatible ; pour un membre static, le receveur est ignoré et peut être null. Un receveur null pour un membre d’instance provoque NullPointerException. Un receveur, une valeur ou une liste d’arguments incompatible provoque IllegalArgumentException. Un accès refusé lors de l’opération provoque IllegalAccessException. Si la méthode cible lève une exception, InvocationTargetException l’enveloppe ; récupérez-la avec getCause().
Field.getAnnotation(Label.class) renvoie l’annotation de déclaration du champ ou null. Method.isAnnotationPresent(Label.class) teste la présence de l’annotation de déclaration de la méthode sans la renvoyer. Déclarez le type d’annotation avec @Retention(RetentionPolicy.RUNTIME) pour le rendre visible par réflexion. Ces consultations de métadonnées n’exigent pas de désactiver les contrôles d’accès.
Exemples
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));
}
}Résultat
field access denied method access denied count:int label=items get=7 getInt=11 add annotated=true invoke=16
`Owner` et `ReflectionMembersDemo` sont deux classes de premier niveau du même module. La première lecture et le premier appel sont refusés. Après désactivation des contrôles, l’exemple écrit `7` puis `11`, et `add(5)` renvoie `16` sans modifier `count`.
Leçons associées
- Java · Leçon 54 · Avancé · Version : 2