一、注解基本知識
1、元注解
元注解是指注解的注解。包括 @Retention @Target @Document @Inherited四種。
1. Annotation型定義為@interface, 所有的Annotation會自動繼承java.lang.Annotation這一接口,并且不能再去繼承別的類或是接口.
2. 參數成員只能用public或默認(default)這兩個訪問權修飾
3. 參數成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數據類型和String、Enum、Class、annotations等數據類型,以及這一些類型的數組.
4. 要獲取類方法和字段的注解信息，必須通過Java的反射技術來獲取 Annotation對象,因為你除此之外沒有別的獲取注解對象的方法
5. 注解也可以沒有定義成員, 不過這樣注解就沒啥用了
自定義注解類時, 可以指定目標 (類、方法、字段, 構造函數等) , 注解的生命周期(運行時,class文件或者源碼中有效), 是否將注解包含在javadoc中及是否允許子類繼承父類中的注解, 具體如下:
1. @Target 表示該注解目標,可能的 ElemenetType 參數包括:
|
1
2
3
4
5
6
7
|
ElemenetType.CONSTRUCTOR 構造器聲明ElemenetType.FIELD 域聲明(包括 enum 實例) ElemenetType.LOCAL_VARIABLE 局部變量聲明 ElemenetType.METHOD 方法聲明 ElemenetType.PACKAGE 包聲明 ElemenetType.PARAMETER 參數聲明 ElemenetType.TYPE 類，接口(包括注解類型)或enum聲明 |
2. @Retention 表示該注解的生命周期,可選的 RetentionPolicy 參數包括
|
1
2
3
|
RetentionPolicy.SOURCE 注解將被編譯器丟棄 RetentionPolicy.CLASS 注解在class文件中可用，但會被VM丟棄 RetentionPolicy.RUNTIME VM將在運行期也保留注釋，因此可以通過反射機制讀取注解的信息 |
3. @Documented 指示將此注解包含在 javadoc 中
4. @Inherited 指示允許子類繼承父類中的注解
二、在java中如何使用
2.1、定義注解
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
package com.test.annotation;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;public class MyAnnotation { /** * 注解類 * @author T4980D * */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) public @interface MyClassAnnotation { String uri(); String desc(); } /** * 構造方法注解 * @author T4980D * */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.CONSTRUCTOR) public @interface MyConstructorAnnotation { String uri(); String desc(); } /** * 我的方法注解 * @author Owner * */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface MyMethodAnnotation { String uri(); String desc(); } /** * 字段注解定義 * @author Owner * */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.FIELD) public @interface MyFieldAnnotation { String uri(); String desc(); } /** * * 可以同時應用到類上和方法上 * @author T4980D * */ @Target({ElementType.TYPE, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) public @interface Yts { // 定義枚舉 public enum YtsType { util, entity, service, model } // 設置默認值 public YtsType classType() default YtsType.util; // 數組 int[] arr() default {3, 7, 5}; String color() default "blue"; } } |
2.2、基本測試注解
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
package com.test.annotation;import java.lang.reflect.Constructor;import java.lang.reflect.Field;import java.lang.reflect.Method;import com.test.annotation.MyAnnotation.MyClassAnnotation;import com.test.annotation.MyAnnotation.MyConstructorAnnotation;import com.test.annotation.MyAnnotation.MyFieldAnnotation;import com.test.annotation.MyAnnotation.MyMethodAnnotation;import com.test.annotation.MyAnnotation.Yts;import com.test.annotation.MyAnnotation.Yts.YtsType;@MyClassAnnotation(desc = "The class", uri = "com.test.annotation.Test")@Yts(classType =YtsType.util)public class TestAnnotation { @MyFieldAnnotation(desc = "The class field", uri = "com.test.annotation.Test#id") private String id; @MyConstructorAnnotation(desc = "The class constructor", uri = "com.test.annotation.Test#MySample") public TestAnnotation() { } public String getId() { return id; } @MyMethodAnnotation(desc = "The class method", uri = "com.test.annotation.Test#setId") public void setId(String id) { System.out.println(" method info: "+id); this.id = id; } @MyMethodAnnotation(desc = "The class method sayHello", uri = "com.test.annotation.Test#sayHello") @Yts public void sayHello(String name){ if(name == null || name.equals("")){ System.out.println("hello world!"); }else{ System.out.println(name + "\t:say hello world!"); } } public static void main(String[] args) throws Exception { Class<TestAnnotation> clazz = TestAnnotation.class; // 得到類注解 MyClassAnnotation myClassAnnotation = clazz.getAnnotation(MyClassAnnotation.class); System.out.println(myClassAnnotation.desc() + " "+ myClassAnnotation.uri()); // 得到構造方法注解 Constructor<TestAnnotation> cons = clazz.getConstructor(new Class[]{}); MyConstructorAnnotation myConstructorAnnotation = cons.getAnnotation(MyConstructorAnnotation.class); System.out.println(myConstructorAnnotation.desc() + " "+ myConstructorAnnotation.uri()); // 獲取方法注解 Method method = clazz.getMethod("setId", new Class[]{int.class}); MyMethodAnnotation myMethodAnnotation = method.getAnnotation(MyMethodAnnotation.class); System.out.println(myMethodAnnotation.desc() + " "+ myMethodAnnotation.uri()); // 獲取字段注解 Field field = clazz.getDeclaredField("id"); MyFieldAnnotation myFieldAnnotation = field.getAnnotation(MyFieldAnnotation.class); System.out.println(myFieldAnnotation.desc() + " "+ myFieldAnnotation.uri()); }} |
2.3、通過反射解析
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
package com.test.annotation;import java.lang.reflect.Method;import java.util.Arrays;import com.test.annotation.MyAnnotation.MyClassAnnotation;import com.test.annotation.MyAnnotation.MyMethodAnnotation;import com.test.annotation.MyAnnotation.Yts;import com.test.annotation.MyAnnotation.Yts.YtsType;public class ParseAnnotation { /** * 解析方法注解 * @param <T> * @param clazz */ public static <T> void parseMethod(Class<T> clazz) { try { T obj = clazz.newInstance(); for (Method method : clazz.getDeclaredMethods()) { MyMethodAnnotation methodAnnotation = method.getAnnotation(MyMethodAnnotation.class); if (methodAnnotation!=null) { //通過反射調用帶有此注解的方法 method.invoke(obj, methodAnnotation.uri()); } Yts yts = (Yts) method.getAnnotation(Yts.class); if (yts != null) { if (YtsType.util.equals(yts.classType())) { System.out.println("this is a util method"); } else { System.out.println("this is a other method"); } System.out.println(Arrays.toString(yts.arr())); //打印數組 System.out.println(yts.color()); //輸出顏色 } System.out.println("\t\t-----------------------"); } } catch (Exception e) { e.printStackTrace(); } } /** * 解析類注解 * @param <T> * @param clazz */ public static <T> void parseType(Class<T> clazz) { try { Yts yts = (Yts) clazz.getAnnotation(Yts.class); if (yts != null) { if (YtsType.util.equals(yts.classType())) { System.out.println("this is a util class"); } else { System.out.println("this is a other class"); } } MyClassAnnotation classAnnotation = (MyClassAnnotation) clazz.getAnnotation(MyClassAnnotation.class); if (classAnnotation != null) { System.err.println(" class info: "+classAnnotation.uri()); } } catch (Exception e) { e.printStackTrace(); } } public static void main(String[] args) { parseMethod(TestAnnotation.class); parseType(TestAnnotation.class); }} |
三、注解應用案例
3.1、關于細粒度權限攔截的問題，在Struts2中可以根據登錄用戶所具有的的權限進行任一一個action方法的攔截，可以定義一個自定義方法注解，例如
|
1
2
3
4
5
6
7
8
9
10
|
@Retention(RetentionPolicy.RUNTIME)//代表Permission注解保留在的階段 @Target(ElementType.METHOD)//標注在方法上面 public @interface Permission { /** 模塊 */ String module(); /** 權限值 */ String privilege(); } |
3、2 比如有一個部門action，Department.action,有一個方法public String departmentlistUI(){}可以這樣定義方法
|
1
2
3
4
|
@Permission(module="department",privilege="view") public String departmentlistUI(){ } |
3.3、然后自定定義一個權限攔截器PrivilegeInterceptor.java并在struts.xml中注冊，在實現interceptor接口后，實現方法public String intercept(ActionInvocation invocation) throws Exception {}，在這里調用任一個action方法都會經過該攔截方法，通過invocation可以獲取當前調用的action的名字，以及調用的action的哪個方法，通過這段代碼可以獲取action名字和方法名。
|
1
2
3
4
|
String actionName=invocation.getProxy().getActionName(); String methodName=invocation.getProxy().getMethod(); System.out.println("攔截到：action的名字："+actionName+"方法名："+methodName); |
4、然后通過反射技術，獲取該方法上的自定義權限注解，獲取當前登錄的用戶（從session中），遍歷當前用戶的所擁有的權限組，并且遍歷任一個權限組下的所有的權限，看是否包括該方法上注解所需的權限。這樣就可以完成細粒度的action方法權限攔截了。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
|
private boolean validate(ActionInvocation invocation) throws SecurityException, NoSuchMethodException { String methodName=invocation.getProxy().getMethod(); Method currentMethod = invocation.getAction().getClass().getMethod(methodName); if(currentMethod != null && currentMethod.isAnnotationPresent(Permission.class)){ //得到方法上的注解 Permission permission = currentMethod.getAnnotation(Permission.class); //該方法上的所需要的權限 SystemPrivilege methodPrivilege = new SystemPrivilege(new SystemPrivilegePK(permission.module(), permission.privilege())); //得到當前登錄的用戶 Employee e = (Employee) ActionContext.getContext().getSession().get("loginUser"); //遍歷當前用戶下的所有的權限組 for(PrivilegeGroup group : e.getGroups()){ //如果該權限組下包含，要訪問該方法所需要的權限，就放行 if(group.getPrivileges().contains(methodPrivilege)){ return true; } } //說明遍歷的該用戶所有的權限組，沒有發現該權限，說明沒有該權限 return false; } //沒有標注注解，表示誰都可以調用該方法 return true; } |
感謝閱讀，希望能幫助到大家，謝謝大家對本站的支持！
