java自定义标注实例

柯拉松

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

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

[size=13.043478965759277px]Test.java

1. package com.mkyong.test.core;
   3 A0 q) p( {9 H1 \8 _" _+ Q; H
2. 
   % s6 K6 D7 q- B) @2 x/ \7 Y
3. import java.lang.annotation.ElementType;
   9 H% @4 D4 Z  _% [. M! @
4. import java.lang.annotation.Retention;
   
5. import java.lang.annotation.RetentionPolicy;
   * w6 V6 ?* F4 L& ~- L8 H% a
6. import java.lang.annotation.Target;
   , ~) t* X6 x% d; A
7. 
   . W+ j( a% f$ ^" E5 H8 [
8. @Retention(RetentionPolicy.RUNTIME)
   5 M$ z) u5 c/ |% g
9. @Target(ElementType.METHOD) //can use in method only.
   
10. public @interface Test {
    
11. 
    0 r: A; w" N' N. b0 ^4 Z5 e
12.         //should ignore this test?
    9 N* Y+ F# @/ k$ F9 E
13.         public boolean enabled() default true;
    1 {# I8 J6 w$ W1 ]9 X, \
14. 
    4 Y& V. N  W; T- O' [% Y/ i) D, J9 _
15. }</font></font>

复制代码

注意
. ^2 T. F. Z! N方法申明必须不能带有任何参数或throws片段，返回类型限制为基本类型，字符串String，类Class，枚举eunms，标注和这些类型的数组

2. @TesterInfo Annotation
@TesterInfo应用到类级别，保存tester的详情。这个类演示返回不同的类型：enum, array and string
# t* d/ [' m8 l0 T& KTesterInfo.java
& k6 D" E  M! y
% N6 j( q9 f) m2 U& _4 |

1. package com.mkyong.test.core;
   
2. 
   
3. import java.lang.annotation.ElementType;
   " l: h- B* h2 q% R0 H0 X- n
4. import java.lang.annotation.Retention;
   0 _: a. b! w* u3 z3 p
5. import java.lang.annotation.RetentionPolicy;
   
6. import java.lang.annotation.Target;
   
7. 
   
8. @Retention(RetentionPolicy.RUNTIME)
   4 b' j* s* A8 B2 |
9. @Target(ElementType.TYPE) //on class level
   & X  b! t' j4 e1 ^1 j% s/ ]
10. public @interface TesterInfo {
    7 g  m+ a( }& R* p
11. 
    + `# A+ ]* E, B" l" s4 o+ h
12.         public enum Priority {
    2 M* Y& p* T! p7 s
13.            LOW, MEDIUM, HIGH
    
14.         }
    
15. 
    ) l+ m" ^: A3 t. T8 F1 T
16.         Priority priority() default Priority.MEDIUM;
    0 _  B7 A. m/ m- w' e# M9 |- \$ \- g
17. 
    
18.         String[] tags() default "";
    
19. 
    
20.         String createdBy() default "Mkyong";
    / [% z9 D$ z6 [1 Q
21. 
    
22.         String lastModified() default "03/01/2014";
    
23. 
    9 T6 p/ r* z4 W/ e: E, z
24. }

复制代码

柯拉松

3. Unit Test Example
/ Z8 S" }4 V2 ]3 Y) ?7 T0 I新建一个简单的单元测试实例，并且通过新建的标注来标注：@Test and @TesterInfo

0 ^/ m! q0 P* r+ |; f& wTestExample.java

1. package com.mkyong.test;
   + T! O' G. H7 u# }8 U
2. 
   
3. import com.mkyong.test.core.Test;
   6 p5 s; L4 j! d9 P9 E0 X: N
4. import com.mkyong.test.core.TesterInfo;
   
5. import com.mkyong.test.core.TesterInfo.Priority;
   
6. 
   # T: L" J3 C$ m# L6 t& q8 a+ D4 g' p
7. @TesterInfo(
   
8.         priority = Priority.HIGH,
   
9.         createdBy = "mkyong.com",  
   ( r9 u" g! Y' S; w. P
10.         tags = {"sales","test" }
    0 r6 Z7 U8 H8 O* h9 ~/ R" A( j( V
11. )
    
12. public class TestExample {
    ! g4 f$ k8 j/ t$ S; U* Z4 K% n
13. 
    
14.         @Test
    - R* C) J( D/ H( v0 X0 }& \
15.         void testA() {
    
16.           if (true)
    7 u1 n. O9 K6 ?
17.                 throw new RuntimeException("This test always failed");
    - h' Y! F& |2 H3 Y2 f7 M0 X! O# v) d
18.         }
    
19. 
    8 [9 g" V3 O# `
20.         @Test(enabled = false)
    
21.         void testB() {
    
22.           if (false)
    
23.                 throw new RuntimeException("This test always passed");
    
24.         }
    2 J; V% Z  A3 F3 q: i5 Q5 i/ R1 R$ C
25. 
    " m5 U+ V+ E  ]. n1 q! Z
26.         @Test(enabled = true)
    
27.         void testC() {
    & T1 i. s9 ^( a# X
28.           if (10 > 1) {
    * c- d3 ~3 L; h; `% R
29.                 // do nothing, this test always passed.
    7 r; a( e; t8 L0 i% h. j0 q+ ~
30.           }
    ! Y. ?3 ^% Z8 v  H
31.         }
    , n4 [3 a# l# C6 r/ {; I7 t8 }8 G
32. 
    
33. }

复制代码

4. Java reflection – Read the Annotation下面的例子演示如何通过java反射来读取和处理自定义标注。
' q& }/ R# k; {3 d, k8 w+ O
5 T( J5 v' f0 X* o8 H$ {) iRunTest.java

9 B9 l7 r: z/ R; y7 ^1 T

1. package com.mkyong.test;
   $ Q  y8 d$ \  P3 [5 R  Y
2. 
   3 Y' e0 o4 C4 v* I8 Z  A: F
3. import java.lang.annotation.Annotation;
   
4. import java.lang.reflect.Method;
   $ S# ^* Q) n( M- z6 _' y
5. 
   ) \( }8 `! A5 Y
6. import com.mkyong.test.core.Test;
   ( [6 j; d: {( t& I' f- H
7. import com.mkyong.test.core.TesterInfo;
   
8. 
   
9. public class RunTest {
   
10. 
    5 \  q2 t7 J2 e$ e
11.   public static void main(String[] args) throws Exception {
    
12. 
    0 k/ \( i) Z' S" E9 ?! j+ q
13.         System.out.println("Testing...");
    
14. 
    
15.         int passed = 0, failed = 0, count = 0, ignore = 0;
    
16. 
    ! ^$ Y  T; e. A6 V" x( ^2 Y
17.         Class<TestExample> obj = TestExample.class;
    
18. 
    ; }8 B/ r# [. k# }
19.         // Process @TesterInfo
    $ y# c, L# ?6 c2 G* K
20.         if (obj.isAnnotationPresent(TesterInfo.class)) {
    
21. 
    
22.                 Annotation annotation = obj.getAnnotation(TesterInfo.class);
    ! ?" W' f! C: {) L! s4 H5 i: M
23.                 TesterInfo testerInfo = (TesterInfo) annotation;
    
24. 
    
25.                 System.out.printf("%nPriority :%s", testerInfo.priority());
    
26.                 System.out.printf("%nCreatedBy :%s", testerInfo.createdBy());
    
27.                 System.out.printf("%nTags :");
    
28. 
    
29.                 int tagLength = testerInfo.tags().length;
    
30.                 for (String tag : testerInfo.tags()) {
    ; m- |+ K- z  V  S0 I
31.                         if (tagLength > 1) {
    
32.                                 System.out.print(tag + ", ");
    
33.                         } else {
    
34.                                 System.out.print(tag);
    $ O( m9 d( @# d
35.                         }
    & S% c0 V9 C: R2 h6 j
36.                         tagLength--;
    4 B9 q; I: `$ d0 P& Z
37.                 }
    
38. 
    " X: u3 a7 {7 v% V' S
39.                 System.out.printf("%nLastModified :%s%n%n", testerInfo.lastModified());
    # m, c9 p. y* R& T' V1 N
40. 
    * H8 F1 v% B; y8 y/ Z- J+ L2 C- a
41.         }
    
42. 
    3 ~) {; ]. k6 ~) I; F; L7 ]' M+ g) y
43.         // Process @Test
    , Z7 d' ]+ }$ z3 H
44.         for (Method method : obj.getDeclaredMethods()) {
    
45. 
    / P8 `/ Z5 M5 ^7 N2 s' g/ _% Y0 {
46.                 // if method is annotated with @Test
    9 [9 X4 I8 t# D9 z4 S3 F
47.                 if (method.isAnnotationPresent(Test.class)) {
    # F  \, l+ `0 I8 I9 M+ L/ e
48. 
    
49.                         Annotation annotation = method.getAnnotation(Test.class);
    
50.                         Test test = (Test) annotation;
    
51. 
    7 V4 o+ {/ q* V+ L
52.                         // if enabled = true (default)
    
53.                         if (test.enabled()) {
    
54. 
    
55.                           try {
    
56.                                 method.invoke(obj.newInstance());
    . G* H# N  y1 {) V" ]
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());
    
61.                                 failed++;
    
62.                           }
    ! Y4 s$ \- N4 m$ Y
63. 
    5 a( m2 N; Z1 ]/ a& Z$ X
64.                         } else {
    
65.                                 System.out.printf("%s - Test '%s' - ignored%n", ++count, method.getName());
    
66.                                 ignore++;
    1 l( m" `- w/ r. O1 V  W! g* e! C2 B
67.                         }
    
68. 
    + o0 Z/ E& Y# p  ]( p% e5 A: O3 C
69.                 }
    6 u3 p1 T( Q* J
70. 
    + \0 d' x4 Y7 F. s3 k2 P3 ^
71.         }
    
72.         System.out.printf("%nResult : Total : %d, Passed: %d, Failed %d, Ignore %d%n", count, passed, failed, ignore);
    
73. 
    1 w! e$ Q6 Z$ T4 b4 {/ ], f
74.         }
    & t- p" S/ D5 L
75. }

复制代码

Output

1. Testing...
   
2. 
   ! i; y6 P5 p! q! Q. i, Y$ G$ A
3. Priority :HIGH
   
4. CreatedBy :mkyong.com
   7 Z+ W, C6 U0 j; k; @- Z
5. Tags :sales, <strong>test</strong>
   
6. LastModified :03<strong>/</strong>01<strong>/</strong><span style="color:#000000">2014</span>
   / Y0 S2 X4 l) `) c2 n3 |  O0 S- w
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
   2 Q* I" K! l/ K% Y+ Q& O
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
    / V2 I- c5 K  i; X3 G! ^4 t  k
11. 
    9 D' q  [' E; J8 m
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 k5 K+ E: t3 b  h注解- -。。