Cómo: anotaciones de código Java

Añadido al lenguaje de programación Java en Java 1.5, las anotaciones son un medio versátil de dar más información sobre el código Java. Se pueden utilizar para un amplio número de situaciones, desde simplemente que indica información sobre una clase o método - quizás lo que indica que una clase está destinada a ser inmutable - para permitir que otro código para trabajar con el método de una manera especial a través de la reflexión.

Instrucciones

Cómo crear una anotación

1 En Eclipse, cree un nuevo proyecto. Nombre que lo que quiera. "Anotaciones", o algo similar, funcionarán.

2 Haga clic derecho sobre la carpeta "src" en virtud de su nuevo proyecto, puntero del ratón sobre el submenú "Nuevo" y seleccione "Anotación" de la lista del submenú.

3 Nombrar la anotación "ReviewedBy." Vaya por delante y mantener todo lo demás como defaults.Generally, se debe utilizar un nombre de paquete.

4 Modificar su nuevo archivo a tener este aspecto:

java.lang.annotation.ElementType importación;

java.lang.annotation.Retention importación;

java.lang.annotation.RetentionPolicy importación;

java.lang.annotation.Target importación;

@Target (ElementType.TYPE)

@Retention (RetentionPolicy.RUNTIME)

@interface pública ReviewedBy {

String value();

Cadena reviewedOn () "" por defecto;

comentarios de cadena () por defecto "";

}

Tenga en cuenta que algunas anotaciones se han añadido. Estos son necesarios para conseguir que funcione correctamente. La anotación @Target le dice al compilador la anotación sólo es válido para un tipo - como por ejemplo clase, interfaz de enumeración, etc. - y la anotación @Retention le dice al compilador para mantener la anotación de información disponible en tiempo de ejecución.

El uso de la anotación

5 Crear una nueva clase haciendo clic derecho sobre la carpeta src, seleccionar "Nuevo" y seleccionar "Clase". El nombre de "TestData." Puede añadir cualquier campos le gusta a ella - en su caso. Los campos que no son relevantes para este ejemplo, pero hace que la clase de prueba se ven un poco menos como una clase de prueba.

6 Aplicar nuestra anotación a la nueva clase:

@ReviewedBy (Valor = "Jane Smith", reviewedOn = "12/21/2012", los comentarios = "Esta es una clase increíble!")

TestClass public class {

private int number;

Cadena de texto privado;

public int obtieneNumero () {

número de devolución;

}

pública setNumber void (int numero) {

this.number = número;

}

Cadena getText pública () {

Texto del retorno;

}

pública setText void (String text) {

This.Text = texto;

}

}

7 Crear otra clase. El nombre de "AnnotationReader." Seleccione la casilla junto a "principales (args String []) public static void" para añadir un método principal para la nueva clase.

8 Modificar su nueva clase de manera que contenga el siguiente código:

AnnotationReader public class {

public static void main(String[] args) {

última clase & lt;?> clazz = TestClass.class;

última ReviewedBy reviewedBy = clazz.getAnnotation (ReviewedBy.class);

System.out.println ( "revisada por:" + reviewedBy.value ());

System.out.println ( "Fecha de:" + reviewedBy.reviewedOn ());

System.out.println ( "Comentarios:");

System.out.println (reviewedBy.comments ());

}

}

9 Ejecutar su clase. Si todo va bien, debería obtener salida de la consola similar al siguiente:

Revisada por: Jane Smith

Fecha de: 12/21/2012

comentarios:

Esta es una clase increíble!

Consejos y advertencias

• Con un poco de creatividad, usted puede lograr un poco con anotaciones. Por ejemplo, se puede utilizar para asociar los campos en una clase con columnas de base de datos, o que su aplicación funcione con un tipo de objeto en una situación que está definida por una anotación, y otro tipo de objeto en una situación diferente.
• Es fácil dejarse llevar por las anotaciones. A veces, son una excelente herramienta para trabajar, pero en otras ocasiones que pueden hacer poco más que complican su código y añadir exceso de carga cuando existen soluciones simples.