Пример пользовательских аннотаций Java

java-custom-annotation

В этом руководстве мы покажем вам, как создать две пользовательские аннотации -@Test и@TestInfo, для моделирования простой среды модульного тестирования.

P.S This unit test example is inspired by this official Java annotation article.

1. @Test Annotation

Этот@interface сообщает Java, что это настраиваемая аннотация. Позже вы можете аннотировать его на уровне метода, например,@Test(enable=false).

Test.java

package com.example.test.core;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD) //can use in method only.
public @interface Test {

    //should ignore this test?
    public boolean enabled() default true;

}

Note
Объявления методов не должны иметь никаких параметров или предложения throws. Типы возврата ограничены примитивами, String, Class, перечислениями, аннотациями и массивами предыдущих типов.

2. @TesterInfo Аннотация

Этот@TesterInfo применяется на уровне класса, сохраните данные тестера. Это показывает различное использование возвращаемых типов - enum, array и string.

TesterInfo.java

package com.example.test.core;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE) //on class level
public @interface TesterInfo {

    public enum Priority {
       LOW, MEDIUM, HIGH
    }

    Priority priority() default Priority.MEDIUM;

    String[] tags() default "";

    String createdBy() default "Mkyong";

    String lastModified() default "03/01/2014";

}

3. Пример модульного теста

Создайте простой пример модульного теста и аннотируйте его новыми пользовательскими аннотациями -@Test и@TesterInfo.

TestExample.java

package com.example.test;

import com.example.test.core.Test;
import com.example.test.core.TesterInfo;
import com.example.test.core.TesterInfo.Priority;

@TesterInfo(
    priority = Priority.HIGH,
    createdBy = "example.com",
    tags = {"sales","test" }
)
public class TestExample {

    @Test
    void testA() {
      if (true)
        throw new RuntimeException("This test always failed");
    }

    @Test(enabled = false)
    void testB() {
      if (false)
        throw new RuntimeException("This test always passed");
    }

    @Test(enabled = true)
    void testC() {
      if (10 > 1) {
        // do nothing, this test always passed.
      }
    }

}

4. Отражение Java - прочтите аннотацию

Ниже в примере показано, как использовать API отражения Java для чтения и обработки пользовательских аннотаций.

RunTest.java

package com.example.test;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;

import com.example.test.core.Test;
import com.example.test.core.TesterInfo;

public class RunTest {

  public static void main(String[] args) throws Exception {

    System.out.println("Testing...");

    int passed = 0, failed = 0, count = 0, ignore = 0;

    Class obj = TestExample.class;

    // Process @TesterInfo
    if (obj.isAnnotationPresent(TesterInfo.class)) {

        Annotation annotation = obj.getAnnotation(TesterInfo.class);
        TesterInfo testerInfo = (TesterInfo) annotation;

        System.out.printf("%nPriority :%s", testerInfo.priority());
        System.out.printf("%nCreatedBy :%s", testerInfo.createdBy());
        System.out.printf("%nTags :");

        int tagLength = testerInfo.tags().length;
        for (String tag : testerInfo.tags()) {
            if (tagLength > 1) {
                System.out.print(tag + ", ");
            } else {
                System.out.print(tag);
            }
            tagLength--;
        }

        System.out.printf("%nLastModified :%s%n%n", testerInfo.lastModified());

    }

    // Process @Test
    for (Method method : obj.getDeclaredMethods()) {

        // if method is annotated with @Test
        if (method.isAnnotationPresent(Test.class)) {

            Annotation annotation = method.getAnnotation(Test.class);
            Test test = (Test) annotation;

            // if enabled = true (default)
            if (test.enabled()) {

              try {
                method.invoke(obj.newInstance());
                System.out.printf("%s - Test '%s' - passed %n", ++count, method.getName());
                passed++;
              } catch (Throwable ex) {
                System.out.printf("%s - Test '%s' - failed: %s %n", ++count, method.getName(), ex.getCause());
                failed++;
              }

            } else {
                System.out.printf("%s - Test '%s' - ignored%n", ++count, method.getName());
                ignore++;
            }

        }

    }
    System.out.printf("%nResult : Total : %d, Passed: %d, Failed %d, Ignore %d%n", count, passed, failed, ignore);

    }
}

Выход

Testing...

Priority :HIGH
CreatedBy :example.com
Tags :sales, test
LastModified :03/01/2014

1 - Test 'testA' - failed: java.lang.RuntimeException: This test always failed
2 - Test 'testC' - passed
3 - Test 'testB' - ignored

Result : Total : 3, Passed: 1, Failed 1, Ignore 1

Готово.

TOC

Пример пользовательских аннотаций Java