系列閱讀
1. 概述
注解相當于一種標記蝉衣,在程序中加了注解就等于為程序打上了某種標記,沒加万搔,則等于沒有某種標記锋喜,以后尾序,javac編譯器,開發(fā)工具和其他程序可以用反射來了解你的類及各種元素上有無何種標記仆嗦,看你有什么標記,就去干相應的事先壕。標記可以加在包瘩扼,類,字段垃僚,方法集绰,方法的參數以及局部變量上
開發(fā)中常見注解:
- @Override:作用在方法上的注解。當方法不是重寫父類的方法時會報錯
- @Deprecated:作用在方法上谆棺。標記該方法為作廢方法(已過時)
- @SuppressWarnings:作用在方法上栽燕,壓制警告
2. 注解類型
8種基本數據類型,String,Class碍岔,enum浴讯,annotation,以上類型的數組類型
3. 定義注解
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ViewInject {
int value();//當使用注解時蔼啦,如果只給名為value的屬性賦值時榆纽,可以省略“value=”
String name() default "zhangsan";//默認值
}
@interface
使用@interface聲明一個注解類
@Target
表示注解的作用目標,是一個枚舉值
作用目標 | 說明 |
---|---|
ElementType.FIELD | 作用于成員變量 |
ElementType.METHOD | 作用于方法 |
ElementType.CONSTRUCTOR | 作用于構造方法 |
ElementType.PARAMETER | 作用于方法的參數 |
@Retention
表示注解的保存策略捏肢,也是一個枚舉值
注解的保留策略是指奈籽,注解是只保留在源代碼上,還是保留到class文件上猛计,再或者是類在運行時唠摹,可以被類加載器加載到內存中。
如果希望注解被反射奉瘤,那么注解就要保留到運行時勾拉,而不是源代碼或類文件上。
指定注解的保留策略需要使用元注解@Retention盗温,它有一個value屬性藕赞,類型為RetentionPolicy類型,RetentionPolicy是枚舉類型
保存策略 | 說明 |
---|---|
RetentionPolicy.SOURCE | 注解只保存在源代碼中卖局,即.java文件 |
RetentionPolicy.CLASS | 注解保存在字節(jié)碼中,即.class文件 |
RetentionPolicy.RUNTIME | 注解保存在內存中的字節(jié)碼斧蜕,可用于反射 |
注解的屬性
String name() default "zhangsan";//默認值
定義注解的屬性,有點像java類中的方法砚偶,上面的代碼定義了一個類型為String類型批销,注解名為name的屬性,default是給注解設置默認值
value屬性
String value() default "xxx";
如果注解中有一個名稱為value的屬性染坯,且你只想設置value屬性(即其他屬性都采用默認值或者你只有一個value屬性)均芽,那么可以省略value=部分,例如:@MyAnnotation("AllenIverson")
數組類型的屬性
int [] arrayAttr() default {1,2,3};//定義
@MyAnnotation(arrayAttr={2,3,4})//使用
如果數組屬性中只有一個元素单鹿,這時候屬性值部分可以省略大括
4. Annotation
4.1 注解的應用結構圖
4.2 反射注解
類上的注解:使用Class獲取
- Class.getAnnotation():獲取指定類型的注解
- Class.getAnnotations():獲取所有的注解
- Class.getDeclaredAnnotations():獲取除了繼承得到的所有注解
方法上的注解:使用Method獲取
- Method.getAnnotation() :獲取方法上指定類型的注解
- Method.getAnnotations():獲取所有的注解
- Method.getDeclaredAnnotations():獲取除了繼承得到的所有注解
構造方法上的注解:使用Constructor獲取
- Constructor.getAnnotation()獲取指定類型的注解
- Constructor.getAnnotations()獲取所有的注解
- Constructor.getDeclaredAnnotations() 獲取除了繼承得到的所有注解
屬性上的注解:使用Field獲取
- Field.getAnnotation():獲取字段上指定類型的注解
- Field.getAnnotations():獲取所有的注解
- Field.getDeclaredAnnotations():獲取字段所有的注解
定義注解
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
public @interface MyAnn {
String value() default "hello";
int value1() default 100;
}
使用注解
@MyAnn(value="hello world", value1=200)
public class MyClass {
private int a;
@MyAnn("myMethod")
public void fun() {}
}
通過反射讀取注解
public class Demo1 {
public static void main(String[] args) throws Exception {
Class clazz = MyClass.class;
MyAnn myAnn = (MyAnn) clazz.getAnnotation(MyAnn.class);
System.out.println(myAnn.value());
System.out.println(myAnn.value1());
Method method = clazz.getMethod("fun");
MyAnn myAnn1 = method.getAnnotation(MyAnn.class);
System.out.println(myAnn1.value());
System.out.println(myAnn1.value1());
}
}
4.3 實現注解小框架
public class ViewUtils {
public static void inject(Activity activity) throws IllegalAccessException {
bindView(activity);
}
private static void bindView(Activity activity) throws IllegalAccessException {
Field[] fields = activity.getClass().getDeclaredFields();
for (Field field : fields){
ViewInject viewInject = field.getAnnotation(ViewInject.class);
if (viewInject != null){
int resId = viewInject.value();
View view = activity.findViewById(resId);
field.setAccessible(true);
field.set(activity,view);
}
}
}
public static void onClick(final Activity activity){
Method[] methods = activity.getClass().getDeclaredMethods();
for (final Method method : methods){
Onclick onclick = method.getAnnotation(Onclick.class);
if (onclick != null){
int resId = onclick.value();
final View view = activity.findViewById(resId);
view.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
method.setAccessible(true);
try {
method.invoke(activity,view);
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (InvocationTargetException e) {
e.printStackTrace();
}
}
});
}
}
}
}
5. Annotation Processing Tool
編譯時注解在項目編譯的時候生成新的Java文件掀宋,這樣可以減少手動的代碼輸入,而且可以不用使用反射仲锄,對程序不會造成性能影響劲妙。
Android公共技術點之二-Annotation Processing Tool
6. javapoet
動態(tài)生成Java源碼,ButterKnife使用了該框架儒喊,實現了編譯時注解
7. 注解框架
- Dagger1
- Dagger2
- Guice
- Butterknife