註解相關概念
什麼是元註解
元註解是負責對其它註解進行說明的註解，自定義註解時可使用元註解，Java 5 定義了 4 個註解，分別是 @Documented、@Target、@Retention 和 @Inherited。php
Java 8 又增長了 @Repeatable 和 @Native 兩個註解。這些註解均可以在 java.lang.annotation 包中找到。html
元註解使用與做用
1. @Documented
@Documented 是一個標記註解，沒有成員變量。用 @Documented 註解修飾的註解類會被 JavaDoc 工具提取成文檔。默認狀況下，JavaDoc 是不包括註解的，但若是聲明註解時指定了 @Documented，就會被 JavaDoc 之類的工具處理，因此註解類型信息就會被包括在生成的幫助文檔中。java
實例：shell
Documented註解定義數組
import java.lang.annotation.*;
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
public @interface DocAnno {
}
測試類ide
@DocAnno
public class TestDocAnno {
@DocAnno
public void doc(){}
}
打開類所在文件夾，輸入以下命令：工具
javadoc -d doc -encoding UTF-8 -charset UTF-8 *.java
運行成功後進入doc目錄，打開index.html文檔，可看到以下結果測試
<img src="https://i.loli.net/2020/06/06/GfeO4TwR2Zkryoj.png" alt="image-20200606214618178" style="zoom:50%;" />.net
<img src="https://i.loli.net/2020/06/06/6BGetyVkdM8NIxF.png" alt="image-20200606214644473" style="zoom:50%;" />code
jdk中源碼應用*@Deprecated*註解
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
public @interface Deprecated {
}
2. @Target
@Target 註解用來指定一個註解的使用範圍，即被 @Target 修飾的註解能夠用在什麼地方。@Target 註解有一個成員變量（value）用來設置適用目標，value 是 java.lang.annotation.ElementType 枚舉類型的數組，下表爲 ElementType 經常使用的枚舉常量。
| 名稱 | 說明 |
|---|---|
| CONSTRUCTOR | 用於構造方法 |
| FIELD | 用於成員變量（包括枚舉常量） |
| LOCAL_VARIABLE | 用於局部變量 |
| METHOD | 用於方法 |
| PACKAGE | 用於包 |
| PARAMETER | 用於類型參數（JDK 1.8新增） |
| TYPE | 用於類、接口（包括註解類型）或 enum 聲明 |
以下常見註解@Override做用在hashCode方法上，能夠看到@Override源碼中設置了@Target註解，而且指定了ElementType.METHOD，說明只能將@Override註解用於方法
public class DefineClass{
@Override
public int hashCode() {
return super.hashCode();
}
}
Override源碼
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}
3. @Retention
@Retention 用於描述註解的生命週期，也就是該註解被保留的時間長短。@Retention 註解中的成員變量（value）用來設置保留策略，value是java.lang.annotation.RetentionPolicy枚舉類型，RetentionPolicy有3個枚舉常量
public enum RetentionPolicy {
SOURCE, // 在源文件中有效（即源文件保留）
CLASS, // 在class文件中有效 - 設置此值說明在源碼和class文件中都有效
RUNTIME // 在運行時有效 - 設置此值說明在源碼、class文件中和運行時都有效
}
4. @Inherited
@Inherited 是一個標記註解，用來指定該註解能夠被繼承。使用 @Inherited 註解的 Class 類，表示這個註解能夠被用於該 Class 類的子類。就是說若是某個類使用了被 @Inherited 修飾的註解，則其子類將自動具備該註解。
自定義註解InheritedDemo，使用@Inherited註解進行修飾
import java.lang.annotation.*;
@Target(ElementType.TYPE)
@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface InheritedDemo {
}
自定義註解InheritedDemo使用
@InheritedDemo
public class Anno1 {
public static void main(String[] args) {
System.out.println(Anno1.class.getAnnotation(InheritedDemo.class));
System.out.println(Anno2.class.getAnnotation(InheritedDemo.class));
System.out.println(Anno3.class.getAnnotation(InheritedDemo.class));
}
}
public class Anno2 extends Anno1 {
}
public class Anno3 extends Anno2 {
}
運行完成後打印結果以下(說明類Anno二、類Anno3同時具有有註解@InheritedDemo)：
@InheritedDemo() @InheritedDemo() @InheritedDemo()
JDK8新增註解
1. @Repeatable
@Repeatable 註解是 Java 8 新增長的，它容許在相同的程序元素中重複註解，在須要對同一種註解屢次使用時，每每須要藉助 @Repeatable 註解。Java 8 版本之前，同一個程序元素前最多隻能有一個相同類型的註解，若是須要在同一個元素前使用多個相同類型的註解，則必須使用註解「容器」。
好比有個需求，要求給一個方法經過註解的方式設置多角色，其代碼實現以下：
Java 8以前的作法
public @interface Role {
String roleName();
}
public @interface Roles {
Role[] roles();
}
public class RolesTest {
@Roles(roles = {@Role(roleName = "role1"), @Role(roleName = "role2")})
public String doString(){
return "具有有多個角色權限";
}
}
Java 8 以後增長了重複註解，使用方式以下
public @interface Roles {
Role[] value();
}
@Repeatable(Roles.class)
public @interface Role {
String roleName();
}
public class RolesTest {
@Role(roleName = "role2")
@Role(roleName = "role1")
public String doString(){
return "具有有多個角色權限";
}
}
兩種方法得到的效果相同。重複註解只是一種簡化寫法，這種簡化寫法是一種假象，多個重複註解其實會被做爲「容器」註解的 value 成員的數組元素處理。
2. @Native
使用 @Native 註解修飾成員變量，則表示這個變量能夠被本地代碼引用，經常被代碼生成工具使用。對於 @Native 註解不常使用，瞭解便可。
//指示能夠從本機代碼引用定義常量值的字段。
//註釋能夠用做生成本機頭文件的工具的提示，以肯定是否須要頭文件，若是須要，它應該包含哪些聲明。
@Documented
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.SOURCE)
public @interface Native {
}
本文轉載：完美剖析Java元註解使用與做用