Java註解入門

来源:https://www.cnblogs.com/onedayinMay/archive/2020/01/16/12203585.html
-Advertisement-
Play Games

自JDK1.5引入註解後,他就成為了Java編程語言重要的組成部分,在開發過程中,我們也時常用到@Override、@ToString等這樣的註解。在這篇文章中,將介紹什麼是註解、為什麼引用註解、它是如何工作的、如何編寫自定義註解、以及如何測試自定義註解。 一、什麼是註解? 用一個詞就可以描述註解, ...


  自JDK1.5引入註解後,他就成為了Java編程語言重要的組成部分,在開發過程中,我們也時常用到@Override、@ToString等這樣的註解。在這篇文章中,將介紹什麼是註解、為什麼引用註解、它是如何工作的、如何編寫自定義註解、以及如何測試自定義註解。   一、什麼是註解?   用一個詞就可以描述註解,那就是元數據,即一種描述數據的數據,可以理解為描述數據的一種標記。如以下代碼:
@Override
public void doSomething() {
    System.out.println("覆寫了父類doSomething()!)");
}
  總的來說,Annotation(註解)是一種應用於類、方法、參數、變數、構造器及包聲明中的特殊修飾符;Java註解是附加在代碼中的一些元信息,用於一些工具在編譯、運行時進行解析和使用,起到說明、配置的功能。註解不會也不能影響代碼的實際邏輯,僅僅起到輔助性的作用。包含在 java.lang.annotation 包中;它是一種由JSR-175標準選擇用來描述元數據的一種工具。   二、為什麼引入註解?   使用Annotation註解之前,XML被廣泛的應用於描述元數據。隨著項目的開發與維護,XML的表現越來越糟糕,此時,人們希望在一些場合使用緊耦合的方式進行代碼描述。當然,並不是說XML方式不好,兩者各有優勢: 假如你想為應用設置很多的常量或參數,這種情況下,XML是一個很好的選擇,因為它不會同特定的代碼相連;如果你想對代碼進行配置說明、編譯提示等時,那麼使用Annotation註解會更好一些。   註解的用處:   1、生成文檔。這是最常見的,也是java 最早提供的註解。常用的有@param @return 等   2、跟蹤代碼依賴性,實現替代配置文件功能。比如Dagger 2依賴註入,未來java開發,將大量註解配置,具有很大用處,比如現在的Springboot框架;   3、在編譯時進行格式檢查。如@override 放在方法前,如果你這個方法並不是覆蓋了超類方法,則編譯時就能檢查出。 開發時我們可以根據它的用處來權衡使用XML方式與使用Annotation註解的利弊來選擇是否使用Annotation註解。(參考:https://blog.csdn.net/PORSCHE_GT3RS/article/details/80304701 )   三、註解是如何工作的?   註解本質是一個繼承了Annotation的特殊介面,其具體實現類是Java運行時生成的動態代理類。而我們通過反射獲取註解時,返回的是Java運行時生成的動態代理對象$Proxy。通過代理對象調用自定義註解(介面)的方法,會最終調用AnnotationInvocationHandler的invoke方法。該方法會從memberValues這個Map中索引出對應的值。而memberValues的來源是Java常量池。 關於更詳細的瞭解可以參考這篇blog:https://blog.csdn.net/lylwo317/article/details/52163304。在這篇文章中詳細介紹瞭如何查看與獲取生產的代理對象的位元組碼文件,從而獲悉生產的代理對象的具體的代碼實現。   四、如何編寫自定義註解   編寫自定義的註解之前,首先得瞭解註解相關的基本概念——元註解。   元註解,專門註解其他的註解(在自定義註解的時候,需要使用到元註解),起到指定註解(自定義註解)的作用範圍、生命周期等作用。java.lang.annotation提供了四種元註解:     1)@Documented——註解是否將包含在JavaDoc中,一個簡單的Annotations標記註解,表示是否將註解信息添加在java文檔中     2)@Retention ——什麼時候使用該註解,定義該註解的生命周期     3)@Target? ——註解用於什麼地方。如果不明確指出,該註解可以放在任何地方。以下是一些可用的參數。需要說明的是:屬性的註解是相容的,如果你想給7個屬性都添加註解,僅僅排除一個屬性,那麼你需要在定義target包含所有的屬性。         ElementType.TYPE:用於描述類、介面或enum聲明         ElementType.FIELD:用於描述實例變數         ElementType.METHOD:用於描述實例方法         ElementType.PARAMETER:用於描述實例方法參數         ElementType.CONSTRUCTOR:用於描述實例的構造函數         ElementType.LOCAL_VARIABLE:用於描述局部變數         ElementType.ANNOTATION_TYPE 另一個註釋         ElementType.PACKAGE 用於記錄java文件的package信息     4)@Inherited —— 是否允許子類繼承該註解   但是從JDK1.8開始,又新增加了兩個元註解:     @Native——指示可從本機代碼引用定義常量值的欄位。     @Repeatable——用於指示其聲明(元)註釋的註釋類型是可重覆的。     下麵我們開始編寫自定義註解。語法如下,使用@interface來表明聲明的是一個註解
public @interface 註解名稱 {
    //String weather() default "";//註解中可以沒有屬性,並且在註解中屬性是以方法的形式存在
}
  但是,編寫註解的時候僅僅做到如上代碼的樣子還遠遠不夠,通常,還需要為他們指定註解的作用範圍、生命周期等,這時候就需要用到元註解對我們定義的註解進行註解(標識說明)了。
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface WeatherAnnotation {
    String weather() default "";
}

  以上註解通過ElementType.FIELD限制了該註解只能標識屬性,通過RetentionPolicy.RUNTIME指定了註解的生命周期——代碼運行時生效,自定義註解基本上都是使用該枚舉欄位聲明其生命周期。接下來,開始編寫測試註解的代碼:

package com.wyfx.nio.annotation;
 
public class Today {
    @WeatherAnnotation(weather="hello,今天是晴天")
    private String dayWeather;
 
    public String getDayWeather() {
        return dayWeather;
    }
 
    public void setDayWeather(String dayWeather) {
        this.dayWeather = dayWeather;
    }
 
    @Override
    public String toString() {
        return "Today{" +
                "dayWeather='" + dayWeather + '\'' +
                '}';
    }
}
import java.lang.reflect.Field;

public class Test {
    public static void main(String[] args){
        /*Annotation annotations=new Today().getClass().getAnnotation(WeatherAnnotation.class);*/
        try {
            Class aClass=Class.forName("com.wyfx.nio.annotation.Today");
            Field[] fields= aClass.getDeclaredFields();
            String weather="";
            for (Field field : fields) {
                if(field.isAnnotationPresent(WeatherAnnotation.class)){
                    WeatherAnnotation weatherAnnotation=field.getAnnotation(WeatherAnnotation.class);
                    weather= weatherAnnotation.weather();
                }
            }
            System.out.println("--annotation---:"+weather);
        }catch (Exception e){
            e.printStackTrace();
        }
    }
}

  以上代碼順利列印出“hello,今天是晴天”,說明自定義註解成功了,值得註意的是,註解的作用域是屬性,所以在通過反射進行測試的時候,必須在Field的基礎上去判斷是否是Annotation介面的子類(field.isAnnotationPresent(),然後獲取註解子類對象。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 定義 在一個分散式系統(指系統中的節點互相連接並共用數據)中,當涉及讀寫操作時,只能保證一致性 (Consistency)、可用性 (Availability)、分區容錯性 (Partition Tolerance)三者中的兩個,另外一個必須被犧牲。 一致性:CAP中的C和ACID 中的C不是一個含 ...
  • 既要低頭趕路,又要抬頭望天,科技是為人服務的,任何技術背後都有更深層次的考量,在本系列的第一篇文章中我們聊了微服務的本質,它是一種可以加速分工、促進合作的新協作機制。知其然,知其所以然,在第二篇文章中我們剖析了微服務為什麼可以加速分工、促進合作,今天我們再接著來聊聊怎樣開啟微服務架構之旅。 ...
  • 二進位 0000 0000 0000 0000 0000 0000 0000 0001 // 2^0 0000 0000 0000 0000 0000 0000 0000 0010 // 2^1 0000 0000 0000 0000 0000 0000 0000 0100 // 2^2 0000 ...
  • 消息中間件 消息的可靠性傳遞 前言 消息中間件的可靠性消息傳遞,是消息中間件領域非常重要的方案落實問題(在這之前的MQ理論,MQ選型是抽象層次更高的問題,這裡不談)。 並且這個問題與日常開發是存在較大的關聯的。可以這麼說,凡是使用了MQ的,機會都要考慮這個問題。當然也有一些原始數據採集,日誌數據收集 ...
  • 一、訪問網路的兩種方法 1.get:利用參數給伺服器傳遞信息;參數為dict,然後parse解碼 2.post:一般向伺服器傳遞參數使用;post是把信息自動加密處理;如果想要使用post信息,需要使用到data參數 3.Content-Type:application/x-www.form-url ...
  • 前面我們在章節“Socket通訊探索(一)”中如何實現一個tcp連接,但是這僅僅是一個最初級的BIO實現,且沒有添加線程池,實際應用中很少採用這種方式,因為不得不考慮當大量的Tcp連接建立的時候,服務端如何安全穩定的運行?為什麼呢? 1、BIO實現方式,是阻塞式的(上一節最後面的實現方式雖然無數據的 ...
  • 引言 問題 現在我們使用通用的應用程式或庫來相互通信。例如,我們經常使用HTTP客戶機從web伺服器檢索信息,並通過web服務調用遠程過程調用。然而,通用協議或其實現有時不能很好地進行擴展。這就像我們不使用通用HTTP伺服器來交換巨大的文件、電子郵件消息和近乎實時的消息(如財務信息和多人游戲數據)一 ...
  • 一、什麼是socket? 當兩台電腦需要通信的時候,往往我們使用的都是TCP去實現的,但是並不會直接去操作TCP協議,通常是通過Socket進行tcp通信。Socket是操作系統提供給開發者的一個介面,通過它,就可以實現設備之間的通信。 二、TCP是如何通信的? TCP連接和斷開分別會存在3次握手 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...