java自定义标注实例

柯拉松

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

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

[size=13.043478965759277px]Test.java

1. package com.mkyong.test.core;
   
2. 
   
3. import java.lang.annotation.ElementType;
   
4. import java.lang.annotation.Retention;
   * m- w( M, Z' Q
5. import java.lang.annotation.RetentionPolicy;
   1 c1 |. F$ P1 f
6. import java.lang.annotation.Target;
   
7. 
   % g  i( M+ l; ]: I: R2 G% x7 v+ Q/ _) B
8. @Retention(RetentionPolicy.RUNTIME)
   8 [& g& m/ C: U& b$ i5 M
9. @Target(ElementType.METHOD) //can use in method only.
   8 {1 N$ N7 s* B
10. public @interface Test {
    9 C0 v, Q2 |& I$ i, _+ ]
11. 
    7 n6 m# r* g0 F! B# N8 W
12.         //should ignore this test?
    
13.         public boolean enabled() default true;
    / F/ a9 A8 ~& L4 n: o9 V
14. 
    
15. }</font></font>

复制代码

注意
方法申明必须不能带有任何参数或throws片段，返回类型限制为基本类型，字符串String，类Class，枚举eunms，标注和这些类型的数组
  E9 m" J$ A6 b3 e" P1 X( [1 O
, k8 |6 T( w  f2 z$ Y0 p2. @TesterInfo Annotation
@TesterInfo应用到类级别，保存tester的详情。这个类演示返回不同的类型：enum, array and string
TesterInfo.java

1. package com.mkyong.test.core;
   8 I) Z8 O( n) S  z! R- }) @6 T
2. 
   & L, ~* n4 H( N8 u) R( D
3. import java.lang.annotation.ElementType;
   5 r5 p. y/ L. J' U. R" p
4. import java.lang.annotation.Retention;
   
5. import java.lang.annotation.RetentionPolicy;
   
6. import java.lang.annotation.Target;
   
7. 
   
8. @Retention(RetentionPolicy.RUNTIME)
   ' T8 c0 f* {/ u5 J$ v4 D
9. @Target(ElementType.TYPE) //on class level
   
10. public @interface TesterInfo {
    9 l  ?; b% h* o3 t8 Y4 E! C
11. 
    - J7 i0 T0 D' ~! ~& W
12.         public enum Priority {
    8 b8 }$ U6 u/ n2 d" W1 G* u2 E
13.            LOW, MEDIUM, HIGH
    
14.         }
    + _& A6 L: i- h: t& o* D/ \/ o( U
15. 
    
16.         Priority priority() default Priority.MEDIUM;
    
17. 
    
18.         String[] tags() default "";
    
19. 
    
20.         String createdBy() default "Mkyong";
    
21. 
    
22.         String lastModified() default "03/01/2014";
    ; z* q0 e" L2 ^& i
23. 
    8 O/ z  R) s2 ^0 I0 C  j( M
24. }

复制代码

柯拉松

3. Unit Test Example
1 ]* V% R' k7 `' q- ^新建一个简单的单元测试实例，并且通过新建的标注来标注：@Test and @TesterInfo
! N* g8 Y6 H# e
TestExample.java

1. package com.mkyong.test;
   % z  `8 \$ J: _
2. 
   
3. import com.mkyong.test.core.Test;
   5 v0 _, W! H1 X+ t$ B& x) x
4. import com.mkyong.test.core.TesterInfo;
   " O& c. d2 m8 P! Q) I
5. import com.mkyong.test.core.TesterInfo.Priority;
   
6. 
   1 ]' z% W% i6 j( V& g9 x6 Z! Y' x- p
7. @TesterInfo(
   
8.         priority = Priority.HIGH,
   
9.         createdBy = "mkyong.com",  
   - a8 l( h- u4 u
10.         tags = {"sales","test" }
    
11. )
    
12. public class TestExample {
    
13. 
    
14.         @Test
    : g2 A3 c# k( x& N
15.         void testA() {
    ; L* |: N. Y) H' `9 ~" g
16.           if (true)
    
17.                 throw new RuntimeException("This test always failed");
    
18.         }
    
19. 
    : ~, k4 m9 @" v3 L% ~1 r3 p
20.         @Test(enabled = false)
    * D9 m, ?* `  k3 M4 O! W
21.         void testB() {
    
22.           if (false)
    
23.                 throw new RuntimeException("This test always passed");
    9 _  q6 v" g( p) N- v
24.         }
    
25. 
    % X  w% ~# \& I4 [$ \- ?  x7 N
26.         @Test(enabled = true)
    
27.         void testC() {
    
28.           if (10 > 1) {
    
29.                 // do nothing, this test always passed.
    
30.           }
    4 e1 Z% r+ o1 {1 F- Z
31.         }
    
32. 
    $ [- l5 E) s  F( s- o! T* W, Q' x: m  A
33. }

复制代码

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

RunTest.java

1. package com.mkyong.test;
   - @9 E1 n. x* W8 G
2. 
   
3. import java.lang.annotation.Annotation;
   
4. import java.lang.reflect.Method;
   ; m, q$ v0 N9 Y
5. 
   
6. import com.mkyong.test.core.Test;
   
7. import com.mkyong.test.core.TesterInfo;
   1 y/ @" f& s- b( ~: [
8. 
   
9. public class RunTest {
   
10. 
    
11.   public static void main(String[] args) throws Exception {
    
12. 
    
13.         System.out.println("Testing...");
    " K; G  ~- L) n* B1 ~5 O, T  x
14. 
    3 J1 I8 w0 K0 J
15.         int passed = 0, failed = 0, count = 0, ignore = 0;
    ( s8 s$ G: H4 e% v: D
16. 
    2 ]8 p; o: y4 ^# n9 [
17.         Class<TestExample> obj = TestExample.class;
    
18. 
    
19.         // Process @TesterInfo
    
20.         if (obj.isAnnotationPresent(TesterInfo.class)) {
    
21. 
    
22.                 Annotation annotation = obj.getAnnotation(TesterInfo.class);
    - k6 {& \1 I* T' f2 Y% \0 z
23.                 TesterInfo testerInfo = (TesterInfo) annotation;
    
24. 
    
25.                 System.out.printf("%nPriority :%s", testerInfo.priority());
    
26.                 System.out.printf("%nCreatedBy :%s", testerInfo.createdBy());
      {. M7 X/ n' C# M
27.                 System.out.printf("%nTags :");
    
28. 
    . x- {$ `. }' c
29.                 int tagLength = testerInfo.tags().length;
    + {; x, ?2 V$ l# t) A) x4 I, o: U/ k
30.                 for (String tag : testerInfo.tags()) {
    9 T1 o8 a1 W+ e, |; r! C( ]$ s1 _
31.                         if (tagLength > 1) {
    
32.                                 System.out.print(tag + ", ");
    
33.                         } else {
    ' I/ t1 @3 r6 i/ Y; k. U$ X
34.                                 System.out.print(tag);
    
35.                         }
    8 z0 r, {  o6 i& `
36.                         tagLength--;
    , V$ [: z& c1 x- n9 o! A2 {: E
37.                 }
    ; Y+ F( G2 f5 W- n3 G
38. 
    
39.                 System.out.printf("%nLastModified :%s%n%n", testerInfo.lastModified());
    
40. 
    2 B; a' }: ~8 e8 Q* Q
41.         }
    ' A( k. o6 j( C4 |! R3 `5 T
42. 
    / D) w7 B4 q) G: B
43.         // Process @Test
    
44.         for (Method method : obj.getDeclaredMethods()) {
    
45. 
    
46.                 // if method is annotated with @Test
    
47.                 if (method.isAnnotationPresent(Test.class)) {
    
48. 
    
49.                         Annotation annotation = method.getAnnotation(Test.class);
    
50.                         Test test = (Test) annotation;
    
51. 
    
52.                         // if enabled = true (default)
    ; s! v7 [# f" O+ r" e0 A8 y( v  Y
53.                         if (test.enabled()) {
    ! z* R- b! _+ m1 X, i0 e! c' c& W
54. 
    
55.                           try {
    # F# `5 o9 B' J8 p3 g
56.                                 method.invoke(obj.newInstance());
    2 O( U$ p( f6 }: X$ C. @
57.                                 System.out.printf("%s - Test '%s' - passed %n", ++count, method.getName());
    / }7 n* s+ _( A9 |
58.                                 passed++;
    8 o" z; c8 \$ d- l7 L8 \& g
59.                           } catch (Throwable ex) {
    
60.                                 System.out.printf("%s - Test '%s' - failed: %s %n", ++count, method.getName(), ex.getCause());
    
61.                                 failed++;
    
62.                           }
    
63. 
    
64.                         } else {
    
65.                                 System.out.printf("%s - Test '%s' - ignored%n", ++count, method.getName());
    
66.                                 ignore++;
    ( G4 a& t& I- V9 y* J: H- s$ n/ u6 x- N
67.                         }
    " o( b5 O$ \  |$ E$ L
68. 
    9 }/ c+ n# G% V$ `) j5 E4 x
69.                 }
    
70. 
    
71.         }
    
72.         System.out.printf("%nResult : Total : %d, Passed: %d, Failed %d, Ignore %d%n", count, passed, failed, ignore);
    % n% W  R0 [4 E& b
73. 
    % L; I+ T1 @; ?9 _
74.         }
    4 g, E! w+ k/ b4 w0 z, |
75. }

复制代码

2 ]  @6 E6 Q  @9 w* K0 C9 e$ _9 JOutput

1. Testing...
   
2. 
   
3. Priority :HIGH
   5 q$ b& e% ]; w  c
4. CreatedBy :mkyong.com
   ; N7 N' v: t4 z* X: ?
5. Tags :sales, <strong>test</strong>
   1 U' K* _* h$ `9 ^& n
6. LastModified :03<strong>/</strong>01<strong>/</strong><span style="color:#000000">2014</span>
   & [& C2 Q" A% U! ~+ d/ {" h9 K
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
   
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. 
    
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
自定义标签？

注解- -。。