快捷導(dǎo)航

一篇文章帶你搞定JAVA注解

更新時(shí)間：2021年07月14日 17:15:05 作者：香菜聊游戲

這篇文章主要介紹了詳解Java注解的實(shí)現(xiàn)與使用方法的相關(guān)資料,希望通過本文大家能夠理解掌握J(rèn)ava注解的知識(shí)，需要的朋友可以參考下

1、注解是什么

Java 注解用于為 Java 代碼提供元數(shù)據(jù)，看完這句話也許你還是一臉懵逼，用人話說就是注解不直接影響你的代碼執(zhí)行，僅提供信息。接下我將從注解的定義、元注解、注解屬性、自定義注解、注解解析JDK 提供的注解這幾個(gè)方面再次了解注解（Annotation）

2、jdk支持的注解有哪些

2.1 三種常用的注解：

@SuppressWarnings 注解的作用是阻止編譯器發(fā)出某些警告信息。它可以有以下參數(shù): 　

deprecation ：過時(shí)的類或方法警告?！　　　?/p>
unchecked：執(zhí)行了未檢查的轉(zhuǎn)換時(shí)警告?！　　　?/p>
allthrough：當(dāng)Switch程序塊直接通往下一種情況而沒有Break時(shí)的警告。

path：在類路徑、源文件路徑等中有不存在的路徑時(shí)的警告?！　　　?/p>
serial：當(dāng)在可序列化的類上缺少serialVersionUID定義時(shí)的警告?！?/p>
finally：任何finally子句不能完成時(shí)的警告?！　　?/p>
all：關(guān)于以上所有情況的警告

@Deprecated 該注解的作用是標(biāo)記某個(gè)過時(shí)的類或方法。

@Override 該注解用在方法前面，用來標(biāo)識(shí)該方法是重寫父類的某個(gè)方法。

2.2 元注解

元注解主要是用來注解自定義注解的注解，分別有@Retention、 @Target、 @Document、 @Inherited和@Repeatable（JDK1.8加入）五種。

下面講兩個(gè)平常最常用的注解：

@Retention 注解的生命周期，主要有

RetentionPolicy.SOURCE 僅存在于源碼中

RetentionPolicy.CLASS 默認(rèn)的策略，在class字節(jié)碼文件中存在，但運(yùn)行時(shí)無法獲得 RetentionPolicy.RUNTIME 在運(yùn)行時(shí)可以通過反射獲取到，也是最常用的。

@Target 注解的作用目標(biāo)，主要有

ElementType.TYPE 作用接口、類、枚舉、注解

ElementType.FIELD 作用屬性字段、枚舉的常量

ElementType.METHOD 作用方法

ElementType.PARAMETER 作用方法參數(shù)

ElementType.CONSTRUCTOR 作用構(gòu)造函數(shù)

ElementType.LOCAL_VARIABLE 作用局部變量

ElementType.ANNOTATION_TYPE 作用于注解（@Retention注解中就使用該屬性） ElementType.PACKAGE 作用于包 ElementType.TYPE_PARAMETER 作用于類型泛型，即泛型方法、泛型類、泛型接口（jdk1.8加入）

3、注解實(shí)例

在枚舉中編譯器只會(huì)限制枚舉的名字不能重復(fù)，在開發(fā)中經(jīng)常會(huì)遇到枚舉Id 重復(fù)的問題，因?yàn)槊總€(gè)人在開發(fā)功能的時(shí)候一般只會(huì)專注于自己的功能，做完只會(huì)直接提交代碼，不會(huì)注意到枚舉Id沖突，這個(gè)時(shí)候可以使用下面的代碼進(jìn)行枚舉自檢，在項(xiàng)目的開發(fā)階段就能及時(shí)發(fā)現(xiàn)代碼的問題。下面的代碼稍微修改下就可以在項(xiàng)目中使用，拿走不寫。

1、自定義注解

檢測(cè)枚舉的key 是否有重復(fù)

package org.pdool.anno;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* @author 香菜
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface CheckEnum {
}

2、在對(duì)應(yīng)的方法上增加注解

package org.pdool.anno;
/**
* 資源枚舉類
* @author 香菜
*/
public enum ResType {
   GOLD(1),
   DIAMOND(2),
   //注意：此處重復(fù)
   SILVER(2);
   int type;
   @CheckEnum
   public int getType() {
       return type;
  }
   ResType(int type) {
       this.type = type;
  }
}

3、在項(xiàng)目啟動(dòng)的時(shí)候檢查注解的枚舉

package org.pdool.anno;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.HashSet;
import java.util.Set;
/**
* @author 香菜
*/
public class Aain {
   public static void main(String[] args) throws InvocationTargetException,IllegalAccessException {
       // 獲取有注解的方法
       Method[] declaredMethods = ResType.class.getDeclaredMethods();
       Method annoMethod = null;
       for (Method declaredMethod : declaredMethods) {
           CheckEnum  annotation = declaredMethod.getAnnotation(CheckEnum.class);
           if (annotation != null){
               annoMethod = declaredMethod;
              break;
          }
      }
       Set<Object> set = new HashSet<>();
       // 遍歷每個(gè)枚舉的id
       Object[] oo = ResType.class.getEnumConstants();
       for (Object o : oo) {
           Object invoke = annoMethod.invoke(o);
           if (!set.contains(invoke)){
               set.add(invoke);
          }else {
               System.out.println("重復(fù)的key "+ o +" -- "+ invoke);
          }
      }
  }
}