java自定义标注实例

柯拉松

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

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

[size=13.043478965759277px]Test.java

1. package com.mkyong.test.core;
   2 d6 S: ]/ e; V" z+ ^
2. 
   
3. import java.lang.annotation.ElementType;
   1 s8 k& D: [, I3 `
4. import java.lang.annotation.Retention;
   
5. import java.lang.annotation.RetentionPolicy;
   
6. import java.lang.annotation.Target;
   
7. 
   ) A6 Q  c' R8 s2 D2 t9 a" X
8. @Retention(RetentionPolicy.RUNTIME)
   
9. @Target(ElementType.METHOD) //can use in method only.
   
10. public @interface Test {
    
11. 
    
12.         //should ignore this test?
    
13.         public boolean enabled() default true;
    $ O' E2 z) k; x
14. 
    1 A7 `! q! o* f; K2 H" H
15. }</font></font>

复制代码

注意
3 L/ ^: n* H7 B# F! N2 Y! w方法申明必须不能带有任何参数或throws片段，返回类型限制为基本类型，字符串String，类Class，枚举eunms，标注和这些类型的数组
) g, c! t- k2 x
0 j7 h( q# |2 I: C% k- r3 e7 Q2. @TesterInfo Annotation
@TesterInfo应用到类级别，保存tester的详情。这个类演示返回不同的类型：enum, array and string
TesterInfo.java

1. package com.mkyong.test.core;
   
2. 
   
3. import java.lang.annotation.ElementType;
   
4. import java.lang.annotation.Retention;
   
5. import java.lang.annotation.RetentionPolicy;
   8 i8 G4 Y; F: P* f2 r/ @- X" f# E
6. import java.lang.annotation.Target;
   
7. 
   * X% y, e3 ~, {/ H0 t5 {0 v
8. @Retention(RetentionPolicy.RUNTIME)
   6 P# x- d- b* C; }- A2 n
9. @Target(ElementType.TYPE) //on class level
   
10. public @interface TesterInfo {
    ! ]9 a* Q$ r2 ]5 e+ a/ E
11. 
    " Z) H$ Y/ v9 l6 s) U, Y, A+ f
12.         public enum Priority {
    * E6 G8 W  o3 ]0 b4 b
13.            LOW, MEDIUM, HIGH
    
14.         }
    + A  F" r% p8 [" q$ z0 c
15. 
    
16.         Priority priority() default Priority.MEDIUM;
    
17. 
    
18.         String[] tags() default "";
    
19. 
    
20.         String createdBy() default "Mkyong";
    ; o- p: g; H! Q' n) O
21. 
    
22.         String lastModified() default "03/01/2014";
    
23. 
      c/ F% x, R9 q( h& M
24. }

复制代码

柯拉松

3. Unit Test Example
% T! K5 U/ N) s# m/ w新建一个简单的单元测试实例，并且通过新建的标注来标注：@Test and @TesterInfo
& ?$ W; `+ H4 c7 |* C- i+ d
6 y6 S1 `. Q! q: B  P) hTestExample.java

1. package com.mkyong.test;
   8 ^2 V9 s9 L; W: q& V
2. 
   
3. import com.mkyong.test.core.Test;
   
4. import com.mkyong.test.core.TesterInfo;
   # W( j: e9 A- L  J: L
5. import com.mkyong.test.core.TesterInfo.Priority;
   ) c% z; b: G1 M) A  G: J
6. 
   
7. @TesterInfo(
   
8.         priority = Priority.HIGH,
   ' t0 L( ?5 Z' C$ T+ x7 `4 j
9.         createdBy = "mkyong.com",  
   2 F% h5 q. J" w$ T$ p
10.         tags = {"sales","test" }
    
11. )
    
12. public class TestExample {
    ( \$ r" m1 \/ \, Y
13. 
    
14.         @Test
    5 A2 J' z6 R, O" o- R
15.         void testA() {
      Y  w2 n- b# O0 Q* G
16.           if (true)
    
17.                 throw new RuntimeException("This test always failed");
    5 ^& L+ [: o; l6 p
18.         }
    & N% Y6 K% g% n# Z& o
19. 
    
20.         @Test(enabled = false)
    4 Y+ K4 L. S* K  P2 X9 T: S
21.         void testB() {
    2 S+ u" D% ?# k+ E
22.           if (false)
    
23.                 throw new RuntimeException("This test always passed");
    
24.         }
    
25. 
    , P' ]. p, S2 w' X
26.         @Test(enabled = true)
    5 I' R. ]+ P* Q3 n- D* n( v: V5 p
27.         void testC() {
    & w& w2 n- o; R4 Q4 w% g
28.           if (10 > 1) {
    
29.                 // do nothing, this test always passed.
    5 W0 {; V1 P# B3 o% V. r
30.           }
    
31.         }
    
32. 
    3 S% O. z/ W6 `: O7 o* I$ Z
33. }

复制代码

4. Java reflection – Read the Annotation下面的例子演示如何通过java反射来读取和处理自定义标注。
1 B( q7 a  f9 G3 s
RunTest.java

1. package com.mkyong.test;
   
2. 
   
3. import java.lang.annotation.Annotation;
   
4. import java.lang.reflect.Method;
   1 ~( t  v; k  D! p
5. 
   
6. import com.mkyong.test.core.Test;
   
7. import com.mkyong.test.core.TesterInfo;
   
8. 
   2 m7 g, N; w3 K' U
9. public class RunTest {
   
10. 
    3 n" r, y4 Y* V
11.   public static void main(String[] args) throws Exception {
    3 f+ f( W0 A) r6 ^' {2 a# W
12. 
    0 R3 E, m/ B1 A1 f6 D# K9 S( c
13.         System.out.println("Testing...");
    
14. 
    
15.         int passed = 0, failed = 0, count = 0, ignore = 0;
    
16. 
    $ G, E! L8 t0 T! j2 w  S
17.         Class<TestExample> obj = TestExample.class;
    7 O( ?, k4 J& j( b' t3 w  j
18. 
    " L7 g) Z9 O8 k; Z& r
19.         // Process @TesterInfo
    
20.         if (obj.isAnnotationPresent(TesterInfo.class)) {
    
21. 
    
22.                 Annotation annotation = obj.getAnnotation(TesterInfo.class);
    
23.                 TesterInfo testerInfo = (TesterInfo) annotation;
    / j# H! a& F" q  C3 O5 H- G
24. 
    : l; D# G. a# o6 z5 d
25.                 System.out.printf("%nPriority :%s", testerInfo.priority());
    / o' g" E' r' R. M; B
26.                 System.out.printf("%nCreatedBy :%s", testerInfo.createdBy());
    
27.                 System.out.printf("%nTags :");
    - }* e& y8 f3 }
28. 
    
29.                 int tagLength = testerInfo.tags().length;
    1 a! s8 _" \0 Y* X1 |) o
30.                 for (String tag : testerInfo.tags()) {
    : s! V: ~2 s% O2 }
31.                         if (tagLength > 1) {
    
32.                                 System.out.print(tag + ", ");
    
33.                         } else {
    
34.                                 System.out.print(tag);
    
35.                         }
    / c6 t/ ^% z8 M; [' \
36.                         tagLength--;
    ) A8 _/ U0 g9 `3 j4 t% a
37.                 }
    ! W1 o% ?# u! y" X" O& J- s2 j
38. 
    ( D8 x# T9 d5 t* {- U
39.                 System.out.printf("%nLastModified :%s%n%n", testerInfo.lastModified());
    * D1 @6 b, S- i% G
40. 
      a8 e9 N. F/ ?
41.         }
      ~( T8 S8 T* h2 S+ z/ z* r
42. 
    4 C0 `0 y/ H. H5 }7 {1 {" L
43.         // Process @Test
    
44.         for (Method method : obj.getDeclaredMethods()) {
    
45. 
    9 a% }( K2 m: j! i! w! u
46.                 // if method is annotated with @Test
    
47.                 if (method.isAnnotationPresent(Test.class)) {
    
48. 
    9 _% B7 k7 v% O1 i" W8 x
49.                         Annotation annotation = method.getAnnotation(Test.class);
    ' h. w+ r, D' |5 P! f" ?
50.                         Test test = (Test) annotation;
    1 h3 b6 e) g% m5 _+ m8 f# K
51. 
    
52.                         // if enabled = true (default)
    
53.                         if (test.enabled()) {
    / p* y  [, o3 T- S
54. 
    
55.                           try {
    
56.                                 method.invoke(obj.newInstance());
    
57.                                 System.out.printf("%s - Test '%s' - passed %n", ++count, method.getName());
    
58.                                 passed++;
    3 {' z- L" f- h" a2 G1 f
59.                           } catch (Throwable ex) {
    
60.                                 System.out.printf("%s - Test '%s' - failed: %s %n", ++count, method.getName(), ex.getCause());
    
61.                                 failed++;
    
62.                           }
    - q% u/ J4 _. `  l, U2 u
63. 
    
64.                         } else {
    
65.                                 System.out.printf("%s - Test '%s' - ignored%n", ++count, method.getName());
    
66.                                 ignore++;
    . m* z. ]4 ~- ^, o# l% ]
67.                         }
      Z& Z+ G& d3 l9 i: \
68. 
    
69.                 }
    2 d1 v" ]3 _- e( E# n
70. 
    : _4 b7 v' ^9 T- o) X# o
71.         }
    
72.         System.out.printf("%nResult : Total : %d, Passed: %d, Failed %d, Ignore %d%n", count, passed, failed, ignore);
    
73. 
    * ?0 r; A- }' J, R1 q6 m
74.         }
    
75. }

复制代码

! P" P. m: l, j+ nOutput

1. Testing...
   , Y" i0 h9 W5 h  F7 x% @2 E' k
2. 
   
3. Priority :HIGH
   % t1 U% c$ R  H  ^( E1 p
4. CreatedBy :mkyong.com
   & I" s/ y) \! ]9 q
5. Tags :sales, <strong>test</strong>
   4 l7 e8 ~; |1 y" ?1 h6 u0 y
6. LastModified :03<strong>/</strong>01<strong>/</strong><span style="color:#000000">2014</span>
     K  R# c( ]$ V3 d2 S
7. 
   & X6 w/ F9 c% e- y6 |
8. <span style="color:#000000">1</span> - Test <span style="color:#ff0000">'testA'</span> - failed: java.lang.RuntimeException: This <strong>test</strong> always failed
   ( }7 z& v% a5 v
9. <span style="color:#000000">2</span> - Test <span style="color:#ff0000">'testC'</span> - passed
   - V$ X  S6 d( n! c5 [+ x; q
10. <span style="color:#000000">3</span> - Test <span style="color:#ff0000">'testB'</span> - ignored
    : `9 x2 N$ u. r4 d9 t
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
自定义标签？

注解- -。。