java自定义标注实例

柯拉松

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

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

[size=13.043478965759277px]Test.java

1. package com.mkyong.test.core;
   
2. 
   $ T$ J& r: g% Q& ]9 i
3. import java.lang.annotation.ElementType;
   
4. import java.lang.annotation.Retention;
   
5. import java.lang.annotation.RetentionPolicy;
   
6. import java.lang.annotation.Target;
   ) g- [" `0 R0 {6 w5 G, f8 _) n* ~/ }
7. 
   ' H( v1 `& M8 N! O
8. @Retention(RetentionPolicy.RUNTIME)
   $ y0 V# E$ {* X3 A& |4 O
9. @Target(ElementType.METHOD) //can use in method only.
   ( X: V* ]: E2 h4 O+ O# P
10. public @interface Test {
    
11. 
    
12.         //should ignore this test?
    5 Y8 P4 M, ]* F+ o
13.         public boolean enabled() default true;
    
14. 
    
15. }</font></font>

复制代码

注意
方法申明必须不能带有任何参数或throws片段，返回类型限制为基本类型，字符串String，类Class，枚举eunms，标注和这些类型的数组
8 ~' |) _: L) F1 K4 b9 l
5 M2 g7 ]. R; w0 y. G4 B2. @TesterInfo Annotation
@TesterInfo应用到类级别，保存tester的详情。这个类演示返回不同的类型：enum, array and string
% q" e1 ]8 |$ I( }- E7 vTesterInfo.java
" W+ C9 h  T8 G3 B8 l$ @& F  N$ F

1. package com.mkyong.test.core;
   
2. 
   ! Q, a# v6 k" ~+ R7 h, K
3. import java.lang.annotation.ElementType;
   
4. import java.lang.annotation.Retention;
   
5. import java.lang.annotation.RetentionPolicy;
   : R1 s0 E6 `: ~& i( [
6. import java.lang.annotation.Target;
   7 v6 h4 q( J& ?& I9 K% D6 m
7. 
   
8. @Retention(RetentionPolicy.RUNTIME)
   
9. @Target(ElementType.TYPE) //on class level
   0 U6 E$ K$ S' @1 A
10. public @interface TesterInfo {
    
11. 
    / F. P) p% q6 M; B: _' ?
12.         public enum Priority {
    % Z1 Q, L8 V' z' q* g
13.            LOW, MEDIUM, HIGH
    
14.         }
    
15. 
    * P: N( @: s$ W% @4 ~  z, C( o  \% _
16.         Priority priority() default Priority.MEDIUM;
    
17. 
    
18.         String[] tags() default "";
    
19. 
    - Y; B' R/ Q& A$ a& \( D
20.         String createdBy() default "Mkyong";
    ( n- d$ {! d* l0 ^( j! y6 I# k% ^
21. 
    8 F/ z# A1 e! ]+ n+ Z" ^  d# }
22.         String lastModified() default "03/01/2014";
    
23. 
    $ H, M' o- t: W  p
24. }

复制代码

柯拉松

3. Unit Test Example
; ^9 G; E2 p& ~/ E) T新建一个简单的单元测试实例，并且通过新建的标注来标注：@Test and @TesterInfo

$ p, b, A* @$ KTestExample.java

1. package com.mkyong.test;
   
2. 
   
3. import com.mkyong.test.core.Test;
   
4. import com.mkyong.test.core.TesterInfo;
   
5. import com.mkyong.test.core.TesterInfo.Priority;
   
6. 
   
7. @TesterInfo(
   3 y. x6 g+ B/ E0 i  q6 P: R$ K
8.         priority = Priority.HIGH,
   
9.         createdBy = "mkyong.com",  
   
10.         tags = {"sales","test" }
    1 d" i3 d' ~. X. w, R/ s, U
11. )
    
12. public class TestExample {
    
13. 
    
14.         @Test
    6 H  _& d6 D' T8 o
15.         void testA() {
    
16.           if (true)
    % H1 J8 q6 o8 T: R# w
17.                 throw new RuntimeException("This test always failed");
    9 e6 C, t! Y' V2 x0 d! j* D
18.         }
    
19. 
    
20.         @Test(enabled = false)
    0 j! ~0 s2 m* k7 G9 m( M1 I
21.         void testB() {
    
22.           if (false)
    
23.                 throw new RuntimeException("This test always passed");
    
24.         }
    
25. 
    . g$ I7 t2 C  t/ z" ~
26.         @Test(enabled = true)
    
27.         void testC() {
    
28.           if (10 > 1) {
    5 s( r' Q( x& `, U
29.                 // do nothing, this test always passed.
    
30.           }
    ( t6 I1 j8 J) i" d7 q2 S
31.         }
    / E/ D, x% C! y, O1 s* D9 U
32. 
    - @2 J  G4 A# C* X/ J6 Q# i
33. }

复制代码

" K7 t& R# ^& D3 Y2 B9 ~. R: Y4. Java reflection – Read the Annotation下面的例子演示如何通过java反射来读取和处理自定义标注。
6 H% D" `* }4 j- j& A8 Q
. o# |9 n! B3 y' _/ A$ g, ]2 wRunTest.java

1. package com.mkyong.test;
   $ r: p; r7 k9 z& ?2 C' d2 e" `
2. 
   
3. import java.lang.annotation.Annotation;
   9 f* e; v! d9 H3 C2 k
4. import java.lang.reflect.Method;
   
5. 
   7 Y* d1 K4 k% e7 d$ k
6. import com.mkyong.test.core.Test;
   
7. import com.mkyong.test.core.TesterInfo;
   
8. 
   , ?; h3 z/ H1 B# k
9. public class RunTest {
     @4 y* p& T! E! b. h+ w
10. 
    ; ~. c# H8 _7 D4 Z. Q3 o" H
11.   public static void main(String[] args) throws Exception {
    
12. 
    9 m7 J& A& ^. g
13.         System.out.println("Testing...");
    
14. 
    # ~, e+ x& s2 H$ ?# r
15.         int passed = 0, failed = 0, count = 0, ignore = 0;
    
16. 
    0 K1 i9 l5 F+ F' g; X- z
17.         Class<TestExample> obj = TestExample.class;
    0 r5 p4 D% ]$ X- o! r. O2 J. a
18. 
    ' r! d- i2 P' K
19.         // Process @TesterInfo
    # s, d; ^9 g+ ?1 |
20.         if (obj.isAnnotationPresent(TesterInfo.class)) {
    : {( F* O+ r+ m& ~* j! V1 W% Y
21. 
    / s5 E! N& ]+ J' D; z* a) ^7 _
22.                 Annotation annotation = obj.getAnnotation(TesterInfo.class);
    - C1 e- S4 |* o/ L' g* U" w
23.                 TesterInfo testerInfo = (TesterInfo) annotation;
    
24. 
    & @6 p- u% O: i, y, _) O) d
25.                 System.out.printf("%nPriority :%s", testerInfo.priority());
    
26.                 System.out.printf("%nCreatedBy :%s", testerInfo.createdBy());
    . m+ n& y' z% l8 C; J$ O3 k
27.                 System.out.printf("%nTags :");
    
28. 
    
29.                 int tagLength = testerInfo.tags().length;
    
30.                 for (String tag : testerInfo.tags()) {
    
31.                         if (tagLength > 1) {
    
32.                                 System.out.print(tag + ", ");
    + V$ ^# F% a, @! c9 c
33.                         } else {
    
34.                                 System.out.print(tag);
    
35.                         }
    2 N2 u4 Y5 H9 ~& P1 }  h9 s- E
36.                         tagLength--;
    
37.                 }
    
38. 
    
39.                 System.out.printf("%nLastModified :%s%n%n", testerInfo.lastModified());
    / `& X5 B# e( O0 G0 P2 R
40. 
    
41.         }
    
42. 
    
43.         // Process @Test
    4 D- ]7 Q" y6 L1 t2 i2 i4 m) o
44.         for (Method method : obj.getDeclaredMethods()) {
    
45. 
    
46.                 // if method is annotated with @Test
    
47.                 if (method.isAnnotationPresent(Test.class)) {
    ' c) R! M5 |5 ~5 V1 H, r
48. 
    9 V7 x1 k  N( l- h4 e" g
49.                         Annotation annotation = method.getAnnotation(Test.class);
    
50.                         Test test = (Test) annotation;
    
51. 
    
52.                         // if enabled = true (default)
    
53.                         if (test.enabled()) {
    
54. 
    
55.                           try {
    % J8 Z8 n" z) E$ X
56.                                 method.invoke(obj.newInstance());
    % ?5 c' P4 x0 B4 ]; W+ x2 t; K+ m+ _6 j7 N
57.                                 System.out.printf("%s - Test '%s' - passed %n", ++count, method.getName());
    + G. L* s/ Y: w/ F8 O
58.                                 passed++;
    
59.                           } catch (Throwable ex) {
    2 ?) H5 j0 Q- Z0 e3 d. @
60.                                 System.out.printf("%s - Test '%s' - failed: %s %n", ++count, method.getName(), ex.getCause());
    1 f9 V8 [9 ]$ i3 p8 }6 h. ]
61.                                 failed++;
    
62.                           }
    
63. 
    
64.                         } else {
    - p, i- d% e! t: Y2 j
65.                                 System.out.printf("%s - Test '%s' - ignored%n", ++count, method.getName());
    6 e( |. S& a1 T6 \0 q' ]
66.                                 ignore++;
    3 P$ s  j, w6 i5 S, J; l" G
67.                         }
    4 d% X7 q; @( k$ I9 b" c
68. 
    ' u3 @& I6 z, E9 T
69.                 }
    
70. 
    
71.         }
    
72.         System.out.printf("%nResult : Total : %d, Passed: %d, Failed %d, Ignore %d%n", count, passed, failed, ignore);
    0 k3 f7 Z* \) D* d# r. f  Z
73. 
    
74.         }
    ) S5 e- s6 W# v2 h1 a
75. }

复制代码

& i/ ^1 _1 `( |1 Y) P$ i. YOutput

1. Testing...
   9 |, ^  f6 C  J0 o
2. 
   
3. Priority :HIGH
   $ G3 {  _: H" d, \$ c; b
4. CreatedBy :mkyong.com
   
5. Tags :sales, <strong>test</strong>
   - l5 Z, j; V2 D1 r
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
   0 `# t: O7 G1 y
9. <span style="color:#000000">2</span> - Test <span style="color:#ff0000">'testC'</span> - passed
   $ f" q9 K3 |7 F3 ]! K
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
" ^% e  f) Q0 n# q" p# n自定义标签？

注解- -。。