註解的使用

https://blog.csdn.net/briblue/article/details/73824058

https://blog.csdn.net/javazejian/article/details/71860633

 

註解的定義及作用

註解可以理解爲一個標籤,給類或方法加標籤。

官方的定義:註解是一系列元數據,它提供數據用來解釋程序代碼,但是註解並非是所解釋的代碼本身的一部分。註解對於代碼的運行效果沒有直接影響。

註解本質是一個繼承了Annotation的特殊接口,其具體實現類是Java運行時生成的動態代理類。而我們通過反射獲取註解時,返回的是Java運行時生成的動態代理對象$Proxy1。通過代理對象調用自定義註解(接口)的方法,會最終調用AnnotationInvocationHandler的invoke方法。該方法會從memberValues這個Map中索引出對應的值。而memberValues的來源是Java常量池。

我的理解:註解就是給類、方法、屬性打上一個標籤。  這個標籤如果不做其它處理,本身是沒有任何作用的。  所有會有對應的處理代碼,處理方式是通過反射獲取註解屬性及值,之後再按照我們的處理邏輯來舒勇。

編譯階段的註解,編譯器讀到註解,則進行相應的處理。
spring的註解,在加載時spring使用反射讀到註解,進行相應的操作,如自動注入。

處理 Annotation 的代碼統稱爲 APT(Annotation Processing Tool)

 

註解的基本知識和語法

定義註解使用@interface定義,其本身也類似於一個接口。

元註解,即用來定義註解的註解,給這個註解打上標籤。

元標籤有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 種。

@Retention

    RetentionPolicy.SOURCE 註解只在源碼階段保留,在編譯器進行編譯時它將被丟棄忽視。
    RetentionPolicy.CLASS 註解只被保留到編譯進行的時候,它並不會被加載到 JVM 中。
    RetentionPolicy.RUNTIME 註解可以保留到程序運行的時候,它會被加載進入到 JVM 中,所以在程序運行時可以獲取到它

@Target

    ElementType.ANNOTATION_TYPE 可以給一個註解進行註解
    ElementType.CONSTRUCTOR 可以給構造方法進行註解
    ElementType.FIELD 可以給屬性進行註解
    ElementType.LOCAL_VARIABLE 可以給局部變量進行註解
    ElementType.METHOD 可以給方法進行註解
    ElementType.PACKAGE 可以給一個包進行註解
    ElementType.PARAMETER 可以給一個方法內的參數進行註解
    ElementType.TYPE 可以給一個類型進行註解,比如類、接口、枚舉

@Inherited

    可以被繼承,子類自動繼承父類的標籤。

@Repeatable

     可以重複,同一個地方可以加多個相同的標籤

//定義一個註解

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE,ElementType.METHOD})
public @interface PiaoQian {
	int value1() default 0;
	String[] value2() default {"a","b"};
	int value3();   //如果沒有指定默認值,則在使用該註解時比如指定值
        public int value4();  //一般不寫這個public 可以這其實是一個(類似於)方法,如同接口類
}

註解的屬性

註解只有成員變量,沒有方法。

以“無形參的方法”形式來聲明,方法名定義變量名字,返回值定義變量類型。

定義屬性時它的類型必須是 8 種基本數據類型外加 類、接口、註解  以及它們的數組。

 

以上就是註解的基本概念


怎麼在代碼中提取出註解

通過反射的方式去處理,Class、Method 、Field類中包含對註解的處理。

@TestAnnotation(msg="hello")
public class Test {
	
    @Check(value="hi")
    int a;
	
	
    @Perform
    public void testMethod(){}
	
	
    @SuppressWarnings("deprecation")
    public void test1(){

    }


    public static void main(String[] args) throws Exception {
	
        //判斷此類中是否包含@TestAnnotation註解
	boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);
		
	if ( hasAnnotation ) {
            //獲取到該註解
	    TestAnnotation aat = Test.class.getAnnotation(TestAnnotation.class);
	    ///輸出註解的內容,和調用成員變量的方式語法一樣
	    System.out.println(aat.id());
	    System.out.println(aat.msg());
	}
		
	
	Field a = Test.class.getDeclaredField("a");
	a.setAccessible(true);  //關閉安全檢查,提高效率
	//獲取一個成員變量上的註解
	Check check = a.getAnnotation(Check.class);
	if ( check != null ) {
	    System.out.println(check.value());
	}
	
	
	Method testMethod = Test.class.getDeclaredMethod("testMethod");
	if ( testMethod != null ) {
	     // 獲取方法上的所有註解
	     Annotation[] ans = testMethod.getAnnotations();
	     for( int i = 0;i < ans.length;i++) {
	        System.out.println(ans[i].annotationType().getSimpleName());
	     }
	}

		
    }

}

註解的實際作用及用法

當開發者使用了Annotation 修飾了類、方法、Field 等成員之後,這些 Annotation 不會自己生效,必須由開發者提供相應的代碼來提取並處理 Annotation 信息。這些處理提取和處理 Annotation 的代碼統稱爲 APT(Annotation Processing Tool)。
 

寫一個測試框架,測試程序員的代碼有無明顯的異常。

—— 程序員 A : 我寫了一個類,它的名字叫做 NoBug,因爲它所有的方法都沒有錯誤。
—— 我:自信是好事,不過爲了防止意外,讓我測試一下如何?
—— 程序員 A: 怎麼測試?
—— 我:把你寫的代碼的方法都加上 @Jiecha 這個註解就好了。
—— 程序員 A: 好的。

package ceshi;
import ceshi.Jiecha;


public class NoBug {
	
	@Jiecha
	public void suanShu(){
		System.out.println("1234567890");
	}
	@Jiecha
	public void jiafa(){
		System.out.println("1+1="+1+1);
	}
	@Jiecha
	public void jiefa(){
		System.out.println("1-1="+(1-1));
	}
	@Jiecha
	public void chengfa(){
		System.out.println("3 x 5="+ 3*5);
	}
	@Jiecha
	public void chufa(){
		System.out.println("6 / 0="+ 6 / 0);
	}
	
	public void ziwojieshao(){
		System.out.println("我寫的程序沒有 bug!");
	}

}

上面的代碼,有些方法上面運用了 @Jiecha 註解。

這個註解是我寫的測試軟件框架中定義的註解。

package ceshi;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
public @interface Jiecha {

}

然後,我再編寫一個測試類 TestTool 就可以測試 NoBug 相應的方法了。

package ceshi;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

public class TestTool {

    public static void main(String[] args) {
        // TODO Auto-generated method stub

	NoBug testobj = new NoBug();

	Class clazz = testobj.getClass();

	Method[] method = clazz.getDeclaredMethods();
	// 用來記錄測試產生的 log 信息
	StringBuilder log = new StringBuilder();
	// 記錄異常的次數
	int errornum = 0;

	for (Method m : method) {
	    // 只有被 @Jiecha 標註過的方法才進行測試
	    if (m.isAnnotationPresent(Jiecha.class)) {
		try {
	            m.setAccessible(true);
		    m.invoke(testobj, null);

		} catch (Exception e) {
		    errornum++;
		    log.append(m.getName());
		    log.append(" ");
		    log.append("has error:");
		    log.append("\n\r  caused by ");
		    log.append(e.getCause().getClass().getSimpleName());
		    log.append("\n\r");
		    // 記錄測試過程中,發生的異常的具體信息
		    log.append(e.getCause().getMessage());
		    log.append("\n\r");
		}
	    }
	}

	log.append(clazz.getSimpleName());
	log.append(" has  ");
	log.append(errornum);
	log.append(" error.");
	// 生成測試報告
	System.out.println(log.toString());

    }

}

提示 NoBug 類中的 chufa() 這個方法有異常,這個異常名稱叫做 ArithmeticException,原因是運算過程中進行了除 0 的操作。

所以,NoBug 這個類有 Bug。

這樣,通過註解我完成了我自己的目的,那就是對別人的代碼進行測試。

所以,再問我註解什麼時候用?我只能告訴你,這取決於你想利用它幹什麼用。
 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章