java自定义标注实例

柯拉松

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

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

[size=13.043478965759277px]Test.java

1. package com.mkyong.test.core;
   
2. 
   1 \5 `4 m6 U' u# O# m% q! w
3. import java.lang.annotation.ElementType;
   ) u' Y5 `* U% y3 L  ]! V2 {
4. import java.lang.annotation.Retention;
   - v$ b0 z) d4 K- e4 Z1 p1 V# t
5. import java.lang.annotation.RetentionPolicy;
   9 {  O0 Z2 `; `- _
6. import java.lang.annotation.Target;
   ; Y5 x  q/ [" l3 Q  k% U: R1 {
7. 
   
8. @Retention(RetentionPolicy.RUNTIME)
   
9. @Target(ElementType.METHOD) //can use in method only.
   
10. public @interface Test {
    0 V6 X1 y+ i  _- U6 K& v
11. 
    
12.         //should ignore this test?
    
13.         public boolean enabled() default true;
    
14. 
      b8 G) }0 l! N) U3 X3 L" @
15. }</font></font>

复制代码

注意
% }2 P6 w- a/ F方法申明必须不能带有任何参数或throws片段，返回类型限制为基本类型，字符串String，类Class，枚举eunms，标注和这些类型的数组
' B; c2 A% t. z! m
2. @TesterInfo Annotation
@TesterInfo应用到类级别，保存tester的详情。这个类演示返回不同的类型：enum, array and string
TesterInfo.java

! s2 ?  X0 m" O" ~4 M8 Z% B

1. package com.mkyong.test.core;
   9 ^7 l3 K5 ~! N( _7 `
2. 
   ; R$ ]1 V1 y' H% G8 \6 A( @$ t8 b. |6 y
3. import java.lang.annotation.ElementType;
   7 d/ ?  B7 c6 K6 F9 J
4. import java.lang.annotation.Retention;
   0 a: C& w. g5 E% N. B
5. import java.lang.annotation.RetentionPolicy;
   
6. import java.lang.annotation.Target;
   
7. 
   
8. @Retention(RetentionPolicy.RUNTIME)
   
9. @Target(ElementType.TYPE) //on class level
   
10. public @interface TesterInfo {
    
11. 
    
12.         public enum Priority {
    + p! i9 W" {8 a  X& ?0 d: P0 j
13.            LOW, MEDIUM, HIGH
    
14.         }
    
15. 
    * e' \- _6 E" l+ r+ t2 T
16.         Priority priority() default Priority.MEDIUM;
    8 V/ U5 ?1 }1 R, @
17. 
    . f3 h0 _' l5 _: R' z) y5 H
18.         String[] tags() default "";
    + p( v& h8 P. V5 |7 l% k
19. 
    
20.         String createdBy() default "Mkyong";
    4 q0 L4 I6 ]5 v; ?# @# W- {
21. 
    
22.         String lastModified() default "03/01/2014";
    . P( F: [1 |. p5 _$ g( A8 q' k
23. 
    
24. }

复制代码

柯拉松

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

# ~' |* `2 {9 K; F& a' h. i( ]/ f: pTestExample.java

1. package com.mkyong.test;
   7 Z" r3 ~4 z6 a; E9 U: Q) C
2. 
   
3. import com.mkyong.test.core.Test;
   " k2 D. l' E; v- y, P4 I
4. import com.mkyong.test.core.TesterInfo;
   ( J* E$ p: X. j3 G0 z
5. import com.mkyong.test.core.TesterInfo.Priority;
   
6. 
   3 V  R3 h# G2 m4 ]
7. @TesterInfo(
   
8.         priority = Priority.HIGH,
   
9.         createdBy = "mkyong.com",  
   + l8 d! f6 b& w1 k; i, }, ^, z6 v
10.         tags = {"sales","test" }
    4 Y+ x4 b* s: C. e
11. )
    
12. public class TestExample {
    
13. 
    
14.         @Test
    8 N9 p( G( e; i4 v# E8 ?7 |+ l
15.         void testA() {
    
16.           if (true)
    
17.                 throw new RuntimeException("This test always failed");
    3 ~  R2 ?7 S, I
18.         }
    % D: |* U- w7 I  ~
19. 
    ( N1 y0 ]3 S9 d  a% i' ~8 Q1 b
20.         @Test(enabled = false)
    4 T0 K9 Q0 C; s% r
21.         void testB() {
    
22.           if (false)
    
23.                 throw new RuntimeException("This test always passed");
    9 i- A5 f9 o4 Q0 G0 f1 I/ K
24.         }
    
25. 
    % Z- t. `$ l8 e
26.         @Test(enabled = true)
    
27.         void testC() {
    
28.           if (10 > 1) {
    
29.                 // do nothing, this test always passed.
    1 G' O9 B0 o. ]& E0 |# I
30.           }
    
31.         }
    6 E& a; B- ?/ R' e
32. 
    
33. }

复制代码

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

RunTest.java
" S* G2 G) |# p% q# b

1. package com.mkyong.test;
   
2. 
   
3. import java.lang.annotation.Annotation;
   
4. import java.lang.reflect.Method;
   ! D0 D. V4 Y# i) p/ g, D0 J
5. 
   * z+ v% l: [; R
6. import com.mkyong.test.core.Test;
   ( t& k. R/ N& e& k9 S  w
7. import com.mkyong.test.core.TesterInfo;
   
8. 
   & v9 {+ Y1 p# H0 c
9. public class RunTest {
   
10. 
    2 x; l7 ~6 M/ }8 U5 k& U
11.   public static void main(String[] args) throws Exception {
    
12. 
    8 ^/ u5 ^& v, O) x4 z7 C
13.         System.out.println("Testing...");
    8 a$ ?9 \% `  c9 A) y. D
14. 
    5 D. I: N6 d0 m
15.         int passed = 0, failed = 0, count = 0, ignore = 0;
    4 s0 y9 h8 |8 L% l/ L
16. 
    & F# R* a1 }6 r5 D2 W' `
17.         Class<TestExample> obj = TestExample.class;
    7 Y2 @* |# w2 T* J4 Z" G) S8 v
18. 
    % n. ?7 l, P9 Y& P8 {; g
19.         // Process @TesterInfo
    7 N2 q- @! \, s. o$ W
20.         if (obj.isAnnotationPresent(TesterInfo.class)) {
    4 E2 u) M9 m# {2 t# ]; ?( d
21. 
    
22.                 Annotation annotation = obj.getAnnotation(TesterInfo.class);
    
23.                 TesterInfo testerInfo = (TesterInfo) annotation;
    6 v  b! B& `8 d- G% J/ P- O
24. 
    , d5 N* J+ ?8 ?3 m
25.                 System.out.printf("%nPriority :%s", testerInfo.priority());
    ) f% E8 j% Q" f9 M- Z- ]
26.                 System.out.printf("%nCreatedBy :%s", testerInfo.createdBy());
    & y* \5 X% x- M) J, @& \- [$ X3 P4 z
27.                 System.out.printf("%nTags :");
    
28. 
    9 w+ n$ e- o; Z2 l
29.                 int tagLength = testerInfo.tags().length;
    * T* S  E: S4 w" K' F
30.                 for (String tag : testerInfo.tags()) {
    2 s. O! |; [: Z' W$ Y' O9 ~/ F
31.                         if (tagLength > 1) {
    
32.                                 System.out.print(tag + ", ");
    % E$ V" ]1 v3 z5 ?0 o7 X7 G8 K- s5 B
33.                         } else {
    
34.                                 System.out.print(tag);
    
35.                         }
    
36.                         tagLength--;
    
37.                 }
    % |6 M! M+ k1 Y: X) e# H
38. 
    
39.                 System.out.printf("%nLastModified :%s%n%n", testerInfo.lastModified());
    * w7 C1 r0 O& I+ y- k' {0 x
40. 
    8 E' ]6 W" p0 K9 y- ~9 w9 G
41.         }
    
42. 
    2 F% G* i; x+ f
43.         // Process @Test
    * t. P" C% H: N: ?  V: F
44.         for (Method method : obj.getDeclaredMethods()) {
    ; y% \+ H5 g+ X6 f8 j
45. 
    ' C4 {& X7 A% Y; A1 W: h
46.                 // if method is annotated with @Test
    * {# Z0 C5 i, s% B) c1 z0 h
47.                 if (method.isAnnotationPresent(Test.class)) {
    
48. 
    
49.                         Annotation annotation = method.getAnnotation(Test.class);
    $ ^% Z8 O& {% @
50.                         Test test = (Test) annotation;
    1 r3 ]. r3 o8 V% K! A
51. 
    
52.                         // if enabled = true (default)
    , q2 ]2 v& S, S0 N
53.                         if (test.enabled()) {
    $ V9 M: h, W( }, T7 U2 h3 i
54. 
    - s! e1 D% [' b, Y/ W2 E! l# e: L
55.                           try {
    
56.                                 method.invoke(obj.newInstance());
    
57.                                 System.out.printf("%s - Test '%s' - passed %n", ++count, method.getName());
    0 n* h9 M8 z; N$ E1 {
58.                                 passed++;
    
59.                           } catch (Throwable ex) {
    
60.                                 System.out.printf("%s - Test '%s' - failed: %s %n", ++count, method.getName(), ex.getCause());
    
61.                                 failed++;
    0 V- [9 m3 `/ W# b
62.                           }
    # F) g! M! _: N9 n
63. 
    9 ~" Q. p8 B! f" v, t! d3 e" y
64.                         } else {
    7 n4 k7 p9 `4 ?3 ]& A
65.                                 System.out.printf("%s - Test '%s' - ignored%n", ++count, method.getName());
    
66.                                 ignore++;
      ~* A3 V# p- I" S& E
67.                         }
    : ^0 U% A( l0 C9 x* V3 R, V
68. 
    
69.                 }
    ' S7 ]. K" t/ t8 V" O+ K* n9 d
70. 
    
71.         }
    4 E6 _; |* Q* ~% K3 L$ e; d
72.         System.out.printf("%nResult : Total : %d, Passed: %d, Failed %d, Ignore %d%n", count, passed, failed, ignore);
    0 N: o% o: {, M9 C6 S' O/ {
73. 
    
74.         }
    
75. }

复制代码

* `+ U" L% f9 h$ n) cOutput

1. Testing...
   
2. 
   " {6 Z6 P) T* G' Y- Y+ c! R
3. Priority :HIGH
   
4. CreatedBy :mkyong.com
   
5. Tags :sales, <strong>test</strong>
   
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
   ( v* }: {6 Y6 ]9 j3 O* _: E: f7 I; k
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
    % g: {8 K* ~# |) I. ]6 Q
11. 
    + @% Q2 ~8 `- _" x" g" _
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
4 H0 x% {8 ~+ |: G0 a& Z自定义标签？

& }* g# _- h( X- c注解- -。。