注釋與注解

• 一、注釋
• • 1、定義
  • 2、用法
• 二、注解Annontation
• • 1、定義
  • 2、作用
  • 3、原理
  • 4、注解的分類
  • • 4.1 內置注解
    • 4.2 元注解
    • 4.3 自定義注解

前言：
剛剛開始的新手Java開發者都會分不清注釋與注解的區別，總是會混淆。那么注釋和注解又有什么樣的區別呢？

一、注釋

1、定義

給人看的，便于閱讀代碼，對代碼的描述。

2、用法

// ：對一句代碼句的注釋
/**/ ：對段代碼塊的注釋
/** */ ：文檔注釋

二、注解Annontation

1、定義

對代碼的描述，作為代碼形式保留下來。

? （Annontation像一種修飾符一樣，應用于包，類型，構造方法，方法，成員變量，參數以及本地變量 的聲明語句中）

2、作用

1、生成文檔。這是最常見的，也是java 最早提供的注解。常用的有@param @return 等
2、跟蹤代碼依賴性，實現替代配置文件功能。比如Spring的注入，未來java開發，將大量注解配置，具有很大用處;
3、在編譯時進行格式檢查。如@override 放在方法前，如果你這個方法并不是覆蓋了超類方法，則編譯時就能檢查出

注解的本質: 特殊的接口

聲明注解: 創建了一個特殊接口，通過反射獲取注解

使用注解: @注解名(創建注解的一個對象)

3、原理

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

這個運行時生成的動態代理對象是可以導出到文件的，方法有兩種

• 在代碼中加入System.setProperty(“sun.misc.ProxyGenerator.saveGeneratedFiles”,
  “true”);
• 在運行時加入jvm 參數 -Dsun.misc.ProxyGenerator.saveGeneratedFiles=true

4、注解的分類

4.1 內置注解

定義：

jdk定義好這個注解的聲明, 開發者直接使用, 語法檢查

（1） @Override 檢測重寫

public class Run1 implements Runnable{@Overridepublic void run() {System.out.println("重寫父類Runnable的run()方法");} }

（2） @Deprecated 已過時, 只是一個標志, 還是能夠使用
-

/*** This method is deprecated and should not be used because SQL Date* values do not have a time component.** @deprecated* @exception java.lang.IllegalArgumentException if this method is invoked* @see #setHours*/@Deprecated //已棄用public int getHours() {throw new java.lang.IllegalArgumentException();}

（3） @SuppressWarnings("all") 抑制編譯器生成警告信息

@SuppressWarnings("all") public class Demo1 {@SuppressWarnings("all")public void fun1(){System.out.println("dddd");} }

4.2 元注解

定義：

jdk定義好這個注解的聲明, 在注解上使用

（1）.@Documented-注解是否將包含在JavaDoc中

? 一個簡單的Annotations標記注解，表示是否將注解信息添加在javadoc文檔中

（2）.@Retention –什么時候使用該注解

? Retention 的英文意為保留期的意思。當 @Retention 應用到一個注解上的時候，它解釋說明了這個注解的的存活時間

它的取值如下：

• RetentionPolicy.SOURCE 注解只在源碼階段保留，在編譯器進行編譯時它將被丟棄忽視。

• RetentionPolicy.CLASS 注解只被保留到編譯進行的時候，它并不會被加載到 JVM 中。

• RetentionPolicy.RUNTIME 注解可以保留到程序運行的時候，它會被加載進入到 JVM 中，所以在程序運行時可以獲取到它們。

自定義注解: 保留期一定設置為runtime

（3）.@Target–注解用于什么地方

? 默認值為任何元素，表示該注解用于什么地方。可用的ElementType參數包括

● ElementType.CONSTRUCTOR:用于描述構造器
●ElementType.FIELD:成員變量、對象、屬性（包括enum實例）
●ElementType.LOCAL_VARIABLE:用于描述局部變量
● ElementType.METHOD:用于描述方法
●ElementType.PACKAGE:用于描述包
● ElementType.PARAMETER:用于描述參數
●ElementType.TYPE:用于描述類、接口(包括注解類型) 或enum聲明

（4）.@Inherited – 定義該注釋和子類的關系

? Inherited 是繼承的意思，但是它并不是說注解本身可以繼承，而是說如果一個超類被 @Inherited 注解過的注解進行注解的話，那么如果它的子類沒有被任何注解應用的話，那么這個子類就繼承了超類的注解

4.3 自定義注解

聲明注解的語法: @interface

public @interface 注解名{ //成員 }

使用注解:

在方法,類型,包,構造方法,屬性,參數… 使用注解

@注解名

使用注解注意事項:

自定義注解: 關鍵字@interface , 默認繼承Annotation接口, 本質就是一個接口

參數成員訪問修飾符: public 或者是缺省的(還是public), 參數名后面必須是()

參數本質就是一個抽象方法

但是我們可以使用注解的時候,給參數賦值, 在聲明的時候, 設置默認值

參數名() default 值;

如果一個參數沒有設置default默認值, 使用這個注解的時候, 一定要給參數賦值,

如果使用default, 使用注解的時候, 可以給參數賦值,也可以不賦值(使用默認值)

參數的數據類型: 八大基本數據類型,String, 枚舉,Class,注解類型,或者12種的數組類型

自定義的注解,可以有參數,也可以沒有參數, 如果沒有參數,這個注解沒有意義

自定義注解,它的功能, 必須寫代碼解析注解,并給它賦予功能,自定義注解保留期: 一定為RUNTIME, 獲取該注解的對象, 只能使用反射來獲取

自定義注解例子：
商品類: 上架方法, 下架方法, 購買方法, 瀏覽方法,

要求: 上架方法, 下架方法,必須要求用戶的角色是"管理員"

? 購買方法: 必須要求用戶的角色是"顧客"

? 瀏覽方法: 不需要角色

自定義一個角色的注解

/*** 角色的注解*/ //如果這個參數名為value, 單獨給這個value參數賦值, 省略 value=// 如果給多個參數賦值, value= 一定不能省略 @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface Role {String value(); }

商品類，調用角色注解

/*** 商品類*/ public class Product {@Role("管理員")public void shangJia(){System.out.println("商品正在上架...");}@Role("管理員")public void xiaJia(){System.out.println("商品正在下架...");}@Role("顧客")public void buy(){System.out.println("您正在購買商品...");}public void look(){System.out.println("您正在查看商品...");} }

Test測試

public class TestProduct {public static void main(String[] args) throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {Scanner input = new Scanner(System.in);System.out.println("請輸入您的角色:");String role = input.next();System.out.println("請輸入您的調用的方法:");String methodName = input.next();//調用Product的方法Product product = new Product();//調用方法之前,判斷你的角色與方法上定義的角色是否匹配//如果不匹配, 禁止訪問, 如果匹配,允許訪問//通過反射//1.獲取Product類的Class對象Class<Product> clazz = Product.class;//2.獲取指定方法名的Method對象Method method = clazz.getDeclaredMethod(methodName);//判斷您的角色是否滿足//3.獲取這個方法上的需要角色: 使用注解//判斷是否有@Role注解 isAnnotationPresent(注解的Class類型) true表示有, false:沒有if(method.isAnnotationPresent(Role.class)){ //true//判斷角色是否匹配//獲取這個方法上@Role的value參數//獲取方法上的注解對象 getAnnotation(類<A> annotationClass) 獲取指定類型的注解對象//Annotation[] getAnnotations() 獲取所有的注解對象Role obj = method.getAnnotation(Role.class);//獲取它的參數值String value = obj.value();if(role.equals(value)){ //角色是否匹配System.out.println("您有權限訪問...");method.invoke(product);}else{System.out.println("您沒有權限訪問...");}}else{//沒有,直接執行method.invoke(product);}//3.調用方法//method.invoke(product);} }

結果

總結

以上是生活随笔為你收集整理的Java中的注解的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。