學(xué)習(xí)資料:
- Java編程思想 ——第20章
- 公共技術(shù)點(diǎn)之 Java 注解 Annotation
注解(Annotation)也被稱為元數(shù)據(jù),提供一種在代碼中添加信息的形式化方法,在之后某個(gè)時(shí)刻可以方便地使用這些數(shù)據(jù)
元數(shù)據(jù)是描述數(shù)據(jù)的數(shù)據(jù)
注解是在Java SE5中添加,可以完整地描述程序所需要而Java代碼無法來表達(dá)的信息。注解僅僅是元數(shù)據(jù),與邏輯代碼沒有任何關(guān)系
1.基本語法 <p>
沒有元素的注解稱為標(biāo)記注解
Java中有4種元注解
元注解的作用就是負(fù)責(zé)注解其他注解 :(
| 元注解 | 作用 |
|---|---|
@Target |
表示該注解可以用在什么地方 ElementType包括: CONSTRUCTOR --> 構(gòu)造器的聲明 FIELD --> 域聲明 LOCAL_VARLABLE --> 局部變量聲明 METHOD --> 方法聲明 PACKGE --> 包聲明 PARAMETER --> 參數(shù)聲明 |
@Retention |
表示需要在什么級別保存該注解信息 可選的RetentionPolicy參數(shù)包括: SOURCE --> 注解被編譯丟棄 CALSS --> 注解在class文件中可以用,但會被VM丟棄 RUNtIME --> VM將在運(yùn)行時(shí)期保留注解,可以通過反射機(jī)制讀取注解的信息 |
@Documented |
將此注解包含在Javadoc中 |
@Inherited |
允許子類繼承父類中的注解,默認(rèn)為false |
需要注意CLass,RUNTIME
1.1 RUNTIME,運(yùn)行時(shí)注解
運(yùn)行時(shí)注解,簡單案例:
//定義注解
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface UseCase {
public int id();
public String description() default "no description";
}
//使用
public class PasswordUtils {
@UseCase(id=47,description = "Password must contain at least one numeric")
public static boolean validatePassword(String password){
return (password.matches("\\w*\\d\\w*"));
}
@UseCase(id = 48)
public static String encryptPassword(String password){
return new StringBuilder(password).toString();
}
@UseCase(id= 49,description = "New passwords can't equals previously used ones")
public static boolean checkForNewPassword(List<String>list,String password){
return !list.contains(password);
}
}
編寫注解處理器:
public class UseCaseTracker {
public static void trackUseCases(List<Integer>lsit,Class<?>cl){
for (Method m : cl.getDeclaredMethods()){
UseCase uc = m.getAnnotation(UseCase.class);
if (null != uc){
System.out.println("Found use case-"+uc.id() +" "+uc.description());
lsit.remove(new Integer(uc.id()));
}
}
for (int i:lsit){
System.out.println("Warning : Missing use case - "+i);
}
}
public static void main(String[]args){
List<Integer>list = new ArrayList<>();
Collections.addAll(list,47,48,49,50);
trackUseCases(list,PasswordUtils.class);
}
}
利用兩個(gè)反射方法:getDeclaredMethods()和getAnnotation()
getAnnotation()方法返回的結(jié)果就是注解對象,這里就是UseCase。如果被注解的方法上沒有該類型的的注解,返回null
運(yùn)行結(jié)果:
Found use case-47 Password must contain at least one numeric
Found use case-48 no description
Found use case-49 New passwords can't equals previously used ones
Warning : Missing use case - 50
1.2 CLASS,編譯時(shí)注解 <p>
挖坑 ,等會用了再,來填坑
1.3 注解元素 <p>
在上面的例子中,@UseCase是由UseCase.java定義的,在里面有int元素id,以及String元素description
在注解中,注解元素可以使用的類型:
- 所有的的基本數(shù)據(jù)類型(
int,float,boolean等) - String
- enum
- Annotation
使用其他的類型,編譯器會報(bào)錯。注意:不允許使用任何包裝類型,由于存在自動打包,這并不是限制。
注解也可以作為元素的類型,也就是說注解可以嵌套
1.4 默認(rèn)值限制 <p>
編譯器對注解元素的默認(rèn)值很挑剔:
- 元素不能有不確定的值。元素要么有默認(rèn)值,要么在使用注解時(shí)提供了值
- 非基本類型的元素,無論是在代碼中聲明時(shí),還是在注解接口中定義默認(rèn)值時(shí),都不能為
null
約束:
這些限制導(dǎo)致無法直接表現(xiàn)一個(gè)元素的存在和確實(shí)狀態(tài)
因?yàn)樵诿總€(gè)注解的聲明中,所有的元素的都存在,并且又確定的值
為避開這個(gè)約束,可以自己定義一些特殊的值來標(biāo)示元素存在或者缺失,例如:
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SimulatingNull{
public int id() default -1;
public String description() default "";
}
在定義注解時(shí),這是一個(gè)習(xí)慣用法
2.最后 <p>
編譯時(shí)注解還要再次進(jìn)行學(xué)習(xí),感覺比運(yùn)行時(shí)注解要難,回頭進(jìn)行學(xué)習(xí)
本人很菜,有錯誤請指出
共勉 :)