Java-Annotationstypen

In diesem Tutorial lernen wir anhand von Beispielen verschiedene Arten von Java-Annotationen kennen.

Java-Annotationen sind Metadaten (Daten zu Daten) für unseren Programmquellcode. Es gibt mehrere vordefinierte Anmerkungen, die von der Java SE bereitgestellt werden. Darüber hinaus können wir auch benutzerdefinierte Anmerkungen gemäß unseren Anforderungen erstellen.

Wenn Sie nicht wissen, was Anmerkungen sind, besuchen Sie das Tutorial für Java-Anmerkungen.

Diese Anmerkungen können wie folgt kategorisiert werden:

1. Vordefinierte Anmerkungen

  • @Deprecated
  • @Override
  • @SuppressWarnings
  • @SafeVarargs
  • @FunctionalInterface

2. Benutzerdefinierte Anmerkungen

3. Meta-Annotationen

  • @Retention
  • @Documented
  • @Target
  • @Inherited
  • @Repeatable

Vordefinierte Anmerkungsarten

1. @ Veraltet

Die @DeprecatedAnmerkung ist eine Markierungsanmerkung, die angibt, dass das Element (Klasse, Methode, Feld usw.) veraltet ist und durch ein neueres Element ersetzt wurde.

Die Syntax lautet:

 @Deprecated accessModifier returnType deprecatedMethodName() (… )

Wenn ein Programm das als veraltet deklarierte Element verwendet, generiert der Compiler eine Warnung.

Wir verwenden das Javadoc- @deprecatedTag, um das veraltete Element zu dokumentieren.

 /** * @deprecated * why it was deprecated */ @Deprecated accessModifier returnType deprecatedMethodName() (… )

Beispiel 1: @ Veraltetes Anmerkungsbeispiel

 class Main ( /** * @deprecated * This method is deprecated and has been replaced by newMethod() */ @Deprecated public static void deprecatedMethod() ( System.out.println("Deprecated method"); ) public static void main(String args()) ( deprecatedMethod(); ) )

Ausgabe

 Veraltete Methode

2. @Override

Die @OverrideAnmerkung gibt an, dass eine Methode einer Unterklasse die Methode der Oberklasse mit demselben Methodennamen, Rückgabetyp und derselben Parameterliste überschreibt.

Die Verwendung @Overridebeim Überschreiben einer Methode ist nicht obligatorisch . Wenn wir es jedoch verwenden, gibt der Compiler einen Fehler aus, wenn etwas falsch ist (z. B. ein falscher Parametertyp), während die Methode überschrieben wird.

Beispiel 2: @ Override-Annotationsbeispiel

 class Animal ( // overridden method public void display()( System.out.println("I am an animal"); ) ) class Dog extends Animal ( // overriding method @Override public void display()( System.out.println("I am a dog"); ) public void printMessage()( display(); ) ) class Main ( public static void main(String() args) ( Dog dog1 = new Dog(); dog1.printMessage(); ) )

Ausgabe 

 Ich bin ein Hund

In diesem Beispiel können wir durch Erstellen eines Objekts dog1 der Dog-Klasse dessen Methode printMessage () aufrufen, die dann die display()Anweisung ausführt .

Da display()in beiden Klassen definiert ist, überschreibt die Methode der Unterklasse Dog die Methode der Oberklasse Animal. Daher wird die display()der Unterklasse aufgerufen.

3. @SuppressWarnings

Wie der Name schon sagt, weist die @SuppressWarningsAnnotation den Compiler an, Warnungen zu unterdrücken, die während der Ausführung des Programms generiert werden.

Wir können die Art der zu unterdrückenden Warnungen angeben. Die Warnungen, die unterdrückt werden können, sind compilerspezifisch, es gibt jedoch zwei Kategorien von Warnungen: Veraltet und deaktiviert .

Um eine bestimmte Kategorie von Warnungen zu unterdrücken, verwenden wir:

 @SuppressWarnings("warningCategory")

Beispielsweise,

 @SuppressWarnings("deprecated")

Um mehrere Kategorien von Warnungen zu unterdrücken, verwenden wir:

 @SuppressWarnings(("warningCategory1", "warningCategory2"))

Beispielsweise,

 @SuppressWarnings(("deprecated", "unchecked"))

Category deprecatedweist den Compiler an, Warnungen zu unterdrücken, wenn ein veraltetes Element verwendet wird.

Die Kategorie uncheckedweist den Compiler an, Warnungen zu unterdrücken, wenn wir Rohtypen verwenden.

Und undefinierte Warnungen werden ignoriert. Beispielsweise,

 @SuppressWarnings("someundefinedwarning")

Beispiel 3: Beispiel für eine Annotation von @SuppressWarnings

 class Main ( @Deprecated public static void deprecatedMethod() ( System.out.println("Deprecated method"); ) @SuppressWarnings("deprecated") public static void main(String args()) ( Main depObj = new Main(); depObj. deprecatedMethod(); ) )

Ausgabe 

 Veraltete Methode

Hier deprecatedMethod()wurde es als veraltet markiert und gibt bei Verwendung Compiler-Warnungen aus. Durch die Verwendung der @SuppressWarnings("deprecated")Annotation können wir Compiler-Warnungen vermeiden.

4. @SafeVarargs

The @SafeVarargs annotation asserts that the annotated method or constructor does not perform unsafe operations on its varargs (variable number of arguments).

We can only use this annotation on methods or constructors that cannot be overridden. This is because the methods that override them might perform unsafe operations.

Before Java 9, we could use this annotation only on final or static methods because they cannot be overridden. We can now use this annotation for private methods as well.

Example 4: @SafeVarargs annotation example

 import java.util.*; class Main ( private void displayList(List… lists) ( for (List list : lists) ( System.out.println(list); ) ) public static void main(String args()) ( Main obj = new Main(); List universityList = Arrays.asList("Tribhuvan University", "Kathmandu University"); obj.displayList(universityList); List programmingLanguages = Arrays.asList("Java", "C"); obj.displayList(universityList, programmingLanguages); ) )

Warnings 

 Type safety: Potential heap pollution via varargs parameter lists Type safety: A generic array of List is created for a varargs parameter

Output

 Note: Main.java uses unchecked or unsafe operations. (Tribhuvan University, Kathmandu University) (Tribhuvan University, Kathmandu University) (Java, C)

Here, List … lists specifies a variable-length argument of type List. This means that the method displayList() can have zero or more arguments.

The above program compiles without errors but gives warnings when @SafeVarargs annotation isn't used.

When we use @SafeVarargs annotation in the above example,

 @SafeVarargs private void displayList(List… lists) (… )

We get the same output but without any warnings. Unchecked warnings are also suppressed when we use this annotation.

5. @FunctionalInterface

Java 8 first introduced this @FunctionalInterface annotation. This annotation indicates that the type declaration on which it is used is a functional interface. A functional interface can have only one abstract method.

Example 5: @FunctionalInterface annotation example

 @FunctionalInterface public interface MyFuncInterface( public void firstMethod(); // this is an abstract method )

If we add another abstract method, let's say

 @FunctionalInterface public interface MyFuncInterface( public void firstMethod(); // this is an abstract method public void secondMethod(); // this throws compile error )

Now, when we run the program, we will get the following warning:

 Unexpected @FunctionalInterface annotation @FunctionalInterface MyFuncInterface is not a functional interface multiple non-overriding abstract methods found in interface MyFuncInterface

It is not mandatory to use @FunctionalInterface annotation. The compiler will consider any interface that meets the functional interface definition as a functional interface.

We use this annotation to make sure that the functional interface has only one abstract method.

However, it can have any number of default and static methods because they have an implementation.

 @FunctionalInterface public interface MyFuncInterface( public void firstMethod(); // this is an abstract method default void secondMethod() (… ) default void thirdMethod() (… ) )

Custom Annotations

It is also possible to create our own custom annotations.

Its syntax is:

 (Access Specifier) @interface ( DataType () (default value); )

Here is what you need to know about custom annotation:

  • Annotations can be created by using @interface followed by the annotation name.
  • The annotation can have elements that look like methods but they do not have an implementation.
  • The default value is optional. The parameters cannot have a null value.
  • The return type of the method can be primitive, enum, string, class name or array of these types.

Example 6: Custom annotation example

 @interface MyCustomAnnotation ( String value() default "default value"; ) class Main ( @MyCustomAnnotation(value = "programiz") public void method1() ( System.out.println("Test method 1"); ) public static void main(String() args) throws Exception ( Main obj = new Main(); obj.method1(); ) )

Output 

 Test method 1

Meta Annotations

Meta-annotations are annotations that are applied to other annotations.

1. @Retention

The @Retention annotation specifies the level up to which the annotation will be available.

Its syntax is:

 @Retention(RetentionPolicy)

There are 3 types of retention policies:

  • RetentionPolicy.SOURCE - The annotation is available only at the source level and is ignored by the compiler.
  • RetentionPolicy.CLASS - The annotation is available to the compiler at compile-time, but is ignored by the Java Virtual Machine (JVM).
  • RetentionPolicy.RUNTIME - The annotation is available to the JVM.

For example,

 @Retention(RetentionPolicy.RUNTIME) public @interface MyCustomAnnotation(… )

2. @Documented

By default, custom annotations are not included in the official Java documentation. To include our annotation in the Javadoc documentation, we use the @Documented annotation.

For example,

 @Documented public @interface MyCustomAnnotation(… )

3. @Target

We can restrict an annotation to be applied to specific targets using the @Target annotation.

Its syntax is:

 @Target(ElementType)

The ElementType can have one of the following types:

Element Type Target
ElementType.ANNOTATION_TYPE Annotation type
ElementType.CONSTRUCTOR Constructors
ElementType.FIELD Fields
ElementType.LOCAL_VARIABLE Local variables
ElementType.METHOD Methods
ElementType.PACKAGE Package
ElementType.PARAMETER Parameter
ElementType.TYPE Any element of class

For example,

 @Target(ElementType.METHOD) public @interface MyCustomAnnotation(… )

In this example, we have restricted the use of this annotation to methods only.

Note: If the target type is not defined, the annotation can be used for any element.

4. @Inherited

By default, an annotation type cannot be inherited from a superclass. However, if we need to inherit an annotation from a superclass to a subclass, we use the @Inherited annotation.

Its syntax is:

 @Inherited

For example,

 @Inherited public @interface MyCustomAnnotation (… ) @MyCustomAnnotation public class ParentClass(… ) public class ChildClass extends ParentClass (… )

5. @Repeatable

An annotation that has been marked by @Repeatable can be applied multiple times to the same declaration.

 @Repeatable(Universities.class) public @interface University ( String name(); )

Der in der @RepeatableAnnotation definierte Wert ist die Container-Annotation. Die Container-Annotation hat einen variablen Wert des Array-Typs der obigen wiederholbaren Annotation. Hier Universitiessind die enthaltenen Annotationstypen.

 public @interface Universities ( University() value(); )

Jetzt kann die @UniversityAnmerkung mehrfach für dieselbe Deklaration verwendet werden.

 @University(name = "TU") @University(name = "KU") private String uniName;

Wenn wir die Anmerkungsdaten abrufen müssen, können wir die Reflection-API verwenden.

Zum Abrufen von Annotation Wert verwenden wir getAnnotationsByType()oder getAnnotations()Methode in dem Reflection - API definiert.

Interessante Beiträge...