java自定义标注实例

柯拉松

在这篇教程中，我们将示范如何新建两个自定义的标注： @Test和@TestInfo，并模拟一个简单的单元测试框架。

[size=13.043478965759277px]这个@interface标识java程序，这是一份自定义标注。之后，你可以在方法级别上标注它就像这样@Test(enable=false)

[size=13.043478965759277px]Test.java

1. package com.mkyong.test.core;
   
2. 
   ' W: k  N. r7 |5 N
3. import java.lang.annotation.ElementType;
   $ A. k9 E' E9 W  K( ^
4. import java.lang.annotation.Retention;
   ) B) [$ d3 e: `
5. import java.lang.annotation.RetentionPolicy;
   3 n+ }. K0 S" h( }. N: P7 Q: E7 w4 W! ^
6. import java.lang.annotation.Target;
   ( W, E; K2 `7 _+ a0 N8 G# d
7. 
   
8. @Retention(RetentionPolicy.RUNTIME)
   1 |# d0 o! X. B# {) o0 m# _7 ~' {4 v
9. @Target(ElementType.METHOD) //can use in method only.
   
10. public @interface Test {
    6 \8 x) @, Q( D1 q) O: [
11. 
    8 J6 W8 e6 |: q
12.         //should ignore this test?
    
13.         public boolean enabled() default true;
    7 T8 S: m+ z3 F4 [
14. 
    
15. }</font></font>

复制代码

注意
1 {$ o- C0 ~/ K  w+ E+ d方法申明必须不能带有任何参数或throws片段，返回类型限制为基本类型，字符串String，类Class，枚举eunms，标注和这些类型的数组

& G1 v, S* C, N2. @TesterInfo Annotation
@TesterInfo应用到类级别，保存tester的详情。这个类演示返回不同的类型：enum, array and string
TesterInfo.java
& ~# f  Z- f4 |3 K9 }% g
# t2 x. a7 C9 S

1. package com.mkyong.test.core;
   
2. 
   * G5 D! l- n+ ^6 t' p
3. import java.lang.annotation.ElementType;
   
4. import java.lang.annotation.Retention;
   
5. import java.lang.annotation.RetentionPolicy;
   
6. import java.lang.annotation.Target;
   4 D: i) |: m( a; l) A# M5 q$ @0 ^
7. 
   
8. @Retention(RetentionPolicy.RUNTIME)
   # [7 i+ x* p; c
9. @Target(ElementType.TYPE) //on class level
   
10. public @interface TesterInfo {
    
11. 
    - ]* D: @) }) M& p! k7 w6 ~
12.         public enum Priority {
    0 s( q( l$ M; M4 U( c6 b
13.            LOW, MEDIUM, HIGH
    ! e2 h, n4 a3 L) t
14.         }
    9 }: B' U$ B, S/ _4 l9 E
15. 
    
16.         Priority priority() default Priority.MEDIUM;
    
17. 
    
18.         String[] tags() default "";
    2 _6 l: ]) r/ _7 F
19. 
    
20.         String createdBy() default "Mkyong";
    
21. 
    
22.         String lastModified() default "03/01/2014";
    
23. 
    
24. }

复制代码

柯拉松

3. Unit Test Example
; `9 M* T& p5 q/ Y: H新建一个简单的单元测试实例，并且通过新建的标注来标注：@Test and @TesterInfo

* q7 T3 J3 H2 rTestExample.java

1. package com.mkyong.test;
   " C5 }8 n) B+ z4 {9 [4 C  Z
2. 
   ) x: H% L$ D1 m- A$ A
3. import com.mkyong.test.core.Test;
   & k4 D0 n7 a0 d& s6 y& H
4. import com.mkyong.test.core.TesterInfo;
   
5. import com.mkyong.test.core.TesterInfo.Priority;
   4 ~# R5 j8 t: U' Z
6. 
   
7. @TesterInfo(
   2 E" [" q9 D' t9 ?
8.         priority = Priority.HIGH,
   
9.         createdBy = "mkyong.com",  
   & E0 F; W/ A! t. g+ o
10.         tags = {"sales","test" }
    & W/ w7 p! W1 Y4 k' o
11. )
    
12. public class TestExample {
    
13. 
    : J" ~. R! K7 ~, y( x
14.         @Test
    
15.         void testA() {
      q6 N3 E0 m) R' e; x  X
16.           if (true)
    4 i0 D4 T& }* M1 V/ Q% u6 g
17.                 throw new RuntimeException("This test always failed");
    
18.         }
    
19. 
    
20.         @Test(enabled = false)
    
21.         void testB() {
    & h& I. Y( ]4 Q6 k3 \$ E
22.           if (false)
    ) A* s; Y2 ~9 F$ |/ y
23.                 throw new RuntimeException("This test always passed");
    
24.         }
    
25. 
    
26.         @Test(enabled = true)
    6 O& c: D* \/ y2 K% J  P% `8 d
27.         void testC() {
    : U: c0 _# S: \# R, `
28.           if (10 > 1) {
    9 C* A' h) n+ j" j' d
29.                 // do nothing, this test always passed.
    
30.           }
    
31.         }
    . I2 D7 c3 g7 a: T6 u2 i6 i/ {
32. 
    ) v/ y% y/ J  I' a% h% H& o' z4 j
33. }

复制代码

4. Java reflection – Read the Annotation下面的例子演示如何通过java反射来读取和处理自定义标注。

RunTest.java

' y* }3 b+ l6 e2 M2 L

1. package com.mkyong.test;
   
2. 
   
3. import java.lang.annotation.Annotation;
   4 `1 R  Q! u4 v* h& {- A
4. import java.lang.reflect.Method;
   
5. 
   + k, w/ A9 Y7 l+ C  C
6. import com.mkyong.test.core.Test;
   . m* n: ~: X- c
7. import com.mkyong.test.core.TesterInfo;
   
8. 
   
9. public class RunTest {
   
10. 
    9 \0 ^: b( J& }# J/ Z2 z/ i
11.   public static void main(String[] args) throws Exception {
    
12. 
    # w5 {) j1 v, s& G$ m* ]
13.         System.out.println("Testing...");
    9 K1 j2 k/ O, M% ?9 t! K
14. 
    
15.         int passed = 0, failed = 0, count = 0, ignore = 0;
    
16. 
    ! @& w: ]5 W8 }( B
17.         Class<TestExample> obj = TestExample.class;
    : M" y3 W2 {3 I: w* L6 ~0 r
18. 
    & F" Q5 T6 q7 c! \
19.         // Process @TesterInfo
    
20.         if (obj.isAnnotationPresent(TesterInfo.class)) {
    
21. 
    1 O" \9 R: Z# X0 U
22.                 Annotation annotation = obj.getAnnotation(TesterInfo.class);
    
23.                 TesterInfo testerInfo = (TesterInfo) annotation;
    5 R9 r% {1 f0 w+ K6 s* s' j- X, S  m
24. 
    & j& u/ k6 H8 w+ Q5 |5 k) D
25.                 System.out.printf("%nPriority :%s", testerInfo.priority());
    ! K, l  m! O) Q- \* r6 A0 ?
26.                 System.out.printf("%nCreatedBy :%s", testerInfo.createdBy());
    / E, [4 n) d. E! R5 `
27.                 System.out.printf("%nTags :");
    3 N0 _. T9 ^3 v5 l* {) i
28. 
    
29.                 int tagLength = testerInfo.tags().length;
    
30.                 for (String tag : testerInfo.tags()) {
    ' E. [: R# Z' o3 H
31.                         if (tagLength > 1) {
    
32.                                 System.out.print(tag + ", ");
    4 S5 r: @- ]# Z7 R$ t
33.                         } else {
    ' C6 g, }$ W7 _' a
34.                                 System.out.print(tag);
    
35.                         }
    3 w/ V# i5 D" b
36.                         tagLength--;
    + a; [( G1 r5 q; \& V
37.                 }
    
38. 
    
39.                 System.out.printf("%nLastModified :%s%n%n", testerInfo.lastModified());
    6 r/ y, n+ u5 O- k, W+ `
40. 
    5 o0 m, q. C+ c+ H; t6 O
41.         }
    
42. 
    
43.         // Process @Test
    5 G, Z& p+ o" z' y
44.         for (Method method : obj.getDeclaredMethods()) {
    1 F. M* ~* [2 d8 \2 _% G
45. 
    
46.                 // if method is annotated with @Test
    
47.                 if (method.isAnnotationPresent(Test.class)) {
    $ @, s& G7 b1 c9 e' J
48. 
    7 A2 `$ s& ]: u: h/ ~0 H
49.                         Annotation annotation = method.getAnnotation(Test.class);
    
50.                         Test test = (Test) annotation;
    
51. 
    4 l8 ^6 ]- B- F1 `7 `8 h) E1 h2 M# V
52.                         // if enabled = true (default)
    9 y) X+ F/ l  B; I  Y
53.                         if (test.enabled()) {
    
54. 
    ) N/ _( f8 V3 B) Q" }" ?
55.                           try {
    * ]) P" A9 j' l' Z2 H% H: Y% K
56.                                 method.invoke(obj.newInstance());
    
57.                                 System.out.printf("%s - Test '%s' - passed %n", ++count, method.getName());
    
58.                                 passed++;
    
59.                           } catch (Throwable ex) {
    6 q7 @; M; h4 y) h
60.                                 System.out.printf("%s - Test '%s' - failed: %s %n", ++count, method.getName(), ex.getCause());
    % M) u7 }5 C4 i
61.                                 failed++;
    
62.                           }
    3 X2 t: _, M# u2 o. g$ `# J
63. 
    : U4 P* k6 c6 I! I5 p$ V
64.                         } else {
    # \$ d" `: J4 w! g4 z- }
65.                                 System.out.printf("%s - Test '%s' - ignored%n", ++count, method.getName());
    ( g. \5 I, d/ h' S# J: z
66.                                 ignore++;
    7 r: T" A6 L0 U
67.                         }
    : D/ E7 g9 P- w
68. 
    ; S+ Q  q2 N/ [7 M' N& |
69.                 }
    
70. 
    % t" j2 o* Z: I+ z: U) g
71.         }
    4 T  C- b1 P3 |9 @2 s( q
72.         System.out.printf("%nResult : Total : %d, Passed: %d, Failed %d, Ignore %d%n", count, passed, failed, ignore);
    
73. 
    
74.         }
    
75. }

复制代码

4 N! ]; v1 s$ i; l0 y7 w$ [Output

1. Testing...
   0 c6 H" g/ W$ ^: f4 R) B
2. 
   
3. Priority :HIGH
   
4. CreatedBy :mkyong.com
   ( h, v7 e* n0 M4 ?  M
5. Tags :sales, <strong>test</strong>
   9 {: L) r3 \$ C' l
6. LastModified :03<strong>/</strong>01<strong>/</strong><span style="color:#000000">2014</span>
   6 T1 G5 Z% i% t6 t2 E+ M6 `7 E
7. 
   / N8 Q3 k7 u- Q: @
8. <span style="color:#000000">1</span> - Test <span style="color:#ff0000">'testA'</span> - failed: java.lang.RuntimeException: This <strong>test</strong> always failed
   - \. m5 H. T3 }4 J/ j) i
9. <span style="color:#000000">2</span> - Test <span style="color:#ff0000">'testC'</span> - passed
   6 ^! F  X# K: a/ T
10. <span style="color:#000000">3</span> - Test <span style="color:#ff0000">'testB'</span> - ignored
    + D6 {- S; }! e2 f6 y' ^
11. 
    ) W( X1 o2 n. ~: o5 R6 a2 K# h" \
12. Result : Total : <span style="color:#000000">3</span>, Passed: <span style="color:#000000">1</span>, Failed <span style="color:#000000">1</span>, Ignore <span style="color:#000000">1</span>

复制代码

uperの小鬼

自定义标签？

柯拉松

uperの小鬼 发表于 2014-11-20 20:11
自定义标签？

; `- ]3 q& q4 I注解- -。。