java基礎之--註解（一）

時間 2019-12-07

標籤 java 基礎註解欄目 Java 简体版

原文原文鏈接

最近學習spring5的時候，發現好像多了一些新的註解，因而乎想好好看看這些註解究竟是怎麼實現的，可是奈何本身連基礎的元註解都仍是隻知其一;不知其二，因此仍是萬丈高樓平地起，一切以基礎爲重。下面就來講說jdk自帶的元註解，與新手朋友們分享也爲本身填一個坑。php

1.什麼是元註解

元註解就是一種基本註解，它可以應用到其它的註解上面。全部的註解都會基於元註解。或者換句話說元註解就是給咱們自定義註解用的。 html

2.元註解有哪幾種

目前 jdk1.8 擁有的元註解5種，分別是：java

元註解	用處	取值
@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修飾的註解能夠重複的修飾某個元素。

前三種都比較好理解，後面兩種我給舉個例子看看：spring

@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：重複安全

這裏有個概念：容器註解，且看下文ide

//容器註解

@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.註解的屬性

先提幾個概念：函數式編程

註解只有成員變量，沒有方法。
註解的成員變量就是以「無形參的方法」形式來聲明。
方法名定義了該成員變量的名字，其返回值既是該成員變量的類型。

自定義一個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 表達式。這是另外的主題了，有興趣的同窗請本身搜索相關知識點學習。

參考博文：https://jingyan.baidu.com/article/a3761b2bf05f661576f9aaf3.html

http://www.javashuo.com/article/p-sroqmnzv-ko.html