How to write Java annotations?

Java annotations

In this article we will discuss about annotations and how they can be used in practical programming. First, we will discuss some conceptual ideas and then jump into coding to write an example program using annotations.

Motivation:

In Java programming, may mga ilang mga paraan upang ipahayag ang pag-uugali ng mga iba't ibang mga elemento,,en,tulad ng pamamaraan,,en,Mga miyembro etc,,en,Sa karamihan ng mga kaso ang mga pagdeklara ay tinukoy sa ilang mga panlabas na mga file,,en,mga katangian ng file etc,,en,At pagkatapos ay ang mga file ay tinukoy sa programa upang makakuha ng ito pinaandar,,en,Sa kaso ng annotation,,en,ang diskarte ay ganap na kakaiba,,en,Annotation ay meta-data at mga nakasulat sa isang tiyak na format,,en,Ang mga anotasyon elemento ay nakasulat sa loob ng Java program mismo,,en,hindi na kailangan na mag-refer sa anumang mga panlabas na mga file,,en,na kung saan ay isang malaking kalamangan,,en,Mga Anotasyon ay maaaring maging kapaki-pakinabang para magtayo ng mga kagamitan,,en,Kapag ang build tools pumunta tungkol sa kanilang mga gawain na kinabibilangan ng pagbuo ng source code,,en,pagbuo ng XML file,,en,deployment descriptor,,en,packaging mga code at mga file sa isang jar file,,en,tinitingnan nito para sa mga annotation para sa input sa pagbuo ng source code o mga file,,en (like methods, classes, members etc). In most of the cases these declarations are defined in some external files (XML, properties file etc). And then those files are referred in the program to get it executed.

In case of annotation, the approach is totally different. Annotations are meta-data and those are written in a specific format. These annotation elements are written within the Java program itself. So, there is no need to refer any external files, which is a big advantage. Ang mga annotation ay madaling gamitin at nababaluktot sapat na upang ipatupad.

Sa susunod na seksyon ay namin makita kung paano ang mga maaring ipatupad.








Ano ang Java annotation?

A Java annotation ay isang metadata ng isang programa ng Java. o, lamang ng pagsasalita, isang Java annotation ay nagbibigay ng impormasyon tungkol sa isang programa ng Java. Sa karamihan ng kaso, ito ay hindi direkta-iimpluwensya ng programa o code.

Bakit Java annotation ay ginagamit?

A Java annotation ay maaaring gamitin para sa mga sumusunod na layunin:

  • Ang pagbibigay ng mga tagubilin sa mga compiler

Kapag ang compiler nagpalit ng code sa machine-readable tagubilin, annotation ay maaaring magbigay ng compiler tulad tagubilin. Usually, pagkatapos compilation, ang mga annotation ay hindi kasalukuyan sa code.

  • Ang pagbibigay ng mga tagubilin sa mga builder

Sa mga araw na ito, nais mong ipaalam sa mga kasangkapan tulad ng Apache Maven o Apache Ant upang bumuo ng code. Annotations can be useful for build tools. When the build tools go about their tasks which include generating source code, generating XML files (e.g. deployment descriptors), packaging codes and files into a JAR file, it looks for the annotations for inputs on generating source code or files.

  • Ang pagbibigay ng mga tagubilin sa software runtime,,en,Ito ay posible upang tukuyin ang mga anotasyon para sa pagbibigay ng input sa software runtime bagaman ang gayong mga annotation ay maaaring ma-access gamit Java Reflections,,en,isang iba't ibang mga tool,,en,Mga Anotasyon ay maaaring maging parehong paunang-natukoy na at pasadyang,,en,Habang pasadyang annotation ay maaaring maging ng maraming uri,,en,paunang-natukoy na mga anotasyon ay sa mga sumusunod na tatlong mga uri,,en,@Deprecated,,en,annotation ay nagpapahiwatig na ang isang klase,,en,Ang pamamaraan o field na ay wala na sa paggamit,,en,annotation ay nagpapahiwatig na ang isang klase sa isang paraan na ay hindi tumugma sa anumang paraan sa isang superclass,,en,Sa kaso ng isang hindi pagtutugma,,en,ang compiler throws ng isang error,,en,@SuppressWarnings,,en,annotation suppresses babala itinapon sa pamamagitan ng compiler,,en,kung ang isang paraan ng mga tawag sa isang hindi na ginagamit na paraan ng,,en,ang compiler throws ng isang babala,,en,annotation Ang suppresses ang gayong mga babala at higit pa,,en,Ang paglikha ng aming unang proyekto,,en

It is possible to define annotations for providing inputs to software runtime although such annotations can be accessed with Java Reflections, a different tool.

Annotations can be both predefined and custom. While custom annotations can be of many types, predefined annotations are of the following three types.








@Deprecated annotation indicates that a class, method or field that is no longer in use.

@ Override annotation indicates that a class in a method does not match any method in a superclass. In case of a mismatch, the compiler throws an error.

@SuppressWarnings annotation suppresses warnings thrown by the compiler. For example, if a method calls a deprecated method, the compiler throws a warning. The annotation suppresses such warnings and more.

Creating our first project:

Sa seksyong ito kami ay lumikha ng isang proyekto sa pamamagitan ng paggamit Eclipse IDE,,en,Ang code ng sample ay nagpapakita kung paano annotation ay gumagana sa isang tunay na kapaligiran,,en,Bago lumipat sa hands-on coding kailangan namin upang makumpleto ang pag-install hakbang na ito upang gawin ang mga kapaligiran handa,,en,Ang sumusunod ay ang mga detalye ng pag-install,,en,Pagse-set up Java kit-unlad,,en,Download,,en,mula sa site Oracle,,en,i-install at i-configure ito,,en,Pagkatapos ay itakda ang PATH at JAVA_HOME variable na kapaligiran,,en,Pagse-set up Eclipse IDE,,en,I-download ang Eclipse mula sa,,en,opisyal na website,,en,I-install ito at itakda ang mga variable na landas,,en,I-download ang annotation pakete mula sa,,en,tagsibol,,en,aklatan,,en,Sa aming halimbawa gagamitin namin ang Spring annotation pakete,,en,org.springframework.context.jar,,en,mula sa itaas na link at ilagay ito sa,,en,lib,,en,folder sa paglalaho IDE tulad ng ipinapakita sa ibaba,,en,Figure1,,en,Annotation Jars sa lib folder,,en. The code sample will show how annotation works in a real environment. Before moving into hands-on coding we need to complete the installation steps to make the environment ready.

Following are the installation details.

Step 1: Setting up Java development kit

Download JDK from the Oracle site, install and configure it. Then set the PATH and JAVA_HOME environment variables.

Step 2: Setting up Eclipse IDE

Download Eclipse from the official website. Install it and set the PATH variable.

Step 3: Download annotation packages from spring libraries.

In our example we will be using Spring annotation packages. Download org.springframework.context.jar from the above link and put it in the lib folder in Eclipse IDE as shown below.

Spring packages

Spring packages

Figure1: Annotation Jars in lib folder

Ngayon ang ating kapaligiran ay handa na upang magsulat ng Java programa na may mga anotasyon,,en,Ipaalam sa amin gumawa ng out muna proyekto sa pamamagitan ng paggamit Eclipse IDE,,en,Lumikha ng isang proyekto sa Eclipse at i-set ang pangalan ng package tulad ng,,en,com.techalpine.annotation,,en,Sa ilalim ng package na ito lumikha ng tatlong Java mga klase tulad ng ipinapakita sa ibaba,,en,Figure 2,,en,Project istraktura,,en,Tatlong klase ay BeanAnnotation.java,,id,BeanAnnotationConfig.java at BeanAnnotationMain.java,,id,Ito ang bean klase na may geter at seter pamamaraan,,en,package com.techalpine.annotation,,en,Ang proyekto istraktura ay kumpleto at ito ay handa na upang isakatuparan,,en,Ngayon patakbuhin ang application tulad ng ipinapakita sa ibaba,,en,Ito ay magiging isang stand-alone na programa ng Java,,en,kaya ito ay dapat na tumakbo bilang isang Java application tulad ng ipinapakita sa ibaba,,en,Figure3,,en,Patakbuhin ang application,,en,Sa sandaling ang mga pangunahing programa ay pinaandar,,en,ipapakita nito ang mga sumusunod na output,,en,Figure4,,en,Ipinapakita output sa console,,en.

Let us create out first project by using Eclipse IDE.

Create a project in Eclipse and set the package name as com.techalpine.annotation. Under this package create three Java classes as shown below.

Project Structure

Project Structure

Figure2: Project structure

Three classes are BeanAnnotation.java, BeanAnnotationConfig.java and BeanAnnotationMain.java

Listing1: This is the bean class with getter and setter methods

[kodigo]

package com.techalpine.annotation;

pampublikong klase BeanAnnotation {

pribadong String messagetxt;

pampublikong magpawalang-bisa setMessagetxt(string messagetxt){

this.messagetxt = messagetxt;

}

pampublikong magpawalang-bisa getMessagetxt(){

System.out.println(“Ito ang mensahe : ” + messagetxt);

}

}

[/kodigo]

Susunod ay ang configuration klase sa @Configuration at @sitaw annotation. Ang mga anotasyon ay makilala ang mga bean at ipaalam sa mga lalagyan para sa mga umiiral.

Listing2: Ito ang configuration klase

[kodigo]

package com.techalpine.annotation;

import org.springframework.context.annotation. *;

@Configuration

pampublikong klase BeanAnnotationConfig {

@Bean

pampublikong BeanAnnotation beanannotate(){

bumalik bagong BeanAnnotation();

}

}

[/kodigo]







Susunod ay ang pangunahing klase upang subukan ang mga anotasyon at kung paano ito gumagana.

Listing3: Ito ang pangunahing klase

[kodigo]

package com.techalpine.annotation;

import org.springframework.context.ApplicationContext;

import org.springframework.context.annotation. *;

pampublikong klase BeanAnnotationMain {

pampublikong static na walang bisa pangunahing(Pisi[] args) {

ApplicationContext ctx =

bagong AnnotationConfigApplicationContext(BeanAnnotationConfig.class);

BeanAnnotation beanannotate = ctx.getBean(BeanAnnotation.class);

beanannotate.setMessagetxt(“Hello, Annotation ay gumawa pagmultahin!”);

beanannotate.getMessagetxt();

}

}

[/kodigo]








Isinasagawa ang mga proyekto:

The project structure is complete and it is ready to execute. Now run the application as shown below. It will be a stand-alone Java program, so it has to be run as a Java application as shown below.

Run application

Run application

Figure3: Run the application

Once the main program is executed, it will show the following output.

Output

Output

Figure4: Showing output on the console

Konklusyon:

Sa artikulong ito namin napag-usapan ang mga konsepto ng annotation at kung paano ito ipinatupad,,en,Sana makakatulong ito sa mga gumagamit na magsulat ng Java programa na may mga anotasyon,,en. Hope it will help the users to write Java programs with annotations.

 

Tagged on: ,
============================================= ============================================== Buy best TechAlpine Books on Amazon
============================================== ---------------------------------------------------------------- electrician ct chestnutelectric
error

Enjoy this blog? Please spread the word :)

Follow by Email
LinkedIn
LinkedIn
Share