CKTIS / Java
Анотации в Java: цели, съхранение, повторение и рефлексия
В Java SE 21 декларацията на анотация определя данните ѝ, къде може да се постави и дали е видима по време на изпълнение. Научи се да четеш метаданни чрез рефлексия, да различаваш декларирани от наследени анотации и да ограничаваш потискането на предупреждения.
Версия: Java SE 21
Синтаксис
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.FIELD, ElementType.CONSTRUCTOR})
@interface Marker {}
@Target({ElementType.FIELD, ElementType.METHOD})
@interface MemberMarker {}
@Inherited
@Repeatable(Tags.class)
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@interface Tag { String value(); }
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@interface Tags { Tag[] value(); }
Consumer<? super Integer> subscriber = new Consumer<Number>() {
@Override public void accept(Number value) { System.out.println(value); }
};
Class<?> type = String.class;
Object payload = List.of("ok");
@SuppressWarnings("unchecked")
List<String> names = (List<String>) payload;@interface декларира анотационен интерфейс. String value(); определя елемент, а @Tag("core") е съкратено от @Tag(value = "core"). Метаанотацията Target от java.lang.annotation определя допустимите места. @Target(ElementType.TYPE/FIELD/CONSTRUCTOR) е описателно съкращение, а не синтаксис на Java: напиши @Target({ElementType.TYPE, ElementType.FIELD, ElementType.CONSTRUCTOR}). ElementType.TYPE обхваща декларации на класове и интерфейси, а не употреби на тип (TYPE_USE). ElementType.FIELD/METHOD обозначава две константи: ElementType.FIELD за полета и ElementType.METHOD за методи. Конструкторите имат отделна цел.
Retention определя срока на съхранение: SOURCE не се записва във файла на класа, CLASS е стойността по подразбиране и се записва, но не е достъпна чрез рефлексия по време на изпълнение, а @Retention(RetentionPolicy.RUNTIME) прави анотациите от примера достъпни чрез рефлексия. Изключение са декларациите на локални променливи и параметри на ламбда изрази: техните декларативни анотации не се записват във файла на класа. Класовият литерал Base.class дава обект Class<Base>; Class<?> го приема, без да разкрива конкретния типов аргумент. ConfigKey, Init, Component и Inject са потребителски метаданни. Без код, който ги обработва, те не конфигурират, не извикват и не инжектират нищо.
@Repeatable(Tags.class) позволява няколко @Tag на едно място. Компилаторът групира повторенията в контейнер с Tag[] value(); останалите елементи на контейнера трябва да имат стойности по подразбиране. Контейнерът трябва да има поне същия срок на съхранение и съвместими цели; в примера целите са еднакви. Ако Tag има @Inherited, контейнерът също трябва да я има. getAnnotationsByType(Tag.class) извлича анотациите от контейнера и благодарение на Inherited търси в базовите класове, ако класът няма собствени етикети. Не обединява етикети от различни нива, не претърсва интерфейси и не наследява анотации на методи или полета. getDeclaredAnnotationsByType също извлича анотациите от контейнера, но не търси в базовите класове; getAnnotation не разопакова контейнера.
new Consumer<Number>() { ... } декларира анонимен клас и създава негова инстанция. С @Override компилаторът проверява дали accept(Number) реализира метода на интерфейса, вместо по погрешка да го претовари. Java 21 допуска и сигнатури, еквивалентни за предефиниране на тези на публични методи на Object, както и изрично декларирани методи за достъп до компоненти на record.
Consumer<? super Integer> приема консуматор на Integer или негов надтип, например Number или Object, и позволява да му се подаде Integer. Неограниченият заместващ символ ?, например в Consumer<?>, оставя типовия аргумент неизвестен и не позволява да се подаде Integer, различен от null. @SuppressWarnings("unchecked") потиска предупреждението на компилатора, но не проверява типовете на елементите на списъка и не предотвратява ClassCastException. Избягвай ненужните преобразувания на типове; ако преобразуването е обосновано, потисни предупреждението върху най-тясната декларация, за която това действа.
Примери
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.List;
import java.util.function.Consumer;
public class Demo {
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@interface ConfigKey { String value(); }
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@interface Init {}
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@interface Component {}
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.CONSTRUCTOR})
@interface Inject {}
@Inherited
@Repeatable(Tags.class)
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@interface Tag { String value(); }
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@interface Tags { Tag[] value(); }
@Component
@Tag("core")
@Tag("fast")
static class Base {
@ConfigKey("port") final int port = 8080;
boolean started;
@Inject Base() {}
@Init void start() { started = true; }
}
static class Child extends Base {}
static void publish(Consumer<? super Integer> subscriber) {
subscriber.accept(21);
}
public static void main(String[] args) throws ReflectiveOperationException {
Class<?> type = Base.class;
Base service = new Base();
var field = type.getDeclaredField("port");
System.out.println("Config: " + field.getAnnotation(ConfigKey.class).value());
boolean before = service.started;
var method = type.getDeclaredMethod("start");
if (method.isAnnotationPresent(Init.class)) {
method.invoke(service);
}
System.out.println("Started: " + before + " -> " + service.started);
System.out.println("Component/Inject: " + type.isAnnotationPresent(Component.class)
+ "/" + type.getDeclaredConstructor().isAnnotationPresent(Inject.class));
Tag[] tags = Child.class.getAnnotationsByType(Tag.class);
int declared = Child.class.getDeclaredAnnotationsByType(Tag.class).length;
System.out.println("Tags: " + tags[0].value() + ", " + tags[1].value()
+ "; declared: " + declared);
publish(new Consumer<Number>() {
@Override public void accept(Number value) {
System.out.println("Subscriber: " + value);
}
});
Object payload = List.of("ok"); // This list is known here to contain only strings.
@SuppressWarnings("unchecked")
List<String> names = (List<String>) payload;
System.out.println("Cast: " + names.get(0));
}
}Резултат
Config: port Started: false -> true Component/Inject: true/true Tags: core, fast; declared: 0 Subscriber: 21 Cast: ok
`started` се променя едва при изричното извикване на `method.invoke(service)`. `Child` прочита два етикета от `Base`, въпреки че не декларира нито един. Преобразуването на типа е обосновано от известния произход на списъка от `List.of("ok")`, а не от `@SuppressWarnings`.
Свързани уроци
- Java · Урок 44 · Напреднало · Версия: 2
- Java · Урок 54 · Напреднало · Версия: 2
- Java · Урок 58 · Напреднало · Версия: 2
- Java · Урок 59 · Напреднало · Версия: 2
Източници
- Java SE 21 Language Specification §9.6 — Annotation Interfaces and Predefined Annotation Interfaces
- Java SE 21 Language Specification §9.7.5 — Multiple Annotations of the Same Interface
- Java SE 21 API — ElementType
- Java SE 21 API — RetentionPolicy
- Java SE 21 API — AnnotatedElement
- Java SE 21 API — SuppressWarnings
- Java SE 21 Language Specification §4.5.1 — Type Arguments of Parameterized Types
- Java SE 21 Language Specification §15.8.2 — Class Literals
- Java SE 21 Language Specification §15.9.5 — Anonymous Class Declarations