java自定义标注实例

柯拉松

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

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

[size=13.043478965759277px]Test.java

1. package com.mkyong.test.core;
   
2. 
   # E  V  O0 g! `  B
3. import java.lang.annotation.ElementType;
   ( z( q) m$ U- A+ @5 \: O  B# O
4. import java.lang.annotation.Retention;
   9 U' a. u! v0 o; F  _6 j+ l; w7 b, F
5. import java.lang.annotation.RetentionPolicy;
   
6. import java.lang.annotation.Target;
   " x- Z8 @& T1 l
7. 
   
8. @Retention(RetentionPolicy.RUNTIME)
   / c6 N4 d: H4 n- }; M$ Q
9. @Target(ElementType.METHOD) //can use in method only.
   ( S7 o' o: V$ F. }5 u
10. public @interface Test {
    % O' x* Z: X3 G+ Z% ~2 ?" E
11. 
    
12.         //should ignore this test?
    
13.         public boolean enabled() default true;
    ) P2 ]- I& H- u: P4 F1 J0 C) r
14. 
    
15. }</font></font>

复制代码

注意
6 [2 V) |2 ?- e, o. C; u0 i  S) W( H方法申明必须不能带有任何参数或throws片段，返回类型限制为基本类型，字符串String，类Class，枚举eunms，标注和这些类型的数组

* d3 D" Z' V6 V0 H2. @TesterInfo Annotation
( ]  r. \& e0 ?9 C* Y: G@TesterInfo应用到类级别，保存tester的详情。这个类演示返回不同的类型：enum, array and string
TesterInfo.java

9 K- J) d7 i3 {; z& u0 v

1. package com.mkyong.test.core;
   6 w7 f; C) _3 C! _0 B
2. 
   5 ^6 g6 }/ T8 e* d8 [7 U
3. import java.lang.annotation.ElementType;
   
4. import java.lang.annotation.Retention;
   
5. import java.lang.annotation.RetentionPolicy;
   0 R) z  z' ]$ B# B( O! D& F  ^. r) @
6. import java.lang.annotation.Target;
   ! _, k) N5 S. _* h, L4 }8 j
7. 
   
8. @Retention(RetentionPolicy.RUNTIME)
   ! {+ y+ f0 ]7 {: e& C) O/ Y. A: L$ w
9. @Target(ElementType.TYPE) //on class level
   ' P* b# Z3 K) I2 W4 W
10. public @interface TesterInfo {
    
11. 
    - q/ {. ^) [1 `  X
12.         public enum Priority {
    
13.            LOW, MEDIUM, HIGH
    
14.         }
    - g4 T: B' F, P6 o, _4 t$ j, P
15. 
    
16.         Priority priority() default Priority.MEDIUM;
    & ^2 g& G3 i( T0 a) l
17. 
    
18.         String[] tags() default "";
    % ?# \) X3 r9 t. u+ X: y/ Z; k  _
19. 
    1 R9 Y# z4 O1 F: r  y* m
20.         String createdBy() default "Mkyong";
    
21. 
    
22.         String lastModified() default "03/01/2014";
    - f+ I' x8 K7 B- ^8 V& ?" ^
23. 
    
24. }

复制代码

柯拉松

uperの小鬼 发表于 2014-11-20 20:11
: {$ r+ ~) {. U& o8 D自定义标签？

注解- -。。

uperの小鬼

自定义标签？

柯拉松

3. Unit Test Example
新建一个简单的单元测试实例，并且通过新建的标注来标注：@Test and @TesterInfo

9 R+ j# X; H8 D) ]TestExample.java

1. package com.mkyong.test;
   9 A& b7 c1 n1 ~4 |. ?* j1 C
2. 
   2 L& P$ J* `$ I2 H( y
3. import com.mkyong.test.core.Test;
   
4. import com.mkyong.test.core.TesterInfo;
   
5. import com.mkyong.test.core.TesterInfo.Priority;
   8 P( Y  l' \  @- A! V8 K
6. 
   ) v/ ~/ |+ e" F+ `. J
7. @TesterInfo(
   5 i, X& P- X1 N% I. u
8.         priority = Priority.HIGH,
   # O# l+ E5 ]1 K8 ^$ G5 J
9.         createdBy = "mkyong.com",  
   
10.         tags = {"sales","test" }
    + H5 w3 G" E8 Y% Q
11. )
    
12. public class TestExample {
    3 r- t2 l: e: l) j0 k0 m5 J. s
13. 
    
14.         @Test
    
15.         void testA() {
    3 _+ M) R/ i+ H
16.           if (true)
    " m5 O, _3 M# o7 q$ [- |. {. o* L0 d
17.                 throw new RuntimeException("This test always failed");
    7 s& j' r5 y. K  b
18.         }
    7 G$ }# S* t" s) q$ b
19. 
    
20.         @Test(enabled = false)
    
21.         void testB() {
    
22.           if (false)
    
23.                 throw new RuntimeException("This test always passed");
    * v+ n: a7 d6 h3 z# r+ j( x
24.         }
    ! x" W$ H. ?3 k8 x+ l0 t! }
25. 
    
26.         @Test(enabled = true)
    
27.         void testC() {
    
28.           if (10 > 1) {
    ; {6 p0 G  w1 Y( m6 c
29.                 // do nothing, this test always passed.
    7 D8 S0 u( J' ]! I1 Q" D0 D. w
30.           }
    0 a6 ?* ^% H# x( B/ C0 k- g7 w+ x
31.         }
    
32. 
    
33. }

复制代码

$ N( J4 t/ d7 z5 R- y4. Java reflection – Read the Annotation下面的例子演示如何通过java反射来读取和处理自定义标注。
# J( X, _# M$ O( B7 G" t: R
RunTest.java

1. package com.mkyong.test;
   
2. 
   
3. import java.lang.annotation.Annotation;
   
4. import java.lang.reflect.Method;
   4 J1 V8 `4 R. m, x: |) e7 X
5. 
   
6. import com.mkyong.test.core.Test;
   - t' _1 y4 j: D! ^( }( r  G. [/ S
7. import com.mkyong.test.core.TesterInfo;
   
8. 
   
9. public class RunTest {
   ' k* b+ r& I& m8 _$ S+ a0 l
10. 
    
11.   public static void main(String[] args) throws Exception {
    9 y: R3 ?1 b/ @, u" @
12. 
    
13.         System.out.println("Testing...");
    
14. 
    
15.         int passed = 0, failed = 0, count = 0, ignore = 0;
    3 G: N& @$ S7 Y& G( R: ]
16. 
    % P0 s" Q2 q. s1 C9 K
17.         Class<TestExample> obj = TestExample.class;
    4 Y) f0 W; a) P' T  n+ P" z( Q
18. 
    & h' p% ~; R" L  r8 Z9 c" D
19.         // Process @TesterInfo
    2 C+ p% F! S3 |5 t3 Z1 [
20.         if (obj.isAnnotationPresent(TesterInfo.class)) {
    
21. 
    ; ?/ B0 D- @. f2 T" e' i, N
22.                 Annotation annotation = obj.getAnnotation(TesterInfo.class);
    ! r% X2 t$ v$ _" |  Q
23.                 TesterInfo testerInfo = (TesterInfo) annotation;
    
24. 
    . m. M& a3 L7 A5 V* d" H
25.                 System.out.printf("%nPriority :%s", testerInfo.priority());
    
26.                 System.out.printf("%nCreatedBy :%s", testerInfo.createdBy());
    $ U4 D# O( S( z% V  j4 C
27.                 System.out.printf("%nTags :");
    " X% n, n$ U, j$ }8 g$ M) a
28. 
    $ H) w: `+ u( D8 p1 V
29.                 int tagLength = testerInfo.tags().length;
    
30.                 for (String tag : testerInfo.tags()) {
    - ]1 R  j( K. u- E7 X! H
31.                         if (tagLength > 1) {
    
32.                                 System.out.print(tag + ", ");
    
33.                         } else {
    % q( Y1 Q) l9 k" B: i' P: a* X
34.                                 System.out.print(tag);
    / t( U. `* q/ d% P0 T3 k
35.                         }
    
36.                         tagLength--;
    
37.                 }
    
38. 
    
39.                 System.out.printf("%nLastModified :%s%n%n", testerInfo.lastModified());
    " P; Z: d0 ~$ r
40. 
    
41.         }
    
42. 
    " `0 G; \0 }- Y& C8 x6 `
43.         // Process @Test
    0 H8 I; d* s4 _4 L
44.         for (Method method : obj.getDeclaredMethods()) {
    : Z% o$ C( [% k  V
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. 
    # ]* a0 p2 u: W2 s4 P
52.                         // if enabled = true (default)
    ; |$ z. {# D) v& R* L8 |9 `" K1 E
53.                         if (test.enabled()) {
    ' x& Y% O1 H7 V7 B4 T+ L, a
54. 
    % l8 a) [3 D* e8 e
55.                           try {
    
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());
      G9 Y2 G" {* a1 I5 W
61.                                 failed++;
    
62.                           }
    & X# H' G( s9 d/ R4 ^$ N
63. 
    & t2 e! V% U: z7 b
64.                         } else {
    " N/ n" B+ [+ s
65.                                 System.out.printf("%s - Test '%s' - ignored%n", ++count, method.getName());
    ! Z+ u# e- X4 e; y; W
66.                                 ignore++;
    8 i/ `3 y4 ?& r
67.                         }
    
68. 
    # X) t  ^; T/ I
69.                 }
    
70. 
    
71.         }
    
72.         System.out.printf("%nResult : Total : %d, Passed: %d, Failed %d, Ignore %d%n", count, passed, failed, ignore);
    
73. 
    3 k  |* Y. t' u) Z! L
74.         }
    / _7 y1 F4 c1 w) e& x, Y- r
75. }

复制代码

Output

1. Testing...
   
2. 
   % q" K# o" r, ~) _4 U3 h# v5 ?& F, [
3. Priority :HIGH
   
4. CreatedBy :mkyong.com
   - k! m. P! Y9 F+ v+ ^# q
5. Tags :sales, <strong>test</strong>
     ~+ f0 p8 W7 V& s
6. LastModified :03<strong>/</strong>01<strong>/</strong><span style="color:#000000">2014</span>
   
7. 
   . p. D  w+ K$ n, ?( r# I
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. 
    ) a  e! [3 S: R& X+ p. p: |
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>

复制代码