注解是開發(fā)中經(jīng)常使用到的,因為很久前在網(wǎng)上找了幾篇文章翼闹,發(fā)現(xiàn)完全看不懂,所以覺得這個東西好像很難搞持寄,最近耐心的看完了這篇文章秒懂崔步,Java 注解你可以這樣學稳吮,感覺入門還是比較簡單的
我為什么想要看注解呢,其實是因為看見有些注解十分方便刷晋,比如@ViewById注解可以讓代碼更優(yōu)雅盖高,想自己也搞幾個注解用一下慎陵,比如自動運行在UI線程眼虱、子線程的注解;然后發(fā)現(xiàn)很多文章講的太抽象了席纽,而且到最后都根本沒有我想要的這種例子捏悬,索性就不看了;其實大概就是因為太心急了润梯,沒有理解注解的作用过牙;
上面的文章里面的例子很好,把注解比喻成一個標簽纺铭,注解只是給你這個方法寇钉、這個類、這個變量加一個標簽而已舶赔,然后你可以通過一些方法來獲取這個標簽扫倡,根據(jù)自己的需要做一些操作
新建標簽
創(chuàng)建一個注解十分簡單,和接口差不多
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface AnnotationClass {
int id() default 1;
String name();
}
標簽分一些類型竟纳,不同的類型給Java中不同的地方標記撵溃,類型使用@Target
來設置疚鲤,@Target 有下面的取值
- ElementType.ANNOTATION_TYPE 可以給一個注解進行注解
- ElementType.CONSTRUCTOR 可以給構造方法進行注解
- ElementType.FIELD 可以給屬性進行注解
- ElementType.LOCAL_VARIABLE 可以給局部變量進行注解
- ElementType.METHOD 可以給方法進行注解
- ElementType.PACKAGE 可以給一個包進行注解
- ElementType.PARAMETER 可以給一個方法內的參數(shù)進行注解
- ElementType.TYPE 可以給一個類型進行注解,比如類缘挑、接口集歇、枚舉
需要使用@Retention
來控制標簽的生命周期,其實就是你在什么時候去處理這個標簽语淘,處理完肯定不要了诲宇,不然占空間
- RetentionPolicy.SOURCE 注解只在源碼階段保留,在編譯器進行編譯時它將被丟棄忽視亏娜。
- RetentionPolicy.CLASS 注解只被保留到編譯進行的時候焕窝,它并不會被加載到 JVM 中。
- RetentionPolicy.RUNTIME 注解可以保留到程序運行的時候维贺,它會被加載進入到 JVM 中它掂,所以在程序運行時可以獲取到它們。
然后里面可以設置一些屬性溯泣,注解的屬性也叫做成員變量虐秋。注解只有成員變量,沒有方法垃沦。注解的成員變量在注解的定義中以“無形參的方法”形式來聲明客给,其方法名定義了該成員變量的名字,其返回值定義了該成員變量的類型
運行時標簽的使用
上面的標簽定義為給類型注解肢簿,所以直接在類上面使用就好了靶剑,設置了可以在運行時使用,所以可以在程序運行的代碼里面獲取到標簽池充,但是接下來桩引,獲取到標簽后要干什么就取決于個人了
@AnnotationClass(name = "Tyhj")
public class Main {
public static void main(String[] args) {
//這個類是否使用了AnnotationClass這個注解
boolean hasAnnotation = Main.class.isAnnotationPresent(AnnotationClass.class);
if (hasAnnotation) {
//獲取到AnnotationClass對象
AnnotationClass annotationClass = Main.class.getAnnotation(AnnotationClass.class);
String name = annotationClass.name();
int id = annotationClass.id();
System.out.println("name:" + name + ",id:" + id);
}
}
}
然后對于方法和成員變量的使用方法
AnnotationField
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface AnnotationField {
String defultValue() default "哈哈哈";
}
AnnotationMethod
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface AnnotationMethod {
}
簡單的獲取出標簽
@AnnotationClass(name = "Tyhj")
public class Main {
@AnnotationField(defultValue = "嗨收夸,你好")
private String msg;
@AnnotationMethod
private Long getTime() {
return System.currentTimeMillis();
}
public static void main(String[] args) {
Main main = new Main();
//判斷這個類是否存在這個注解
boolean hasAnnotation = Main.class.isAnnotationPresent(AnnotationClass.class);
if (hasAnnotation) {
//獲取到注解實例
AnnotationClass annotationClass = Main.class.getAnnotation(AnnotationClass.class);
String name = annotationClass.name();
int id = annotationClass.id();
System.out.println("name:" + name + "坑匠,id:" + id);
}
//獲取成員變量的注解
try {
Field field = Main.class.getDeclaredField("msg");
//msg成員變量為private,故必須進行此操作
field.setAccessible(true);
AnnotationField check = field.getAnnotation(AnnotationField.class);
//這里把注解的內容賦值給變量
main.msg = check.defultValue();
} catch (NoSuchFieldException e) {
e.printStackTrace();
}
//獲取方法的注解
try {
Method method = Main.class.getDeclaredMethod("getTime");
method.setAccessible(true);
AnnotationMethod annotationMethod = method.getAnnotation(AnnotationMethod.class);
} catch (NoSuchMethodException e) {
e.printStackTrace();
}
}
}
都只是簡單的展示獲取標簽,其中獲取了獲取成員變量的標簽的值賦值給了運行的對象卧惜,通過這個就對@ViewById(R.id.textView)
的實現(xiàn)有點想法了吧
實現(xiàn)運行時標簽@ViewById
新建一個標簽厘灼,當標簽只有一個屬性并且為value的時候,使用的時候可以不用寫名字咽瓷,用value來保存id设凹,在運行的時候獲取出來初始化控件,應該是ok的
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ViewById {
int value() default -1;
}
具體的實現(xiàn)茅姜,需要找出所有的標簽闪朱,一個個看一下是不是ViewById標簽,是的話對之進行操作
@ViewById(R.id.txtView)
TextView txtView;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
initAnnotation();
txtView.setOnClickListener(v -> Toast.makeText(MainActivity.this, "醉了", Toast.LENGTH_SHORT).show());
}
/**
* 開始獲取注解進行操作
*/
private void initAnnotation() {
//獲得成員變量
Field[] fields = this.getClass().getDeclaredFields();
for (Field field : fields) {
//允許修改反射屬性
field.setAccessible(true);
//獲取到標簽
ViewById viewById = field.getAnnotation(ViewById.class);
if (viewById != null) {
try {
//向對象的這個Field屬性設置新值value
field.set(this, findViewById(viewById.value()));
} catch (IllegalAccessException e) {
e.printStackTrace();
}
}
}
}
甚至我們可以不寫ID值使用,但是需要這個變量的名字和ID名字一樣监透,這樣我們可以通過這個變量的名字去生成ID桶错,再進行綁定
@ViewById
TextView txtView;
...
//向對象的這個Field屬性設置新值value
if (viewById.value() == -1) {
field.set(this,findViewById(getId(MainActivity.this, field.getName())));
} else {
field.set(this, findViewById(viewById.value()));
}
...
/**
* 通過名字獲取資源文件的id
*
* @param context
* @param resName
* @return
*/
public static int getId(Context context, String resName) {
return context.getResources().getIdentifier(resName, "id", context.getPackageName());
}
這樣效果就和Butter Knife效果差不多一樣了呀,而且可以不寫ID胀蛮,但是這個是運行時注解院刁,一切都是運行時自己來寫的,封裝一下的確也可以實現(xiàn)這個功能粪狼,但是運行時注解效率稍微會低一點退腥,而且看一下Butter Knife的源碼,它是CLASS
再榄,是編譯時注解狡刘,在編譯的時候生成的代碼
@Retention(CLASS) @Target(FIELD)
public @interface BindView {
/** View ID to which the field will be bound. */
@IdRes int value();
}
編譯時注解來實現(xiàn)上面的功能看另一篇文章Android編譯時注解