Java註解--一張圖一案例掌握自定義註解

来源:https://www.cnblogs.com/dennyLee2025/archive/2022/03/25/16056724.html
-Advertisement-
Play Games

1.概述 是什麼:是對方法、類、參數、包、域以及變數等進行代碼功能的增強或者修改程式的行為等操作。 應用 跟蹤代碼依賴性,實現替代配置文件功能在反射中使用Annotation,欄位格式化(如:數據欄位脫敏、日期格式)在編譯時進行格式檢查生成幫助文檔 2.註解相關知識 元註解指的是所有註解都基於它們而 ...


1.概述

是什麼:是對方法、類、參數、包、域以及變數等進行代碼功能的增強或者修改程式的行為等操作。

應用

  • 跟蹤代碼依賴性,實現替代配置文件功能
  • 在反射中使用Annotation,欄位格式化(如:數據欄位脫敏、日期格式)
  • 在編譯時進行格式檢查
  • 生成幫助文檔

2.註解相關知識

元註解指的是所有註解都基於它們而產生的最基礎的註解。

2.1.Annotation介面和元註解

這張圖包含了Annotation介面信息、4個元註解作用和元註解的參數信息

image

整體關係(具體信息都在圖中)

  • 頂級註解介面:Annotation

  • 元註解

    • @Documented
    • @Inherited
    • @Target
    • @Retention
  • native級別的關鍵字

    • @interface 指明是註解類

關聯關係

  • 1個Annotation 和 1個RetentionPolicy關聯。

    • 可以理解為:每1個Annotation對象,都會有唯一的RetentionPolicy屬性。
  • 1個Annotation 和 1~n個ElementType關聯。

    • 可以理解為:對於每1個Annotation對象,可以有若幹個ElementType屬性。

2.2.註解元素支持的數據類型

  • 所有基本類型
  • String
  • Class
  • enum
  • annotation
  • 以上類型的數組

2.3.常見基礎註解的作用

@SuppressWarnings:抑制編譯器警告的註解,編譯檢查註解

@Deprecated:棄用註解,編譯檢查註解

@Override:限定重寫父類方法的註解,具有編譯檢查作用

@FunctionalInterface:函數式介面註解,限制介面只能有一個抽象方法

3.自定義註解

返回值類型等於參數的類型,

方法的名稱等於參數的名稱(使用註解是參數名稱),

可以通過default關鍵字來聲明參數的預設值。

通過一個案例來理解註解的使用(不懂反射的可以看我的另一篇文章)

3.1.案例:通過反射處理自定義註解

自定義註解類:顏色註解類 + 顏色枚舉

@Target( ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ColorBanana {
    /**
     * 顏色枚舉類
     */
    public enum Color{
        YELLOW,
        BLACK,
        WHITE,
        RED
    }
    // 顏色屬性
    Color colorBanana() default Color.YELLOW;

}

實體類:使用註解的類

public class Banana {

    private String bananaName;
    @ColorBanana(colorBanana = ColorBanana.Color.RED)
    private String bananaColor;

    public String getBananaName() {
        return bananaName;
    }

    public void setBananaName(String bananaName) {
        this.bananaName = bananaName;
    }

    public String getBananaColor() {
        return bananaColor;
    }

    public void setBananaColor(String bananaColor) {
        this.bananaColor = bananaColor;
    }
    @Override
    public String toString() {
        return "Banana{" + "bananaName=" + bananaName + ", bananaColor=" + bananaColor + "}";
    }
}

測試類:反射處理註解

public class BananaTest {

    // 創建註解賦值後的Banana實例對象
    public static Banana newBanana() throws NoSuchMethodException, IllegalAccessException, InvocationTargetException, InstantiationException {
        Class<Banana> bananaClass = Banana.class;
        Banana banana = bananaClass.getConstructor().newInstance();
        /**
         * 獲取Banana類中 ColorBanana註解信息
         *   因為註解信息打在成員變數上,所以要通過Filed來get註解
         *   (註解打在什麼上,就用什麼來獲取註解)
         */
        Field[] fields = bananaClass.getDeclaredFields();//註解打在私有成員變數,所以要用getDeclaredFields
        for (Field field : fields){
            field.setAccessible(true);//忽略私有修飾符得限制,否則報語法錯誤
            // 拿到註解
            ColorBanana annotation = field.getAnnotation(ColorBanana.class);
            // 有些欄位沒有ColorBanana註解,記得判空
            if (annotation != null){
                ColorBanana.Color color = annotation.colorBanana();
                System.out.println("輸出註解中得信息:"+field.getName()+"="+color);
                /*
                 * 將註解中得信息賦值到對象對應欄位中
                 *   因為實體類Banana 的bananaColor欄位是字元串,所以要拿枚舉類屬性得name(名稱)進行賦值
                 */
                field.set(banana,color.name());
            }
        }
        // 輸出反射得到得對象信息
        System.out.println(banana);
        return banana;
    }

    public static void main(String[] args) throws Exception {
        Banana banana = newBanana();
        banana.setBananaName("myBananaName");
        System.out.println(banana);
    }
}

執行結果:

輸出註解中得信息:bananaColor=RED

Banana{bananaName=null, bananaColor=RED}

Banana{bananaName=myBananaName, bananaColor=RED}

註解值成功傳入到實例化對象中的對應欄位,並返回實例化對象給調用者。

image

Java往期文章

Java全棧學習路線、學習資源和麵試題一條龍

我心裡優秀架構師是怎樣的?

免費下載經典編程書籍

image

原創不易,三聯支持:點贊、在看、分享


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

-Advertisement-
Play Games
更多相關文章
  • 一、什麼講單例模式 單例模式,最簡單的理解是對象實例只有孤單的一份,不會重覆創建實例。 這個模式已經很經典了,經典得我不再贅述理論,只給簡單註釋,畢竟教科書詳盡太多。 解決 sonar RSPEC-2168 異味的時候,發現目前業界推薦的單例模式和教科書上的已經有了較大差異,雙重鎖定不再推薦,甚至業 ...
  • Keep It Simple, Stupid. 這是開發人耳熟能詳的 KISS 原則,也像是一句有調侃意味的善意提醒,提醒每個前端人,簡潔易懂的用戶體驗和刪繁就簡的搭建邏輯就是前端開發的至簡大道。 這也是袋鼠雲數棧前端開發團隊追求的目標。 數棧是一個專註一站式產品體系,覆蓋數據全鏈路開發流程,全面國 ...
  • 一,server 端的存儲模式為:Server 端 存 儲 模 式 (store-mode) 支 持 三 種 : file: ( 默 認 ) 單 機 模 式 , 全 局 事 務 會 話 信 息 內 存 中 讀 寫 並 持 久 化 本 地 文 件 root.data , 性 能 較 高 ( 默 認 ) ...
  • 一:遍歷 A:遍歷 方式1: public static void printArray(int[] arr) { for(int x=0; x<arr.length; x++) { System.out.println(arr[x]); } } 方式2: public static void pr ...
  • 文末源碼,閱讀大約2.8分鐘 傻瓜式教程 - 體驗滑塊,提供練習場景及源碼。 @ 環境安裝 安裝python需要的依賴包 cv2 安裝可以參考這裡:https://javapub.blog.csdn.net/article/details/123656345 安裝webdriver → chrome ...
  • HashSet集合存儲自定義對象並遍歷。如果對象的成員變數值相同即為同一個對象 * * 註意了: * 你使用的是HashSet集合,這個集合的底層是哈希表結構。 * 而哈希表結構底層依賴:hashCode()和equals()方法。 * 如果你認為對象的成員變數值相同即為同一個對象的話,你就應該在自 ...
  • 《零基礎學Java》 文本組件 文本組件在實際的項目開發中使用的最為廣泛,尤其是 文本框 與 密碼框 組件。 JTextField文本框組件 文本框(JTextField)是用來 顯示 或 編輯 一個單行文本,在 Swing 中通過 javax.swing.JTextField類 對象創建(該類繼承 ...
  • 圖論 圖論是數學的一個分支。它以圖為研究對象。圖論中的圖是由若幹給定的點及連接兩點的線所構成的圖形,這種圖形通常用來描述某些事物之間的某種特定關係,用點代表事物,用連接兩點的線表示相應兩個事物間具有這種關係。 樹 定義 樹是遞歸定義的。 一棵樹是由n(n>0)個元素組成的有限集合,其中每個元素稱為結 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...