1. 程式人生 > >java基礎之--註解(一)

java基礎之--註解(一)

       最近學習spring5的時候,發現好像多了一些新的註解,於是乎想好好看看這些註解到底是怎麼實現的,但是奈何自己連基礎的元註解都還是一知半解,所以還是萬丈高樓平地起,一切以基礎為重。下面就來說說jdk自帶的元註解,與新手朋友們分享也為自己填一個坑。

1.什麼是元註解

       元註解就是一種基本註解,它能夠應用到其它的註解上面。所有的註解都會基於元註解。或者換句話說元註解就是給我們自定義註解用的。 

2.元註解有哪幾種

目前 jdk1.8 擁有的元註解5種,分別是:

元註解 用處 取值
@Retention 表明了這個註解的的存活時間。
  • RetentionPolicy.SOURCE  註解只在原始碼階段保留,在編譯時會被丟棄。
  • RetentionPolicy.CLASS  註解可以在class檔案中保留,但會被JVM 丟棄。
  • RetentionPolicy.RUNTIME 註解可以保留到程式執行的時候,它會被載入進入到 JVM 中,所以在程式執行時可以獲取到它們,也可以改變它們。
@Documented 它的作用是能夠將註解中的元素包含到 Javadoc 中去。
@Target Target 是目標的意思,指定了註解運用的地方。
  • ElementType.ANNOTATION_TYPE 可以給一個註解進行註解
  • ElementType.CONSTRUCTOR 可以給構造方法進行註解
  • ElementType.FIELD 可以給屬性進行註解
  • ElementType.LOCAL_VARIABLE 可以給區域性變數進行註解
  • ElementType.METHOD 可以給方法進行註解
  • ElementType.PACKAGE 可以給一個包進行註解
  • ElementType.PARAMETER 可以給一個方法內的引數進行註解
  • ElementType.TYPE 可以給一個型別進行註解,比如類、介面、列舉
@Inherited Inherited 是繼承的意思,但是它並不是說註解本身可以繼承,而是說如果一個超類被 @Inherited 註解過的註解進行註解的話,那麼如果它的子類沒有被任何註解應用的話,那麼這個子類就繼承了超類的註解。     子類就繼承了超類的註解
@Repeatable Repeatable 自然是可重複的意思。@Repeatable 是 Java 1.8 才加進來的,所以算是一個新的特性。     被Repeatable修飾的註解可以重複的修飾某個元素。

前三種都比較好理解,後面兩種我給舉個例子看看:

@Inherited:繼承

 我們先自定義一個註解

@Inherited
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    
}

//ClassA使用此註解,ClassB 繼承 ClassA,相當於ClassB也具有此註解

@MyAnnotation
public class ClassA {
}

public class ClassB extends ClassA {
}

@Repeatable:重複

這裡有個概念:容器註解,且看下文

//容器註解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyRepeatables {
    MyRepeatable [] value();//按照規定,它裡面必須要有一個 value 的屬性,屬性型別是一個被 @Repeatable 註解過的註解,注意value它是陣列;
}

//使用@Repeatable將@MyRepeatable變成可重複的

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(MyRepeatables.class)
public @interface MyRepeatable {
    String role();
}

//測試

@MyRepeatable(role = "PM")
@MyRepeatable(role = "PA")
@MyRepeatable(role = "PC")
public class Test {
}

3.註解的屬性

先提幾個概念:

  1. 註解只有成員變數,沒有方法。
  2. 註解的成員變數就是以“無形參的方法”形式來宣告。
  3. 方法名定義了該成員變數的名字,其返回值既是該成員變數的型別。

自定義一個Person註解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Person {

    String name();

    int age();
}

上面程式碼定義了 Person這個註解中擁有 name 和 age 兩個屬性。在使用的時候,我們應該給它們進行賦值。

賦值的方式如下形式,多個屬性之前用 ,隔開。

@Person(age=20,name="java")
public class Test {

}

需要注意的是,在註解中定義屬性時它的型別必須是 8 種基本資料型別外加 類、介面、註解及它們的陣列。

註解中屬性可以有預設值,預設值需要用 default 關鍵值指定。比如:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Person{

    public int age() default 20;

    public String name() default "php";

}

相當於

@Person()
public class Test {

}

因為有預設值,所以無需要再在 @Person 後面的括號裡面進行賦值了,這一步可以省略。

另外,還有一種情況。如果一個註解內僅僅只有一個名字為 value 的屬性時,應用這個註解時可以直接接屬性值填寫到括號內。

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface Check {
    String value();
}

上面程式碼中,Check 這個註解只有 value 這個屬性。所以可以這樣應用。

@Check("hi")
int a;

這和下面的效果是一樣的

@Check(value="hi")
int a;

最後,還需要注意的一種情況是一個註解沒有任何屬性。比如

public @interface Perform {}

那麼在應用這個註解的時候,括號都可以省略。

@Perform
public void testMethod(){}

4.Java 預置的註解

其實Java 語言本身已經提供了幾個現成的非元註解的註解。

@Deprecated

這個元素是用來標記過時的元素,想必大家在日常開發中經常碰到。編譯器在編譯階段遇到這個註解時會發出提醒警告,告訴開發者正在呼叫一個過時的元素比如過時的方法、過時的類、過時的成員變數。

@Override

這個大家很熟悉了,提示子類要複寫父類中被 @Override 修飾的方法。

@SuppressWarnings

阻止警告的意思。之前說過呼叫被 @Deprecated 註解的方法後,編譯器會警告提醒,而有時候開發者會忽略這種警告,他們可以在呼叫的地方通過 @SuppressWarnings 達到目的。

@SafeVarargs

引數安全型別註解。它的目的是提醒開發者不要用引數做一些不安全的操作,它的存在會阻止編譯器產生 unchecked 這樣的警告。它是在 Java 1.7 的版本中加入的。

@FunctionalInterface

函式式介面註解,這個是 Java 1.8 版本引入的新特性。函數語言程式設計很火,所以 Java 8 也及時添加了這個特性。

函式式介面 (Functional Interface) 就是一個具有一個方法的普通介面。

比如

@FunctionalInterface
public interface Runnable {
    /**
     * When an object implementing interface <code>Runnable</code> is used
     * to create a thread, starting the thread causes the object's
     * <code>run</code> method to be called in that separately executing
     * thread.
     * <p>
     * The general contract of the method <code>run</code> is that it may
     * take any action whatsoever.
     *
     * @see     java.lang.Thread#run()
     */
    public abstract void run();
}

我們進行執行緒開發中常用的 Runnable 就是一個典型的函式式介面,上面原始碼可以看到它就被 @FunctionalInterface 註解。

可能有人會疑惑,函式式介面標記有什麼用,這個原因是函式式介面可以很容易轉換為 Lambda 表示式。這是另外的主題了,有興趣的同學請自己搜尋相關知識點學習。