Introduktion Annotationer i Java
Bemærkninger blev introduceret eller blev tilgængelige i 1.5-versionen af Java Development Kit (JDK). Annotationer i Java giver mere information om de data, der findes i kodestrukturen, dvs. det er data om data, også kendt som metadata.
Hvad er kommentarer i Java?
Bemærkninger hjælper med at definere metadata i kode på en standardiseret måde. Bemærkninger hjælper også med at give instruktioner til din java-kompilator, der skal følges, mens du sammenstiller den java-kode.
Når vi bruger kommentarerne, bruger vi '@' tegnet og derefter efterfulgt af navnet på din annotation, så kompilatoren behandler det som en kommentar. Det er vigtigt at bemærke, at kommentarerne kan tilføjes før-
- En klassedeklaration
- En medlemsvariabel erklæring
- En konstruktørerklæring
- En metodedeklaration
- En parametererklæring
- En lokal variabel erklæring.
Vigtige punkter at huske er, at alle kommentarer udvider java.lang.annotation.Annotation interface. Bemærkninger kan heller ikke omfatte nogen udvidelsesklausul.
Indbyggede Java-kommentarer
I Java er der indbyggede kommentarer såsom @Override, @Deprecated, @SuppressWarnings, der er designet til et specifikt formål og brugt i en af ovenstående situationer, f.eks. Kun til klassen eller kun til metode, etc.
Eksempel 1 - Override
class Dad (
public void say() (
System.out.println("Do your homework");
)
)
public class Child extends Dad (
@Override
public void say()(
System.out.println("I wanna play");
)
public static void main(String args())(
Dad daddy = new Child();
daddy.say();
)
)
Produktion
Eksempel 2 -Udskrivet
public class Outdated
(
@Deprecated
public void oldShow()
(
System.out.println("This Method is deprecated"); )
public static void main(String args())
(
Outdated od = new Outdated ();
od.oldShow();
)
)
Produktion
Meta-kommentarer
Der er fem typer meta-annotationer:
- Dokumenteret - Det informerer om, at medlemmet eller variablen eller klassen, der bruger denne annotation, skal dokumenteres af Javadoc eller andre lignende tilgængelige værktøjer.
- Mål - Det bruges til at specificere, hvilken type annotationen bruges. Det bruges mest sammen med dine brugerdefinerede kommentarer.
- Arvet - Det markerer annotationen, der skal arves til underklassen.
- Opbevaring - Det angiver, hvor længe kommentarer med den annoterede type skal bevares. Det tager Retention Policy-argumentet, hvis mulige værdier er: SOURCE, CLASS og RUNTIME.
- Gentagbar - Dette informerer om, at annotationstyperne, hvis erklæring den annoterer, kan gentages.
Eksempel - Dokumentation og opbevaring
import java.lang.annotation.*;
@Retention(RetentionPolicy.RUNTIME)
@interface RSample (
String rentent();
)
@Documented
@interface DSample (
String doc();
)
public class MetaAnnotate (
public static void main(String arg())
(
new MetaAnnotate().rentent();
new MetaAnnotate().doc();
)
@RSample (rentent="Meta Info R")
public void rentent() (
System.out.println("Retention Policy Applied");
)
@DSample(doc="Meta Info D")
public void doc() (
System.out.println("Code Documented with the value");
)
)
Produktion
Forklaring
RetentionPolicy.RUNTIME - Denne værdi specificerer, at annotationsværdien skal være tilgængelig under kørsel til inspektion via java-reflektion.
Kør Javadoc-kommandoen for at se dokumentationen til din kode.
Typer af kommentarer
Der er tre kategorier af kommentarer, og der er som følger:
1. Marker-annotationer - Disse typer annotationer bruges som en erklæring til at underrette udvikleren om, hvad nedenstående funktion eller klasse handler om, dvs. at den deler ekstra information om funktionen eller klassen som om funktionen tilsidesætter en anden funktion eller er funktionen udgået osv. @Override, @ Uudviklet betragtes som markørnotater.
Eksempel: DemoAnnotation ()
2. Noteringer med en enkelt værdi - Denne type annotation tager værdien i for at specificere den værdi for det medlem, som annotationen er placeret foran, og behøver derfor ikke at specificere navnet på det medlem.
Eksempel: DemoAnnotation (“custId123”)
3. Fuldstændige kommentarer - Denne form for annotation indtager flere værdier, par, medlemmer.
Eksempel: DemoAnnotation (kategori = ”Legetøj”, værdi = 1500)
Brugerdefinerede
Tilpassede kommentarer oprettes af brugergrænsefladen, efterfulgt af et annotationsnavn, som vi vil se i nedenstående eksempel.
Fil 1: Defineret tilpasset kommentar
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target((ElementType.TYPE, ElementType.METHOD))
@Retention(RetentionPolicy.RUNTIME)
@interface Magicians
(
String Wizard() default "Reynolds";
String House() default "Green";
)
@Magicians
public class Magician
(
@Magicians(Wizard = "Harry Potter", House = "Red")
public String getString() ( return null; )
)
Fil 2: Hovedklasse, der kalder den tilpassede annotationsklasse
import java.lang.annotation.Annotation;
import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Method;
public class MyCustomAnnotation
(
public static void main(String() args) throws NoSuchMethodException, SecurityException
(
new Magician();
Class magic = Magician.class;
readAnnotationOn(magic);
Method method = magic.getMethod("getString", new Class()());
readAnnotationOn(method);
)
static void readAnnotationOn(AnnotatedElement element)
(
try
(
System.out.println("\n Find annotations on " + element.getClass().getName());
Annotation() annotations = element.getAnnotations();
for (Annotation annotation : annotations)
(
if (annotation instanceof Magicians)
(
Magicians mData = (Magicians) annotation;
System.out.println("Wizard Name :" + mData.Wizard());
System.out.println("Wizard House Color :" + mData.House());
)
)
) catch (Exception e)
(
e.printStackTrace();
)
)
)
Produktion
Konklusion
I denne artikel lærte vi, hvad der er java-kommentarer og deres typer med eksempler, sammen så vi eksempler på indbyggede kommentarer leveret af java og kodede vores brugerdefinerede kommentarer.
Vi lærte, at kommentarer er nyttige ved standardisering af koden og også hjælper med til bedre forståelse af koden og dens struktur.
Anbefalede artikler
Dette er en guide til Java-kommentarer. Her drøfter vi Sådan indbygges Java-kommentarer med de givne eksempler og output. Du kan også se på de følgende artikler for at lære mere -
- Variabler i Java
- Mønstre i Java
- Hurtig sortering i Java
- Bedste Java-kompilatorer
- eksempel på i Java med eksempel