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;
   ' q% a* O, [$ g- O6 j8 p6 N8 h1 V
4. import java.lang.annotation.Retention;
   3 A) z$ j  k& L: a
5. import java.lang.annotation.RetentionPolicy;
   
6. import java.lang.annotation.Target;
   
7. 
   
8. @Retention(RetentionPolicy.RUNTIME)
   5 n) h. ~1 D5 W% U0 V* f
9. @Target(ElementType.METHOD) //can use in method only.
   5 Y4 P/ L& S$ }) N( w4 J1 p; V8 K
10. public @interface Test {
    
11. 
    7 N7 d- x* a: s+ Y
12.         //should ignore this test?
    ( M; h9 r( K6 u0 }* B- Y
13.         public boolean enabled() default true;
      y- Q5 _+ q* q: Z7 L. ~
14. 
    
15. }</font></font>

复制代码

注意
! Q' w8 R; `" V4 g4 R! z# g方法申明必须不能带有任何参数或throws片段，返回类型限制为基本类型，字符串String，类Class，枚举eunms，标注和这些类型的数组
4 \& H, x1 h( A9 q! u! c
3 R- A* l" N; K& d0 n9 H2. @TesterInfo Annotation
@TesterInfo应用到类级别，保存tester的详情。这个类演示返回不同的类型：enum, array and string
TesterInfo.java
! x; Q! G" ^0 H8 q1 m& u

1. package com.mkyong.test.core;
   , s( S& k4 P' e: D( X9 [0 p
2. 
   
3. import java.lang.annotation.ElementType;
   + G$ e: c6 X$ l" u* v
4. import java.lang.annotation.Retention;
   3 |* H' P2 |* b; u: A1 g3 T
5. import java.lang.annotation.RetentionPolicy;
   1 x9 J' r, b- K5 t6 u
6. import java.lang.annotation.Target;
   
7. 
   2 r$ V! {8 V( C
8. @Retention(RetentionPolicy.RUNTIME)
   7 |( Y. ]& G8 E0 S# a! r/ f+ j$ L
9. @Target(ElementType.TYPE) //on class level
   
10. public @interface TesterInfo {
    
11. 
    
12.         public enum Priority {
    
13.            LOW, MEDIUM, HIGH
    
14.         }
    + |/ j! \+ X* B! G7 Z
15. 
    " g& f2 ^# p; _/ L
16.         Priority priority() default Priority.MEDIUM;
    
17. 
    $ X; l3 l/ E* X) K9 |% v" E2 E0 G' E
18.         String[] tags() default "";
    
19. 
    : r6 t+ x: ]# v1 T' m
20.         String createdBy() default "Mkyong";
    ( p( d3 b0 Y1 Y; o
21. 
    
22.         String lastModified() default "03/01/2014";
    ' F% S% Z% N- e7 v; e4 O
23. 
    4 S8 k9 @2 @! s6 E5 B; I1 V, l8 g
24. }

复制代码

柯拉松

3. Unit Test Example
% D( \% e" _1 }* c* s1 ]新建一个简单的单元测试实例，并且通过新建的标注来标注：@Test and @TesterInfo
" N( `% a0 K* Q+ `/ l5 c  A! |  ]
TestExample.java

1. package com.mkyong.test;
   
2. 
   8 ^% o8 n! a# k: S* ~7 d  W- P1 Y
3. import com.mkyong.test.core.Test;
   - G- m  d# w2 F+ C
4. import com.mkyong.test.core.TesterInfo;
   
5. import com.mkyong.test.core.TesterInfo.Priority;
   
6. 
   7 [* ~8 Y( M. p: s! t- Y
7. @TesterInfo(
   
8.         priority = Priority.HIGH,
   
9.         createdBy = "mkyong.com",  
   
10.         tags = {"sales","test" }
    ' t& L0 g7 o5 c! K4 ?0 q9 r  q
11. )
    + N; Q" X7 z* e
12. public class TestExample {
    
13. 
    ; m3 q  r. q/ i
14.         @Test
    + w- W5 H/ k* X6 D
15.         void testA() {
    . p: s$ M  o' m! Q  N. P9 b6 q& m
16.           if (true)
      G( l1 c  l6 g
17.                 throw new RuntimeException("This test always failed");
    
18.         }
    9 V8 P) T, m, U' U
19. 
    0 L# s" n! b  C" P. D/ u; B
20.         @Test(enabled = false)
    * x7 ^! Y( D, v) Q: @
21.         void testB() {
    3 A3 G+ p0 M+ A6 f% C: W# u& \$ ?
22.           if (false)
    
23.                 throw new RuntimeException("This test always passed");
    
24.         }
    
25. 
    
26.         @Test(enabled = true)
    
27.         void testC() {
    4 k$ i, o( [) B" \
28.           if (10 > 1) {
    
29.                 // do nothing, this test always passed.
    ; R1 Q0 A+ ~: \- k* ]- c
30.           }
    # r0 q5 o# y' ?( U
31.         }
    
32. 
    3 F2 T+ Y, o1 U* t! ]( o
33. }

复制代码

4. Java reflection – Read the Annotation下面的例子演示如何通过java反射来读取和处理自定义标注。
/ W/ D: V" Q2 V! ]. V) Z/ C& S
RunTest.java

1. package com.mkyong.test;
   9 q( g: i2 ^" {3 ]/ T$ B
2. 
   
3. import java.lang.annotation.Annotation;
   
4. import java.lang.reflect.Method;
   * G" S: r  K. y9 r
5. 
   6 c! o$ W% f3 o. R/ y
6. import com.mkyong.test.core.Test;
     |) a5 Q/ d! o/ a% B8 `8 g& S
7. import com.mkyong.test.core.TesterInfo;
   # a; g/ v5 H6 G1 ~0 K0 M4 S; z" o
8. 
   
9. public class RunTest {
   ( f4 }5 q1 }$ |8 l6 H
10. 
    8 i' q% S. R+ b* W) w3 o
11.   public static void main(String[] args) throws Exception {
    
12. 
    
13.         System.out.println("Testing...");
    4 q# Z6 k$ w( S1 p
14. 
    
15.         int passed = 0, failed = 0, count = 0, ignore = 0;
    
16. 
    2 [: K8 v4 Y9 q, C2 I
17.         Class<TestExample> obj = TestExample.class;
    
18. 
    0 H1 J/ W; V6 u& {  Z
19.         // Process @TesterInfo
    " k. g2 J  _. `! P. G4 }' g6 N
20.         if (obj.isAnnotationPresent(TesterInfo.class)) {
    ( b# E  p, G* P9 T# n: Q
21. 
    6 l, W# u" Y! |) L, h
22.                 Annotation annotation = obj.getAnnotation(TesterInfo.class);
    ! o+ Z. q8 Q( u0 z4 e& P# C) G2 }
23.                 TesterInfo testerInfo = (TesterInfo) annotation;
    + U2 p+ ]8 l' z! e( y! Z  \3 A7 B  Z6 g
24. 
    2 g- x* R: c+ q( q( l5 Q
25.                 System.out.printf("%nPriority :%s", testerInfo.priority());
    - X, d# `7 h& y2 w7 U
26.                 System.out.printf("%nCreatedBy :%s", testerInfo.createdBy());
    
27.                 System.out.printf("%nTags :");
    
28. 
    
29.                 int tagLength = testerInfo.tags().length;
    & i- o; s5 z, W, D
30.                 for (String tag : testerInfo.tags()) {
    
31.                         if (tagLength > 1) {
    . Y5 ?, {) C1 g# Y
32.                                 System.out.print(tag + ", ");
    - @) u, _! Z! n0 ~2 V* X
33.                         } else {
    
34.                                 System.out.print(tag);
    & X$ ?, J: x& I* P' j
35.                         }
    
36.                         tagLength--;
    
37.                 }
    7 D3 n/ i% P* p8 ?8 F, |! `" ?
38. 
    + v, M/ _6 G3 R* e( }4 r' D/ {8 h/ q
39.                 System.out.printf("%nLastModified :%s%n%n", testerInfo.lastModified());
    
40. 
    " p5 T1 s: X4 k/ Y
41.         }
    
42. 
    
43.         // Process @Test
    
44.         for (Method method : obj.getDeclaredMethods()) {
    
45. 
    ( U0 p9 J" P! y0 r9 [7 _
46.                 // if method is annotated with @Test
    . K1 e* Y( q/ `
47.                 if (method.isAnnotationPresent(Test.class)) {
    
48. 
    . L1 X  T, I6 Q4 [+ P; [
49.                         Annotation annotation = method.getAnnotation(Test.class);
    9 X; f# v" n1 W: D& \4 W
50.                         Test test = (Test) annotation;
    
51. 
    
52.                         // if enabled = true (default)
    ; v6 T# F, h" P. r' c4 H
53.                         if (test.enabled()) {
    
54. 
    ; ~  c) Y4 t$ _+ M4 J5 D3 }7 e6 ]
55.                           try {
    6 G. J# g" N( C$ n5 u8 ]
56.                                 method.invoke(obj.newInstance());
    
57.                                 System.out.printf("%s - Test '%s' - passed %n", ++count, method.getName());
    ( ~* w  g8 p- S8 T3 `" b+ n% h
58.                                 passed++;
    
59.                           } catch (Throwable ex) {
    
60.                                 System.out.printf("%s - Test '%s' - failed: %s %n", ++count, method.getName(), ex.getCause());
    
61.                                 failed++;
    
62.                           }
    5 i' G" k1 `) ~' j/ m& L
63. 
    . c7 M2 m2 s2 ~9 u6 V; G
64.                         } else {
    1 E' g' e# g& m
65.                                 System.out.printf("%s - Test '%s' - ignored%n", ++count, method.getName());
    
66.                                 ignore++;
    
67.                         }
    - _8 A+ }4 \- `2 ?# \
68. 
    
69.                 }
    3 `" C$ _2 V0 D/ k1 z' P0 [
70. 
    7 ~; b6 M; V$ y- s3 z
71.         }
    3 l8 I0 S5 q2 o  n& k
72.         System.out.printf("%nResult : Total : %d, Passed: %d, Failed %d, Ignore %d%n", count, passed, failed, ignore);
    
73. 
    ( c- q- [- y$ ]" \  x. p
74.         }
    # w* g5 m1 O) G8 e3 Z: q
75. }

复制代码

Output

1. Testing...
   . S) L  M8 t* i7 i& Y
2. 
   
3. Priority :HIGH
   
4. CreatedBy :mkyong.com
   $ J( q8 r- [( o
5. Tags :sales, <strong>test</strong>
   
6. LastModified :03<strong>/</strong>01<strong>/</strong><span style="color:#000000">2014</span>
   ! T/ a# h# F- j
7. 
   ( T( f0 g& S- x% t- o
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
    7 i: B. T% V8 Q
11. 
    9 T# C. U, F5 e( N
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
自定义标签？

注解- -。。