Sissejuhatus Märkused Java-s

Märkused võeti kasutusele või need olid saadaval Java arenduskomplekti (JDK) 1.5 versioonis. Java märkused pakuvad lisateavet koodistruktuuris sisalduvate andmete kohta, st tegemist on andmetega andmeid, mida nimetatakse ka metaandmeteks.

Mis on Java märkused?

Märkused aitavad metaandmeid koodilisel viisil määratleda. Samuti aitavad märkused anda oma Java-kompilaatorile juhiseid, mida selle Java-koodi kompileerimise ajal järgida.

Märkuste kasutamisel kasutame märki '@' ja sellele järgneb teie annotatsiooni nimi, nii et koostaja käsitleb seda annotatsioonina. Oluline on märkida, et märkusi saab lisada enne-

  • Klassideklaratsioon
  • Liikme muutuja deklaratsioon
  • Ehitaja deklaratsioon
  • Meetodi deklaratsioon
  • Parameetri deklaratsioon
  • Kohaliku muutuja deklaratsioon.

Oluline on meeles pidada, et kõik märkused laiendavad java.lang.annotation.Anototation interface. Samuti ei tohi märkused sisaldada ühtegi laiendavat klauslit.

Sisseehitatud Java märkused

Java-s on sisseehitatud märkused, näiteks @Override, @Deprecated, @SuppressWarnings, mis on loodud konkreetsel eesmärgil ja mida kasutatakse ühes ülaltoodud olukordades, näiteks ainult klassi jaoks või ainult meetodi jaoks, jne.

Näide nr 1 - tühistamine

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

Väljund

Näide nr 2 - eemaldatud

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

Väljund

Meta märkused

Meta-annotatsioone on viis tüüpi:

  1. Dokumenteeritud - see teatab, et liige või muutuja või klass, kes seda märkust kasutab, peab olema dokumenteeritud Javadoci või mõne muu sarnase tööriista abil.
  2. Sihtmärk - seda kasutatakse märkimiseks, millist tüüpi annotatsiooni kasutatakse. Enamasti kasutatakse seda koos teie kohandatud märkustega.
  3. Päritud - see tähistab märkust, mis tuleb alamklassile pärandada.
  4. Säilitamine - see näitab, kui kaua annoteeritud tüübiga märkusi säilitatakse. See võtab arvesse säilituspoliitika argumenti, mille võimalikud väärtused on: SOURCE, CLASS ja RUNTIME.
  5. Kordatav - see annab teada, et märkimistüübid, mille deklaratsioonis annoteeritakse, on korratavad.

Näide - dokumenteerimine ja säilitamine

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

Väljund

Seletus

RetentionPolicy.RUNTIME - see väärtus täpsustab, et annotatsiooni väärtus peaks olema saadaval töö ajal, java peegelduse kaudu kontrollimiseks.

Oma koodi dokumentatsiooni kuvamiseks käivitage käsk Javadoc.

Märkuste tüübid

Märkusi on kolm kategooriat ja need on järgmised:

1. Markeri märkused - seda tüüpi märkusi kasutatakse deklaratsioonina, mis annab arendajale teada, mis on allpool toodud funktsioonil või klassil, st see jagab funktsiooni või klassi kohta lisateavet, näiteks kas funktsioon alistab teist funktsiooni või on funktsioon aegunud jms. @Orride, @Deprecated loetakse markerite märkimisteks.

Näide: DemoAnnotation ()

2. Ühtse väärtuse märkused - seda tüüpi märkused on väärtustes, et täpsustada selle liikme väärtus, mille jaoks märkus pannakse ette ja seega ei pea selle liikme nime täpsustama.

Näide: DemoAnnotation („custId123”)

3. Täismärkused - selline märkus koosneb mitmest väärtusest, paarist ja liikmest.

Näide: DemoAnnotation (kategooria = „Mänguasjad”, väärtus = 1500)

Kohandatud

Kohandatud märkused loob kasutajaliides, millele järgneb märkuse nimi, nagu näeme allolevas näites.

1. fail: määratletud kohandatud märkus

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

Fail 2: põhiklass, mis kutsub kohandatud märkuste klassi

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

Väljund

Järeldus

Selles artiklis saime teada, mis on java-annotatsioonid ja nende tüübid koos näidetega, lisaks nägime java-i sisseehitatud märkuste näiteid ja kodeerisime oma kohandatud märkusi.

Saime teada, et märkused on kasulikud koodi standardiseerimisel ja aitavad koodi ja selle ülesehitust paremini mõista.

Soovitatavad artiklid

See on Java märkmete juhend. Siin räägime sellest, kuidas sisseehitatud Java-märkusi antud näidete ja väljunditega. Võite lisateabe saamiseks vaadata ka järgmisi artikleid -

  1. Muutujad Java-s
  2. Mustrid Java-s
  3. Kiire sortimine Java-s
  4. Parimad Java kompilaatorid
  5. instanceOf Java koos näitega

Kategooria: