java自定义标注实例

柯拉松

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

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

[size=13.043478965759277px]Test.java

1. package com.mkyong.test.core;
   
2. 
   6 s" A" K2 Y. y1 O* j
3. import java.lang.annotation.ElementType;
   ( W7 U3 ?9 t  o3 d' q6 \
4. import java.lang.annotation.Retention;
   
5. import java.lang.annotation.RetentionPolicy;
   4 B/ x3 b" ]+ m; D' G
6. import java.lang.annotation.Target;
   ' W6 U3 J7 l5 l- J9 _, x/ ?
7. 
   : a/ i* t+ m4 m: C
8. @Retention(RetentionPolicy.RUNTIME)
   
9. @Target(ElementType.METHOD) //can use in method only.
   
10. public @interface Test {
    
11. 
    ' Q$ L" C; @' m; X
12.         //should ignore this test?
    * A; \  I4 z- Q& A
13.         public boolean enabled() default true;
    
14. 
    
15. }</font></font>

复制代码

注意
方法申明必须不能带有任何参数或throws片段，返回类型限制为基本类型，字符串String，类Class，枚举eunms，标注和这些类型的数组
; k7 Y8 k  R" D
( Y, M4 U" N( M+ ]* w2. @TesterInfo Annotation
@TesterInfo应用到类级别，保存tester的详情。这个类演示返回不同的类型：enum, array and string
TesterInfo.java
  H8 K" N( {. K" T

1. package com.mkyong.test.core;
   
2. 
   - t3 G0 ]& i% v' q5 n. K
3. import java.lang.annotation.ElementType;
   % A: C8 c4 w4 J
4. import java.lang.annotation.Retention;
   
5. import java.lang.annotation.RetentionPolicy;
   
6. import java.lang.annotation.Target;
   - Y+ }/ ^% N% e, T$ {; a
7. 
   $ D4 p9 P2 w  Y  h5 h5 m. D, q2 s- ?% k
8. @Retention(RetentionPolicy.RUNTIME)
   
9. @Target(ElementType.TYPE) //on class level
   - s& B+ {8 Q  |* r+ w
10. public @interface TesterInfo {
    * |" {6 x0 u( m
11. 
    ( j3 I  U) ?( b4 e) W
12.         public enum Priority {
    
13.            LOW, MEDIUM, HIGH
    $ G/ T0 a+ G6 m4 \
14.         }
    
15. 
    
16.         Priority priority() default Priority.MEDIUM;
      _( G& I  a# i; S) Q2 m$ x7 S
17. 
    + L+ d. p9 l2 k9 p$ ^: ]
18.         String[] tags() default "";
    
19. 
    : U1 V. N" r* @+ s1 V( y$ C
20.         String createdBy() default "Mkyong";
    2 w: {8 R2 ?& N  h0 A
21. 
    4 ^9 @5 \8 X- W# ]6 q1 ?5 [
22.         String lastModified() default "03/01/2014";
    , y# Z4 P" R  j$ _7 M0 A. y
23. 
    . ^! c! G6 \5 B8 ^! ^" Z
24. }

复制代码

柯拉松

3. Unit Test Example
' s& }6 g8 p1 u新建一个简单的单元测试实例，并且通过新建的标注来标注：@Test and @TesterInfo

TestExample.java

1. package com.mkyong.test;
   " P7 {6 H3 b0 V3 p
2. 
   
3. import com.mkyong.test.core.Test;
   
4. import com.mkyong.test.core.TesterInfo;
   # z* u  K* g  M+ y: G4 k1 L) g
5. import com.mkyong.test.core.TesterInfo.Priority;
   
6. 
   8 L+ w7 D8 i3 U
7. @TesterInfo(
   
8.         priority = Priority.HIGH,
   
9.         createdBy = "mkyong.com",  
   7 L# |2 h/ E: W; j
10.         tags = {"sales","test" }
    9 g& b" g# _) B! C. v6 Y! U2 S
11. )
    
12. public class TestExample {
    $ V7 |+ c# `2 q
13. 
    
14.         @Test
    6 e+ u* s6 b7 }" [. J/ M
15.         void testA() {
    
16.           if (true)
    
17.                 throw new RuntimeException("This test always failed");
    6 L) b; Q1 b0 T- d% ^
18.         }
    
19. 
    
20.         @Test(enabled = false)
    
21.         void testB() {
    7 t. a, v8 ]. B4 `6 \) c
22.           if (false)
    1 q  _- `5 V. K& J
23.                 throw new RuntimeException("This test always passed");
    
24.         }
    / `. {( ^2 Q, q8 z
25. 
    7 ]0 k) W8 ?, P& m; [9 x
26.         @Test(enabled = true)
    
27.         void testC() {
    
28.           if (10 > 1) {
    
29.                 // do nothing, this test always passed.
    ' l3 q* l2 u1 ]
30.           }
    
31.         }
    
32. 
    
33. }

复制代码

' _6 s. A8 s7 X: K9 u4. Java reflection – Read the Annotation下面的例子演示如何通过java反射来读取和处理自定义标注。

  q- v  g' R) D8 `% Y# L+ hRunTest.java

1. package com.mkyong.test;
   
2. 
     ?$ k9 B9 }9 t+ W% n6 i% a) C
3. import java.lang.annotation.Annotation;
   & ?, A+ R: Z% j) g# t& \
4. import java.lang.reflect.Method;
   
5. 
   
6. import com.mkyong.test.core.Test;
   * M1 q1 y$ T" P% z4 U$ |
7. import com.mkyong.test.core.TesterInfo;
     k5 w2 u0 r' m/ J* k, K1 I# l% K: `" M
8. 
   : e3 y* |, L$ Z$ ?7 c
9. public class RunTest {
   
10. 
    
11.   public static void main(String[] args) throws Exception {
    / g) E. s4 o' C1 }% }! c. X
12. 
    ; r" i) U/ ^8 D$ @0 \# b
13.         System.out.println("Testing...");
    
14. 
    
15.         int passed = 0, failed = 0, count = 0, ignore = 0;
    
16. 
    
17.         Class<TestExample> obj = TestExample.class;
    5 ~7 g# k6 e. J3 G1 a
18. 
    
19.         // Process @TesterInfo
    
20.         if (obj.isAnnotationPresent(TesterInfo.class)) {
    
21. 
    
22.                 Annotation annotation = obj.getAnnotation(TesterInfo.class);
    ) K; y0 E/ T! ]
23.                 TesterInfo testerInfo = (TesterInfo) annotation;
    
24. 
    ! y/ _6 c. q  ^& B1 K
25.                 System.out.printf("%nPriority :%s", testerInfo.priority());
    
26.                 System.out.printf("%nCreatedBy :%s", testerInfo.createdBy());
    
27.                 System.out.printf("%nTags :");
    5 a4 N: \6 g6 k( g/ s: \
28. 
    - F. s( Y  ]) a
29.                 int tagLength = testerInfo.tags().length;
    7 R5 X* ], N" [& O2 e/ `0 \: I
30.                 for (String tag : testerInfo.tags()) {
    
31.                         if (tagLength > 1) {
    
32.                                 System.out.print(tag + ", ");
    5 L8 o; g" Y- ]* C; Y8 G- [
33.                         } else {
    2 o! N, s7 v  {
34.                                 System.out.print(tag);
    
35.                         }
    
36.                         tagLength--;
    9 B8 b: W4 ]! C$ F
37.                 }
    
38. 
    ' L, j1 Y3 X# {5 W* J
39.                 System.out.printf("%nLastModified :%s%n%n", testerInfo.lastModified());
    % h; J$ o! F7 a
40. 
    7 \: I) S( ~: i( |
41.         }
    
42. 
    + r$ R. I; L. M! g6 C
43.         // Process @Test
    " C$ L" `- J( U" t! M- W/ m1 X0 ]
44.         for (Method method : obj.getDeclaredMethods()) {
    
45. 
    
46.                 // if method is annotated with @Test
    ; n7 f+ z, y3 l+ R' i. _
47.                 if (method.isAnnotationPresent(Test.class)) {
    
48. 
    + t8 U4 H; s' j
49.                         Annotation annotation = method.getAnnotation(Test.class);
    9 w; E' I+ z( |" K8 d
50.                         Test test = (Test) annotation;
    
51. 
    % h" ]$ A. u* X
52.                         // if enabled = true (default)
    
53.                         if (test.enabled()) {
    
54. 
    
55.                           try {
    . S1 ?; E$ X# C, |, \* F: i4 W
56.                                 method.invoke(obj.newInstance());
    
57.                                 System.out.printf("%s - Test '%s' - passed %n", ++count, method.getName());
    
58.                                 passed++;
    
59.                           } catch (Throwable ex) {
    
60.                                 System.out.printf("%s - Test '%s' - failed: %s %n", ++count, method.getName(), ex.getCause());
    2 }& I! C/ \- l; {) N/ W
61.                                 failed++;
    ; B! ^& Z% N! p5 a; v9 Y% d
62.                           }
    
63. 
    
64.                         } else {
    9 g/ G/ L; C, k2 R
65.                                 System.out.printf("%s - Test '%s' - ignored%n", ++count, method.getName());
    
66.                                 ignore++;
    ! F# V" m% \+ N( ^; G; c& K6 C
67.                         }
    5 N5 d5 ~1 }+ X9 K6 A; ?
68. 
    
69.                 }
    
70. 
    5 _9 T; Q5 C; C; k1 T- v/ }
71.         }
    
72.         System.out.printf("%nResult : Total : %d, Passed: %d, Failed %d, Ignore %d%n", count, passed, failed, ignore);
    ( k. k8 N! g/ o7 l! P+ z; s
73. 
    * ?5 }9 h$ w5 k. v7 m* P" I
74.         }
    
75. }

复制代码

Output

1. Testing...
   
2. 
   $ s, ?* ?0 G8 @  c" V" f4 g
3. Priority :HIGH
   
4. CreatedBy :mkyong.com
   
5. Tags :sales, <strong>test</strong>
   
6. LastModified :03<strong>/</strong>01<strong>/</strong><span style="color:#000000">2014</span>
   
7. 
   
8. <span style="color:#000000">1</span> - Test <span style="color:#ff0000">'testA'</span> - failed: java.lang.RuntimeException: This <strong>test</strong> always failed
   ' z" q- ~4 B" _/ O, I/ G9 x
9. <span style="color:#000000">2</span> - Test <span style="color:#ff0000">'testC'</span> - passed
   
10. <span style="color:#000000">3</span> - Test <span style="color:#ff0000">'testB'</span> - ignored
    
11. 
    0 R$ O( i+ Z( D: F" d
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
自定义标签？

7 _; G/ o: s) N5 D( z! s4 ]7 }1 F注解- -。。