教科書級講解，秒懂最詳細Java的注解

教科書級講解，秒懂最詳細Java的注解

Java注解

一、Java注解概述

注解（Annotation），也叫中繼資料。一種代碼級别的說明。它是JDK1.5及以後版本引入的一個特性，與類、接口、枚舉是在同一個層次。它可以聲明在包、類、字段、方法、局部變量、方法參數等的前面，用來對這些元素進行說明，注釋。

二、注解的作用分類

編寫文檔： 通過代碼裡辨別的中繼資料生成文檔【生成文檔doc文檔】

代碼分析： 通過代碼裡辨別的中繼資料對代碼進行分析【使用反射】

編譯檢查： 通過代碼裡辨別的中繼資料讓編譯器能夠實作基本的編譯檢查【Override等】

編寫文檔

首先，我們要知道Java中是有三種注釋的，分别為單行注釋、多行注釋和文檔注釋。而文檔注釋中，也有@開頭的元注解，這就是基于文檔注釋的注解。我們可以使用javadoc指令來生成doc文檔，此時我們文檔的内元注解也會生成對應的文檔内容。這就是編寫文檔的作用。

代碼分析

我們頻繁使用之一，也是包括使用反射來通過代碼裡辨別的中繼資料對代碼進行分析的，此内容我們在後續展開講解。

編譯檢查

至于在編譯期間在代碼中辨別的注解，可以用來做特定的編譯檢查，它可以在編譯期間就檢查出“你是否按規定辦事”，如果不按照注解規定辦事的話，就會在編譯期間飄紅報錯，并予以提示資訊。可以就可以為我們代碼提供了一種規範制約，避免我們後續在代碼中處理太多的代碼以及功能的規範。比如，@Override注解是在我們覆寫父類（父接口）方法時出現的，這證明我們覆寫方法是繼承于父類（父接口）的方法，如果該方法稍加改變就會報錯；@FunctionInterface注解是在編譯期檢查是否是函數式接口的，如果不遵循它的規範，同樣也會報錯。

三、jdk的内置注解

3.1 内置注解分類

@Override： 标記在成員方法上，用于辨別目前方法是重寫父類（父接口）方法，編譯器在對該方法進行編譯時會檢查是否符合重寫規則，如果不符合，編譯報錯。

@Deprecated： 用于标記目前類、成員變量、成員方法或者構造方法過時如果開發者調用了被标記為過時的方法，編譯器在編譯期進行警告。

@SuppressWarnings： 壓制警告注解，可放置在類和方法上，該注解的作用是阻止編譯器發出某些警告資訊。

3.2 @Override注解

标記在成員方法上，用于辨別目前方法是重寫父類（父接口）方法，編譯器在對該方法進行編譯時會檢查是否符合重寫規則，如果不符合，編譯報錯。

這裡解釋一下@Override注解，在我們的Object基類中有一個方法是toString方法，我們通常在實體類中去重寫此方法來達到列印對象資訊的效果，這時候也會發現重寫的toString方法上方就有一個@Override注解。如下所示：

image-20200604203535421

于是，我們試圖去改變重寫後的toString方法名稱，将方法名改為toStrings。你會發現在編譯期就報錯了！如下所示：

image-20200604203645332

那麼這說明什麼呢？這就說明該方法不是我們重寫其父類（Object）的方法。這就是@Override注解的作用。

3.3 @Deprecated注解

用于标記目前類、成員變量、成員方法或者構造方法過時如果開發者調用了被标記為過時的方法，編譯器在編譯期進行警告。

我們解釋@Deprecated注解就需要模拟一種場景了。假設我們公司的産品，目前是V1.0版本，它為使用者提供了show1方法的功能。這時候我們為産品的show1方法的功能又進行了擴充，打算釋出V2.0版本。但是，我們V1.0版本的産品需要抛棄嗎？也就是說我們V1.0的産品功能還繼續讓使用者使用嗎？答案肯定是不能抛棄的，因為有一部分使用者是一直用V1.0版本的。如果抛棄了該版本會損失很多的使用者量，是以我們不能抛棄該版本。這時候，我們對功能進行了擴充後，釋出了V2.0版本，我們給予使用者的通知就可以了，也就是告知使用者我們在V2.0版本中為功能進行了擴充。可以讓使用者自行選擇版本。

但是，除了釋出告知使用者版本情況之外，我們還需要在原來版本的功能上給予提示，在上面的模拟場景中我們需要在show1方法上方加@Deprecated注解給予提示。通過這種方式也告知使用者“這是舊版本時候的功能了，我們不建議再繼續使用舊版本的功能”，這句話的意思也就正是給使用者做了提示。使用者也會這麼想“奧，這版本的這個功能不好用了，肯定有新版本，又更好用的功能。我要去官網查一下下載下傳新版本”，還會有使用者這麼想“我明白了，又更新出更好的功能了，但是這個版本的功能我已經夠用了，不需要重新下載下傳新版本了”。

那麼我們怎麼檢視我上述所說的在功能上給予的提示呢？這時候我需要去建立一個方法，然後去調用show1方法，并檢視調用時它是如何提示的。

圖已經貼出來了，你是否發現的新舊版本功能的異同點呢？很明顯，在方法中的提示是在調用的方法名上加了一道橫線把該方法劃掉了。這就展現了show1方法過時了，已經不建議使用了，我們為你提供了更好的。

回想起來，在我們的api中也會有方法是過時的，比如我們的Date日期類中的方法有很多都已經過時了。如下圖：

image-20200604210154348

image-20200604210416762

如你所見，是不是有很多方法都過時了呢？那它的方法上是加了@Deprecated注解嗎？來跟着我的腳步，我帶你們看一下。

我們已經知道的Date類中的這些方法已經是過時的了，如果我們使用該方法并執行該程式的話。執行的過程中就會提示該方法已過時的内容，但是隻是提示，并不影響你使用該方法。如下：

image-20200604221938895

OK！這也就是@Deprecated注解的作用了。

3.4 @SuppressWarnings注解

壓制警告注解，可放置在類和方法上，該注解的作用是阻止編譯器發出某些警告資訊，該注解為單值注解，隻有 一個value參數，該參數為字元串數組類型，參數值常用的有如下幾個。

unchecked：未檢查的轉化，如集合沒有指定類型還添加元素

unused：未使用的變量

resource：有泛型未指定類型

path：在類路徑，原檔案路徑中有不存在的路徑

deprecation：使用了某些不贊成使用的類和方法

fallthrough：switch語句執行到底沒有break關鍵字

rawtypes：沒有寫泛型，比如: List list = new ArrayList();

all：全部類型的警告

壓制警告注解，顧名思義就是壓制警告的出現。我們都知道，在Java代碼的編寫過程中，是有很多黃色警告出現的。但是我不知道你的導師是否教過你，程式員隻需要處理紅色的error，不需要理會黃色的warning。如果你的導師說過此問題，那是有原因的。因為在你學習階段，我們認清處理紅色的error即可，這樣可以減輕你學習階段在腦部的記憶内容。如果你剛剛加入學習Java的隊列中，需要大腦記憶的東西就有太多了，也就是我們目前不需要額外記憶其他的東西，隻記憶重點即可。至于黃色warning嘛，在你的學習過程中慢慢就會有所了解的，而不是死記硬背的。

那為了解釋@SuppressWarnings注解，我們還使用上一個例子，因為在那個例子中就有黃色的warning出現。

而每一個黃色的warning都會有警告資訊的。比如，這一個圖中的警告資訊，就告知你show2()方法沒有被使用，簡單來說，你建立的show2方法，但是你在代碼中并沒有調用過此方法。以後你便會遇到各種各樣黃色的warning。然後， 我們就可以使用不同的注解參數來壓制不同的注解。但是在該注解的參數中，提供了一個all參數可以壓制全部類型的警告。而這個注解是需要加到類的上方，并賦予all參數，即可壓制所有警告。如下：

image-20200604213943722

我們加入注解并賦予all參數後，你會發現use方法和show2方法的警告沒有了，實際上導Date包的警告還在，因為我們Date包導入到了該類中，但是我們并沒有建立Date對象，也就是并沒有寫入Date在代碼中，你也會發現那一行是灰色的，也就證明了我們沒有去使用導入這個包的任何資訊的說法，出現這種情況我們就需要把這個沒有用的導包内容删除掉，使用Ctrl + X删除導入沒有用到的包即可。還有一種辦法就是在包的上方修飾壓制警告注解，但是我認為在一個沒有用的包上加壓制注解是毫無意義的，是以，我們直接删除就好。

然後，我們還見到上圖，注解那一行出現了警告資訊提示。這一行的意思是備援的警告壓制。這就是說我們壓制以下的警告并沒有什麼意義而造成的備援，但是如果我們使用了該類并做了點什麼的話，壓制注解的備援警告就會消失，畢竟我們使用了該類，此時就不會早場備援了。

上述解釋@SuppressWarnings注解也差不多就這些了。OK，繼續向下看吧。持續為大家講解。

3.5 @Repeatable注解

@Repeatable 表明标記的注解可以多次應用于相同的聲明或類型，此注解由Java8版本引入。我們知道注解是不能重複定義的，其實該注解就是一個文法糖，它可以重複多此使用，更适用于我們的特殊場景。

首先，我們先建立一個可以重複使用的注解。

package com.mylifes1110.anno;

import java.lang.annotation.Repeatable;

@Repeatable(Hour.class)

public @interface Hours {

    double[] hours() default 0;

}

你會發現注解要求傳入的值是一個類對象，此類對象就需要傳入另外一個注解，這裡也就是另外一個注解容器的類對象。我們去建立一下。

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

//容器

@Target(ElementType.TYPE)

@Retention(RetentionPolicy.RUNTIME)

public @interface Hour {

    Hours[] value();

其實，這兩個注解的套用，就是将一個普通的注解封裝了一個可重複使用的注解，來達到注解的複用性。最後，我們建立一下測試類，随後帶你去看一下源碼。

package com.mylifes1110.java;

import com.mylifes1110.anno.Hours;

@Hours(hours = 4)

@Hours(hours = 4.5)

@Hours(hours = 2)

public class Worker {

    public static void main(String[] args) {

        //通過Hours注解類型來擷取Worker中的值數組對象

        Hours[] hours = Worker.class.getAnnotationsByType(Hours.class);

        //周遊數組

        for (Hours h : hours) {

            System.out.println(h);

        }

    }

測試類，是一個勞工測試類，該勞工使用注解記錄早中晚的工作時間。測試結果如下：

image-20200606183652359

然後我們進入到源碼一探究竟。

image-20200606183737877

我們發現進入到源碼後，就隻看見一個傳回值為類對象的抽象方法。這也就驗證了該注解隻是一個可實作重複性注解的文法糖而已。

四、注解分類

4.1 注解分類

注解可以根據注解參數分為三大類：

标記注解： 沒有參數的注解，僅用自身的存在與否為程式提供資訊，如@Override注解，該注解沒有參數，用于表示目前方法為重寫方法。

單值注解： 隻有一個參數的注解，如果該參數的名字為value，那麼可以省略參數名，如 @SuppressWarnings(value = "all")，可以簡寫為@SuppressWarnings("all")。

完整注解： 有多個參數的注解。

4.2 标記注解

說到@Override注解是一個标記注解，那我們進入到該注解的源碼檢視一下。從上往下看該注解源碼，發現它繼承了導入了java.lang.annotation.*，也就是有使用到該包的内容。然後下面就又是兩個看不懂的注解，其實發現注解的定義格式是public修飾的@Interface，最終看到該注解中方法體并沒有任何參數，也就是隻起到标記作用。

4.3 單值注解

在上面我們用到的@SuppressWarnings注解就是一個單值注解。那我們進入到它的源碼看一下是怎麼個情況。其實，和标記注解比較，它就多一個value參數而已，而這就是單值注解的必要條件，即隻有一個參數。并且這一個參數為value時，我們可以省略value。

4.4 完整注解

上述兩個類型注解講解完，至于完整注解嘛，這下就能更明白了。其中的方法體就是有多個參數而已。

五、自定義注解

5.1 自定義注解格式

格式： public @Interface 注解名 {屬性清單/無屬性}

注意： 如果注解體中無任何屬性，其本質就是标記注解。但是與其标注注解還少了上邊修飾的元注解。

如下，這就是一個注解。但是它與jdk自定義注解有點差別，jdk自定義注解的上方還有注解來修飾該注解，而那注解就叫做元注解。元注解我會在後面詳細的說到。

image-20200606104149069

這裡我們的确不知道@Interface是什麼，那我們就把自定義的這個注解反編譯一下，看一下反編譯資訊。反編譯操作如下：

image-20200606104818131

反編譯後的反編譯内容如下：

public interface com.mylifes1110.anno.MyAnno extends java.lang.annotation.Annotation {

首先，看過反編譯内容後，我們可以直覺的得知他是一個接口，因為它的public修飾符後面的關鍵字是interface。

其次，我們發現MyAnno這個接口是繼承了java.lang.annotation包下的Annotation接口。

是以，我們可以得知注解的本質就是一個接口，該接口預設繼承了Annotation接口。

既然，是繼承的Annotation接口，那我們就去進入到這個接口中，看它定義了什麼。以下是我抽取出來的接口内容。我們發現它看似很常見，其實它們不是很常用，作為了解即可。

public interface Annotation {

    boolean equals(Object obj);

    int hashCode();

    String toString();

    Class<? extends Annotation> annotationType();

最後，我們的注解中也是可以寫有屬性的，它的屬性不同于普通的屬性，它的屬性是抽象方法。既然注解也是一個接口，那麼我們可以說接口體中可以定義什麼，它同樣也可以定義，而它的修飾符與接口一樣，也是預設被public abstract修飾。

而注解體中的屬性也是有要求的。其屬性要求如下：

屬性的傳回值類型必須是以下幾種：

基本資料類型

String類型

枚舉類型

注解

以上類型的數組

注意： 在這裡不能有void的無傳回值類型和以上類型以外的類型

定義的屬性，在使用時需要給注解中的屬性指派

如果定義屬性時，使用default關鍵字給屬性預設初始化值，則使用注解時可以不為屬性指派，它取的是預設值。如果為它再次傳入值，那麼就發生了對原值的覆寫。

如果隻有一個屬性需要指派，并且屬性的名稱為value，則指派時value可以省略，可以直接定義值

數組指派時，值使用{}存儲值。如果數組中隻有一個值，則可以省略{}。

5.2 自定義注解屬性的傳回值

屬性傳回值既然有以上幾種，那麼我就在這裡寫出這幾種示範一下是如何寫的。

首先，定義一個枚舉類和另外一個注解備用。

package com.mylifes1110.enums;

public enum Lamp {

    RED, GREEN, YELLOW

public @interface MyAnno2 {

其次，我們來定義上述幾種類型，如下：

import com.mylifes1110.enums.Lamp;

public @interface MyAnno {

    //基本資料類型

    int num();

    //String類型

    String value();

    //枚舉類型

    Lamp lamp();

    //注解類型

    MyAnno2 myAnno2();

    //以上類型的數組

    String[] values();

    Lamp[] lamps();

    MyAnno2[] myAnno2s();

    int[] nums();

5.3 自定義注解的屬性指派

這裡我們示範一下，首先，我們使用該注解來進行示範。

随後建立一個測試類，在類的上方寫上注解，你會發現，注解的參數中會讓你寫這兩個參數（int、String）。

image-20200606113037920

此時，傳參是這樣來做的。格式為：名稱 = 傳回值類型參數。如下：

上述所說，如果使用default關鍵字給屬性預設初始化值，就不需要為其參數指派，如果指派的話，就把預設初始化的值覆寫掉了。

當然還有一個規則，如果隻有一個屬性需要指派，并且屬性的名稱為value，則指派時value可以省略，可以直接定義值。那麼，我們的num已經有了預設值，就可以不為它傳值。我們發現，注解中定義的屬性就剩下了一個value屬性值，那麼我們就可以來示範這個規則了。

image-20200606113849685

這裡，我并沒有寫屬性名稱value，而是直接為value指派。如果我将num的default關鍵字修飾去掉呢，那意思也就是說在使用該注解時必須為num指派，這樣可以省略value嗎？那我們看一下。

image-20200606114216801

結果，就是我們所想的，它報錯了，必須讓我們給num指派。其實想想這個規則也是很容易懂的，定義一個為value的值，就可以省略其value名稱。如果定義多個值，它們可以省略名稱就無法區分定義的是那個值了，關鍵是還有數組，數組内定義的是多個值呢，對吧。

5.4 自定義注解的多種傳回值類型指派

這裡我們示範一下，上述的多種傳回值類型是如何指派的。這裡我們定義這幾個參數來看一下，是如何為屬性指派的。

num是一個int基本資料類型，即num = 1

value是一個String類型，即value = "str"

lamp是一個枚舉類型，即lamp = Lamp.RED

myAnno2是一個注解類型，即myAnno2 = @MyAnno2

values是一個String類型數組，即values = {"s1", "s2", "s3"}

values是一個String類型數組，其數組中隻有一個值，即values = "s4"

注意： 值與值之間是,隔開的；數組是用{}來存儲值的，如果數組中隻有一個值可以省略{}；枚舉類型是枚舉名.枚舉值

六、元注解

6.1 元注解分類

元注解就是用來描述注解的注解。一般使用元注解來限制自定義注解的使用範圍、生命周期等等。

而在jdk的中java.lang.annotation包中定義了四個元注解，如下：

元注解 描述

@Target 指定被修飾的注解的作用範圍

@Retention 指定了被修飾的注解的生命周期

@Documented 指定了被修飾的注解是可以Javadoc等工具文檔化

@Inherited 指定了被修飾的注解修飾程式元素的時候是可以被子類繼承的

6.2 @Target

@Target 指定被修飾的注解的作用範圍。其作用範圍可以在源碼中找到參數值。

屬性 描述

CONSTRUCTOR 用于描述構造器

FIELD（常用） 用于描述屬性

LOCAL_VARIABLE 用于描述局部變量

METHOD（常用） 用于描述方法

PACKAGE 用于描述包

PARAMETER 用于描述參數

TYPE（常用） 用于描述類、接口(包括注解類型) 或enum聲明

ANNOTATION_TYPE 用于描述注解類型

TYPE_USE 用于描述使用類型

由此可見，該注解體内隻有一個value屬性值，但是它的類型是一個ElementType數組。那我們進入到這個數組中繼續檢視。

進入到該數組中，你會發現他是一個枚舉類，其中定義了上述表格中的各個屬性。

了解了@Target的作用和屬性值後，我們來使用一下該注解。首先，我們要先用該注解來修飾一個自定義注解，定義該注解的指定作用在類上。如下：

而你觀察如下測試類，我們把注解作用在類上時是沒有錯誤的。而當我們的注解作用在其他地方就會報錯。這也就說明了，我們@Target的屬性起了作用。

注意： 如果我們定義多個作用範圍時，也是可以省略該參數名稱了，因為該類型是一個數組，雖然能省略名稱但是，我們還需要用{}來存儲。

6.3 @Retention

@Retention 指定了被修飾的注解的生命周期

RetentionPolicy.SOURCE 注解隻在源碼階段保留，在編譯器進行編譯時它将被丢棄忽視。

RetentionPolicy.CLASS 注解隻被保留到編譯進行時的class檔案，但 JVM 加載class檔案時候被遺棄，也就是在這個階段不會讀取到該class檔案。

RetentionPolicy.RUNTIME（常用） 注解可以保留到程式運作的時候，它會被加載進入到 JVM 中，是以在程式運作時可以擷取到它們。

注意： 我們常用的定義即是RetentionPolicy.RUNTIME，因為我們使用反射來實作的時候是需要從JVM中擷取class類對象并操作類對象的。

首先，我們要了解反射的三個生命周期階段，這部分内容我在Java反射機制中也是做了非常詳細的說明，有興趣的小夥伴可以去看看我寫的Java反射機制，相信你在其中也會有所收獲。

這裡我再次強調一下這三個生命周期是源碼階段 - > class類對象階段 - > Runtime運作時階段。

那我們進入到源碼，看看@Retention注解中是否有這些參數。

我們看到該注解中的屬性隻有一個value，而它的類型是一個RetentionPolicy類型，我們進入到該類型中看看有什麼參數，是否與表格中的參數相同呢？

image-20200606145449931

至于該注解怎麼使用，其實是相同的，用法如下：

這就證明了我們的注解可以保留到Runtime運作階段，而我們在反射中大多數是定義到Runtime運作時階段的，因為我們需要從JVM中擷取class類對象并操作類對象。

6.4 @Documented

@Documented 指定了被修飾的注解是可以Javadoc等工具文檔化

@Documented注解是比較好了解的，它是一個标記注解。被該标記注解标記的注解，生成doc文檔時，注解是可以被加載到文檔中顯示的。

image-20200606152526551

還拿api中過時的Date中的方法來說，在api中顯示Date中的getYear方法是這樣的。

正如你看到的，注解在api中顯示了出來，證明該注解是@Documented注解修飾并文檔化的。那我們就看看這個注解是否被@Documented修飾吧。

然後，我們發現該注解的确是被文檔化了。是以在api中才會顯示該注解的。如果不信，你可以自己使用javadoc指令來生成一下doc文檔，看看被該注解修飾的注解是否存在。

至于Javadoc文檔生成，我在javadoc文檔生成一文中有過詳細記載，大家可以進行參考，生成doc文檔檢視。

6.5 @Inherited

@Inherited 指定了被修飾的注解修飾程式元素的時候是可以被子類繼承的

首先進入到源碼中，我們也可以清楚的知道，該注解也是一個标記注解。而且它也是被文檔化的注解。

其次，我們去在自定義注解中，标注上@Inherited注解。

示範@Inherited注解，我需要建立兩個類，同時兩個類中有一層的繼承關系。如下：

我們在Person類中标記了@MyAnno注解，由于該注解被@Inherited注解修飾，我們就可以得出繼承于Person類的Student類也同樣被@MyAnno注解标記了，如果你要擷取該注解的值的話，肯定擷取的也是父類上注解值的那個"1"。

七、使用反射機制解析注解

自定義注解

/**

 * @InterfaceName Sign

 * @Description 描述需要執行的類名和方法名

 * @Author Ziph

 * @Date 2020/6/6

 * @Since 1.8

 */

public @interface Sign {

    String methodName();

    String className();

Cat

 * @ClassName Cat

 * @Description 描述一隻貓的類

public class Cat {

    /*

     * @Description 描述一隻貓吃魚的方法 

     * @Author Ziph

     * @Date 2020/6/6

     * @Param []

     * @return void

     */

    public void eat() {

        System.out.println("貓吃魚");

準備好，上述代碼後，我們就可以開始編寫使用反射技術來解析注解的測試類。如下：

首先，我們先通過反射來擷取注解中的methodName和className參數。

import com.mylifes1110.anno.Sign;

 * @ClassName SignTest

 * @Description 要求建立cat對象并執行其類中eat方法

@Sign(className = "com.mylifes1110.java.Cat", methodName = "eat")

public class SignTest {

        //擷取該類的類對象

        Class signTestClass = SignTest.class;

        //擷取類對象中的注解對象

        //原理實際上是在記憶體中生成了一個注解接口的子類實作對象

        Sign sign = signTestClass.getAnnotation(Sign.class);

        //調用注解對象中定義的抽象方法（注解中的屬性）來擷取傳回值

        String className = sign.className();

        String methodName = sign.methodName();

        System.out.println(className);

        System.out.println(methodName);

此時的列印結果證明我們已經成功擷取到了該注解的兩個參數。

image-20200606162810165

注意： 擷取類對象中的注解對象時，其原理實際上是在記憶體中生成了一個注解接口的子類實作對象并傳回的字元串内容。如下：

public class SignImpl implements Sign {

    public String methodName() {

        return "eat";

    public String className() {

        return "com.mylifes1110.java.Cat";

繼續編寫我們後面的代碼，代碼完整版如下：

完整版代碼

import java.lang.reflect.InvocationTargetException;

import java.lang.reflect.Method;

    public static void main(String[] args) throws ClassNotFoundException, IllegalAccessException, InstantiationException, NoSuchMethodException, InvocationTargetException {

        //擷取className名稱的類對象

        Class<?> clazz = Class.forName(className);

        //建立對象

        Object o = clazz.newInstance();

        //擷取methodName名稱的方法對象

        Method method = clazz.getMethod(methodName);

        //執行該方法

        method.invoke(o);

執行結果

執行後成功的調用了eat方法，并列印了貓吃魚的結果，如下：

八、自定義注解改變JDBC工具類

首先，我們在使用JDBC的時候是需要通過properties檔案來擷取配置JDBC的配置資訊的，這次我們通過自定義注解來擷取配置資訊。其實使用注解并沒有用配置檔案好，但是我們需要了解這是怎麼做的，擷取方法也是魚使用反射機制解析注解，所謂“萬變不離其宗”，它就是這樣的。

package com.mylifes1110.java.anno;

 * @InterfaceName DBInfo

 * @Description 給予注解聲明周期為運作時并限定注解隻能用在類上

public @interface DBInfo {

    String driver() default "com.mysql.jdbc.Driver";

    String url() default "jdbc:mysql://localhost:3306/temp?useUnicode=true&characterEncoding=utf8";

    String username() default "root";

    String password() default "123456";

資料庫連接配接工具類

為了代碼的健全我也在裡面加了properties檔案擷取連接配接的方式。

package com.mylifes1110.java.utils;

import com.mylifes1110.java.anno.DBInfo;

import java.io.IOException;

import java.io.InputStream;

import java.sql.*;

import java.util.Properties;

 * @ClassName DBUtils

 * @Description 資料庫連接配接工具類

@DBInfo()

public class DBUtils {

    private static final Properties PROPERTIES = new Properties();

    private static String driver;

    private static String url;

    private static String username;

    private static String password;

    static {

        Class dbUtilsClass = DBUtils.class;

        boolean annotationPresent = dbUtilsClass.isAnnotationPresent(DBInfo.class);

        if (annotationPresent) {

            /**

             * DBUilts類上有DBInfo注解，并擷取該注解

             */

            DBInfo dbInfo = dbUtilsClass.getAnnotation(DBInfo.class);

//            System.out.println(dbInfo);

            driver = dbInfo.driver();

            url = dbInfo.url();

            username = dbInfo.username();

            password = dbInfo.password();

        } else {

            InputStream inputStream = DBUtils.class.getResourceAsStream("db.properties");

            try {

                PROPERTIES.load(inputStream);

            } catch (IOException e) {

                e.printStackTrace();

            }

        try {

            Class.forName(driver);

        } catch (ClassNotFoundException e) {

            e.printStackTrace();

    public static Connection getConnection() {

            return DriverManager.getConnection(url, username, password);

        } catch (SQLException throwables) {

            throwables.printStackTrace();

        return null;

    public static void closeAll(Connection connection, Statement statement, ResultSet resultSet) {

            if (resultSet != null) {

                resultSet.close();

                resultSet = null;

            if (statement != null) {

                statement.close();

                statement = null;

            if (connection != null) {

                connection.close();

                connection = null;

測試類

package com.mylifes1110.java.test;

import com.mylifes1110.java.utils.DBUtils;

import java.sql.Connection;

 * @ClassName GetConnectionDemo

 * @Description 測試連接配接是否可以擷取到

public class GetConnectionDemo {

        Connection connection = DBUtils.getConnection();

        System.out.println(connection);

測試結果

為了證明擷取的連接配接是由注解的配置資訊擷取到的連接配接，我将properties檔案中的所有配置資訊删除後測試的。

九、自定義@MyTest注解實作單元測試

我不清楚小夥伴們是否了解，Junit單元測試。@Test是單元測試的測試方法上方修飾的注解。此注解的核心原理也是由反射來實作的。如果有小夥伴不知道什麼是單元測試或者對自定義@MyTest注解實作單元測試感興趣的話，可以點進來看看哦！

所有知識體系文章，GitHub已收錄，歡迎Star！再次感謝，願你早日進入大廠！

GitHub位址： 

https://github.com/Ziphtracks/JavaLearningmanual

原文位址

https://www.cnblogs.com/ziph/p/13056092.html