CKTIS / Java
Refleksja w Javie: dostęp do pól i metod
W Java SE 21 obiekty `Field` i `Method` pozwalają odczytywać metadane i adnotacje, zmieniać pola oraz wywoływać metody. Wyszukanie prywatnej składowej nie daje jeszcze dostępu, a `setAccessible(true)` podlega regułom modułów.
Wersja: Java SE 21
Składnia
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()Klasy Field i Method z pakietu java.lang.reflect reprezentują składowe klasy. getDeclaredField(name) szuka pola o dokładnie tej nazwie, a getDeclaredMethod(name, parameterTypes...) wybiera metodę po dokładnej nazwie i zadeklarowanych typach parametrów w ich kolejności. int.class i Integer.class oznaczają inne przeciążenia. JVM dopuszcza w jednej klasie metody o tej samej nazwie i tych samych typach parametrów, ale różnych typach zwracanych. Jeśli typ zwracany jednej z pasujących metod jest bardziej szczegółowy niż typy zwracane wszystkich pozostałych, getDeclaredMethod wybiera tę metodę; w przeciwnym razie wybiera dowolną z pasujących metod. Obie operacje obejmują składowe prywatne, ale nie odziedziczone; brak dopasowania powoduje odpowiednio NoSuchFieldException lub NoSuchMethodException. Wyszukanie składowej nie daje do niej dostępu.
Na obiekcie Field lub Method udane setAccessible(true) wyłącza kontrole dostępu języka Java dla tego obiektu refleksji, nie zmieniając modyfikatora składowej. setAccessible(false) przywraca kontrole. W tym samym module można wyłączyć te kontrole dla składowej prywatnej; w innym module pakiet musi być otwarty dla modułu wywołującego (opens), a samo exports nie wystarcza. Jeśli moduł uniemożliwia dostęp, setAccessible(true) zgłasza InaccessibleObjectException, a trySetAccessible() zwraca false. Jeżeli zainstalowany menedżer zabezpieczeń odrzuci żądanie, obie metody mogą zgłosić SecurityException.
Field.getName() zwraca prostą nazwę pola, a getType() jego zadeklarowany typ jako Class<?>, np. int.class. get(receiver) opakowuje wartość typu prostego, a set(receiver, value) dla pola typu prostego rozpakowuje zgodną wartość. getInt(receiver) zwraca int z pola typu int lub pola typu prostego poszerzalnego do int. setInt(receiver, value) zapisuje int w polu typu int lub szerszego typu prostego. Te operacje nie wykonują konwersji zawężających. Wyłączenie kontroli nie umożliwia zapisu do pól static final ani do pól final w rekordach i klasach ukrytych.
Method.getName() zwraca prostą nazwę metody. invoke(receiver, args...) wywołuje już wybraną metodę: w razie potrzeby rozpakowuje argumenty typu prostego i może poszerzać ich typ. Opakowuje wynik typu prostego, a dla void zwraca null. Dla odczytu, zapisu i wywołania podaj zgodną instancję; dla składowej static obiekt jest ignorowany i można przekazać null. null zamiast wymaganej instancji powoduje NullPointerException, a niezgodny obiekt, wartość lub argumenty — IllegalArgumentException. Odmowa dostępu podczas operacji daje IllegalAccessException. Wyjątek z wywołanej metody jest opakowany w InvocationTargetException; odczytaj go przez getCause().
Field.getAnnotation(Label.class) zwraca adnotację deklaracji pola albo null. Method.isAnnotationPresent(Label.class) sprawdza obecność adnotacji deklaracji metody bez jej zwracania. Zdefiniuj typ adnotacji z @Retention(RetentionPolicy.RUNTIME), aby był dostępny przez refleksję. Do odczytu tych metadanych nie trzeba wyłączać kontroli dostępu.
Przykłady
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));
}
}Wynik
field access denied method access denied count:int label=items get=7 getInt=11 add annotated=true invoke=16
`Owner` i `ReflectionMembersDemo` to osobne klasy najwyższego poziomu w tym samym module. Najpierw odczyt i wywołanie są odrzucane. Po wyłączeniu kontroli przykład zapisuje `7` i `11`, a `add(5)` zwraca `16` bez zmiany pola `count`.
Powiązane lekcje
- Java · Lekcja 54 · Zaawansowany · Wersja: 2