При разработке нередко возникают ситуации, когда необходимо создать  значительного количество стандартного кода. Естественно, писать однотипный код вручную - непродуктивно. Используя аннотации эту задачу можно упростить. Например, пометив удаленно доступные методы специальными аннотациями, можно возпользоваться инструментарием, который автоматически сгенерит JAX-RPC шаблон для этого кода, что значительно уменьшает объем рутинной работы при создании Веб-сервисов.

Другая частая ситуация - необходимость поддерживать внешние файлы, которые должны быть синхронизированы с кодом программы. Например, JavaBeans требует, чтобы класс BeanInfo был синхронизирован с самим bean, а Enterprise JavaBeans (EJB) подразумевает наличие корректного дескриптора. Проще и надежнее, если вместо обновления дополнительного внешнего файла, требуемая дополнительная информация хранилась бы прямо в коде в виде аннотаций.

В платформе Java уже давно есть специализированные аннотации. Например, модификатор transient - это аннотация, указывающая, что поле должно при выполнении сериализации, а тег javadoc @deprecated - аннотация, указывающая, что метод устарел и не рекомендован к использованию.

А начиная с версии 5.0, в языке Java появилась поддержка обобщеных аннотаций (то есть методанных), которая позволяет определять и использовать ваши собственные типы аннотаций. Нововведения включают не только синтаксис для объявления типов аннотаций и синтаксис для их использования, но также API для чтения аннотаций из кода программы,  способа хранения аннотаций в класс файлах (откомпилированном java коде) и инструмента обработки аннотаций.  

<font class="code" face="Courier">/**
 * Describes the Request-For-Enhancement(RFE) that led
 * to the presence of the annotated API element.
 */
public @interface RequestForEnhancement {
  int id();
  String synopsis();
  String engineer() default "[unassigned]";
  String date();    default "[unimplemented]";
}</font>
   

<font class="code" face="Courier">@RequestForEnhancement(
    id       = 2868724,
    synopsis = "Enable time-travel",
    engineer = "Mr. Peabody",
    date     = "4/1/3007"
)
 
public static void travelThroughTime(Date destination) { ... }</font>
   

<font class="code" face="Courier">/**
 * Indicates that the specification of the annotated API element
 * is preliminary and subject to change.
 */
 
public @interface Preliminary { }</font><font face="Courier">
</font>
   

<font class="code" face="Courier">@Preliminary public class TimeTravel { ... }</font>
   

<font class="code" face="Courier">/**
 * Associates a copyright notice with the annotated API element.
 */
 
public @interface Copyright {
    String value();
}</font>
   

<font class="code" face="Courier">@Copyright("2002 Yoyodyne Propulsion Systems")
 
public class OscillationOverthruster { ... }</font>
   

Нам потребуется аннотация маркерного типа для пометки методов, содержащих тесты, которые должны запускаться инструментом тестирования:

<font class="code" face="Courier">import java.lang.annotation.*; 
 
/**
 * Указывает, что помеченный метод предназначен для тестирования.
 * Аннотацию можно использовать только со статическими методами без параметров.
 */
 
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Test { }</font><font face="Courier">
</font>
   

<font class="code" face="Courier">public class Foo {
   @Test public static void m1() { }
   public static void m2() { }
   @Test public static void m3() {
        throw new RuntimeException("Boom");
   }
   public static void m4() { }
   @Test public static void m5() { }
   public static void m6() { }
   @Test public static void m7() {
      throw new RuntimeException("Crash");
   }
   public static void m8() { } 
}</font>
 
 
 
   

А вот так выглядит кол простого инструмента для исполнения тестов:

<font class="code" face="Courier">import java.lang.reflect.*;
 
public class RunTests {
   public static void main(String[] args) throws Exception {
      int passed = 0, failed = 0;
      for (Method m : Class.forName(args[0]).getMethods()) {
         if (m.isAnnotationPresent(Test.class)) {
            try {
               m.invoke(null);
               passed++;
            } catch (Throwable ex) {              
               System.out.printf("Test %s failed: %s %n", m, ex.getCause());
               failed++;
            }
         }
      }
      System.out.printf("Passed: %d, Failed %d%n", passed, failed);
   }
}</font>
   

Инструмент тестирования получает имя класса для тестирования, как аргумент командной строки, перебирает все методы этого класса и запускает все методы, которые аннотированы аннотацией @Test. Предполагая, что провалившиеся тесты генерируют исключения, можно легко посчитать сколько тестов было выполнено успешно и сколько неудачно.

Вот пример результата работы этой программы для класса Foo (который мы определили выше):

<font class="code" face="Courier">$ java RunTests Foo
 
Test public static void Foo.m3() failed: java.lang.RuntimeException: Boom
Test public static void Foo.m7() failed: java.lang.RuntimeException: Crash
Passed: 2, Failed 2</font>
   

И хотя, этот инструмент тестирования - поделка с большим числом ограничений, он демонстрирует возможности аннотаций и может быть легко расширен до практически полезного инструмента.

 Перевод Саноцкая Надежда, Дмитриев Андрей.

Оригинал