Types d'annotations Java

Dans ce didacticiel, nous allons découvrir les différents types d'annotations Java à l'aide d'exemples.

Les annotations Java sont des métadonnées (données sur les données) pour le code source de notre programme. Il existe plusieurs annotations prédéfinies fournies par Java SE. De plus, nous pouvons également créer des annotations personnalisées selon nos besoins.

Si vous ne savez pas ce que sont les annotations, consultez le didacticiel sur les annotations Java.

Ces annotations peuvent être classées comme suit:

1. Annotations prédéfinies

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

2. Annotations personnalisées

3. Méta-annotations

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

Types d'annotations prédéfinis

1. @Deprecated

L' @Deprecatedannotation est une annotation de marqueur qui indique que l'élément (classe, méthode, champ, etc.) est obsolète et a été remplacé par un élément plus récent.

Sa syntaxe est:

 @Deprecated accessModifier returnType deprecatedMethodName() (… )

Lorsqu'un programme utilise l'élément qui a été déclaré obsolète, le compilateur génère un avertissement.

Nous utilisons la @deprecatedbalise Javadoc pour documenter l'élément obsolète.

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

Exemple 1: Exemple d'annotation @Deprecated

 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(); ) )

Production

 Méthode obsolète

2. @Override

L' @Overrideannotation spécifie qu'une méthode d'une sous-classe remplace la méthode de la superclasse avec le même nom de méthode, le même type de retour et la même liste de paramètres.

Il n'est pas obligatoire de l'utiliser @Overridelors de la substitution d'une méthode. Cependant, si nous l'utilisons, le compilateur donne une erreur si quelque chose ne va pas (comme un type de paramètre incorrect) lors de la substitution de la méthode.

Exemple 2: Exemple d'annotation @Override

 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(); ) )

Production 

 Je suis un chien

Dans cet exemple, en créant un objet dog1 de la classe Dog, nous pouvons appeler sa méthode printMessage () qui exécute alors l' display()instruction.

Comme elle display()est définie dans les deux classes, la méthode de la sous-classe Dog remplace la méthode de la superclasse Animal. Par conséquent, le display()de la sous-classe est appelé.

3. @SuppressWarnings

Comme son nom l'indique, l' @SuppressWarningsannotation demande au compilateur de supprimer les avertissements générés pendant l'exécution du programme.

Nous pouvons spécifier le type d'avertissements à supprimer. Les avertissements qui peuvent être supprimés sont spécifiques au compilateur, mais il existe deux catégories d'avertissements: obsolète et non cochés .

Pour supprimer une catégorie particulière d'avertissement, nous utilisons:

 @SuppressWarnings("warningCategory")

Par exemple,

 @SuppressWarnings("deprecated")

Pour supprimer plusieurs catégories d'avertissements, nous utilisons:

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

Par exemple,

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

Category deprecatedindique au compilateur de supprimer les avertissements lorsque nous utilisons un élément obsolète.

Category uncheckedindique au compilateur de supprimer les avertissements lorsque nous utilisons des types bruts.

Et les avertissements non définis sont ignorés. Par exemple,

 @SuppressWarnings("someundefinedwarning")

Exemple 3: Exemple d'annotation @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(); ) )

Production 

 Méthode obsolète

Ici, deprecatedMethod()a été marqué comme obsolète et donnera des avertissements au compilateur lorsqu'il est utilisé. En utilisant l' @SuppressWarnings("deprecated")annotation, nous pouvons éviter les avertissements du compilateur.

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(); )

La valeur définie dans l' @Repeatableannotation est l'annotation du conteneur. L'annotation de conteneur a une valeur variable de type tableau de l'annotation répétable ci-dessus. Voici Universitiesle type d'annotation contenant.

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

Désormais, l' @Universityannotation peut être utilisée plusieurs fois sur la même déclaration.

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

Si nous avons besoin de récupérer les données d'annotation, nous pouvons utiliser l'API Reflection.

Pour récupérer les valeurs d'annotation, nous utilisons la méthode getAnnotationsByType()ou getAnnotations()définie dans l'API Reflection.

Articles intéressants...