Java 注解

Java注解

注解

前言：

框架等于：注解 + 反射 + 設(shè)計模式~

JDK 5.0 開始, Java 增加了對元數(shù)據(jù)的支持, 也就是 Annotation(注解) 安鬧太濕~

Annotation 其實就是代碼里的 特殊標記, 這些標記可以在編譯, 類加 載, 運行時被讀取, 并執(zhí)行相應(yīng)的處理

  • 通過：注解 + 反射

    反射掃描對應(yīng)類的注解，以及注解上面的參數(shù)，給類的添加一些通用的操作~

  • 開發(fā)者，可以：

    不改變原有邏輯的情況下, 在源文件中嵌入一些補充信息

    代碼分析工具、開發(fā)工具和部署工具：可以通過這些補充信息進行驗證或者進行部署。

Annotation 可以像修飾符一樣被使用：

  • 用于修飾包,類, 構(gòu)造器, 方 法, 成員變量, 參數(shù), 局部變量的聲明

為什么要引用注解：

使用【注解】之前：

  • xml 是被廣泛的應(yīng)用于描述元數(shù)據(jù)， 它以松耦合的方式完成了框架中幾乎所有的配置

    但是隨著項目越來越龐大： XML 的內(nèi)容也越來越復(fù)雜，一些應(yīng)用開發(fā)人員和架構(gòu)師發(fā)現(xiàn)維護成本變高。

  • 人門跟希望出現(xiàn)一些和代碼 緊耦合的方式~

    可以更加清晰的了解類的聲明~

  • 于是就有人提出來一種標記式高耦合的配置方式 注解:

    方法上可以進行注解，類上也可以注解，字段屬性上也可以注解，反正幾乎需要配置的地方都可以進行注解. 對象代碼進行聲明管理;

注解需要配合反射一起使用~

Java常見的 Annotation 實例：

@Override

  • 限定重寫父類方法, 該注解只能用于方法 屬于一種標記注解

  • //1. 定義一個接口
interface Info{
    void show();
}
//2. 創(chuàng)建一個類,實現(xiàn)接口 info 實現(xiàn)方法~
class Student implements Info{
    //一般工具都會自動加一個注解, 
    //    表示： 改方法是實現(xiàn)接口的重寫方法(); 當然不加也沒啥事情,只是一個程序提示~
    @Override
    public void show() {   }
}

@Deprecated

  • 用于表示所修飾的元素(類, 方法等)已過時，通常是因為 所修飾的結(jié)構(gòu)危險或存在更好的選擇

  • Date date = new Date(2000,9,9); 
//這段代碼并不會報錯：創(chuàng)建一個日期對象 2000-09-09 日期對象;
//    但 new Date(); 方法上會有一個 刪除線， 提示改方法以及淘汰~

//ctrl+右擊  查看源碼發(fā)現(xiàn),改方法被注解為已淘汰~
@Deprecated
public Date(int year, int month, int date) {
    this(year, month, date, 0, 0, 0);
}

  • 這樣聲明并不是表示，方法不能使用而是不建議 已經(jīng)有更好的方法了

    JDK是向下兼容的，不然每次更新一些老項目如果不符合就會出錯，就不好了~

  • 場景：

    如果你的項目中有一個，你寫的方法，突然一個大佬也寫了一個更好的，你又不想刪除曾經(jīng)的方法

    都是手敲的多少有點舍不得 可以使用該 注解 ，標記一下方法~ 已淘汰??

@SuppressWarnings

  • 抑制編譯器警告

  • 當我門定義對象，沒有被使用的時候, 編輯器會出現(xiàn) 警告 可以使用該注解， 屏蔽警告?

使用注解前面要加 @符號 當作一個修飾符使用，聲明在類 方法 屬性上！

自定義注解：

目前除了, JDK自帶的注解，很多的框架也提供了很多的注解：

  • Spring　JPA　Hibernate 很多框架都提供很多注解，實現(xiàn)基于注解開發(fā)~

  • 自定義注解，并不常見但可以了解...

    自定義注解必須配上注解的信息處理流程才有意義 如果沒有解析它的代碼，它可能連注釋都不如

實現(xiàn)：

  • 定義新的 Annotation 類型使用 @interface 關(guān)鍵字

  • 自定義注解自動繼承了：Java.lang.annotation.Annotation接口

  • Annotation 的成員變量

    以無參數(shù)方法的形式來聲明

    其：方法名和返回值 對應(yīng) 該成員的 ==名字==和==類型==

  • 類型只能是：

    八種基本數(shù)據(jù)，String，Class，enum，Annotation

MyAnnotation

Idea 工具創(chuàng)建 Annotation 注解類：

image-20211114164504530.png

MyAnnotation

/** 自定義注解1.0 */
@Retention(RetentionPolicy.RUNTIME)                 //一種元注解: 標識注解的執(zhí)行生命周期 (什么時候被執(zhí)行！)
public @interface MyAnnotation {

    //這是自定義注解中,屬性的聲明方式: 數(shù)據(jù)類型 參數(shù)名;
//    String value();

    //指定成員變量的初始值可使用 default 關(guān)鍵字
    String value() default "wsm";                   /** 如果只有一個參數(shù)成員，建議使用參數(shù)名為value */
}

TestAnnotation.Java

package com.wsm.anotation;
import java.lang.annotation.Annotation;
/** 步驟2 */
public class TestAnnotation {
    public static void main(String[] args) {
        //使用反射,來完成注解是實習(xí),這里只是簡單的輸出.
        //  很多時候反射,掃描所有的類,并判斷注解的參數(shù) 完善類添新的功能~
        Class clazz = Wsm.class;
        Annotation[] annotations = clazz.getAnnotations();      //獲取當前類的注解集合~
        for(int i = 0;i < annotations.length;i++){              //輸出注解集合的值！
            System.out.println(annotations[i]);
        }
    }
}

/** 步驟1 */
//@MyAnnotation                     //啥也不寫默認值~
//@MyAnnotation(value = "abc")      //手動填寫
@MyAnnotation("efg")              //如果注解的只有一個屬性且屬性名是 value: 可以省略不寫
class Wsm{
    //一個空的類,使用 自定義注解~
    @MyAnnotation
    public void show(){
        System.out.println("show方法()");
    }
}

  • ok，這就是一個最基本是 自定義注解的使用~

  • 別忘了自定義注解要加上 @Retention(RetentionPolicy.RUNTIME) 不然類加載時候，掃描不到;

    @Retention 是什么？

    @Retention是一種元注解

元注解Meta-Annotation：

什么是元注解：

Java5.0定義了4個標準的 Meta-Annotation類型 繼承了：Java.lang.annotation.Annotation接口

元注解的作用就是負責(zé)注解其他注解： 它們被用來提供對其它 注解類型作說明; 修飾注解的注解

JDK 中的元注解 4:

@Retention

  • 用于修飾一個 Annotation 定義， 用于指定該 Annotation 的生命 周期

    @Rentention 包含一個 RetentionPolicy 類型的成員變量enum類型 @Rentention 包含一個 RetentionPolicy 類型的成員變量

  • RetentionPolicy枚舉

    **RetentionPolicy.SOURCE**
- **注解只在源碼階段保留，在編譯器進行編譯時它將被丟棄忽視**

**RetentionPolicy.CLASS**
- **當運行Java 程序時, JVM不會保留注解，這是`默認值`**
- **實例：** `@Override、@Deprecated、@SuppressWarnning`

**RetentionPolicy.RUNTIME**
- **當運行 Java 程序時, JVM 會保留注釋，`程序可以通過反射獲取該注釋`**
- **實例：** `@Controller、@Autowired、@RequestMapping`
- `自定義注解,想要被掃描到,需要添加改注解 @Retention(RetentionPolicy.RUNTIME)`

@Target

  • 用于修飾 Annotation 定義, 指定被修飾的 Annotation 能用于 修飾哪些程序元素 默認值：為任何元素

    即：注解可以修飾的元素：類 屬性 泛型 enum枚舉 方法()...

  • JDK5.0

    顧名思義，這個元注解肯定是和文檔有關(guān)。它的作用是能夠?qū)⒆⒔庵械脑匕?Javadoc 中去ElementType.ANNOTATION_TYPE 可以給一個注解進行注解
ElementType.CONSTRUCTOR   可以給構(gòu)造方法進行注解
ElementType.FIELD             可以給屬性進行注解
ElementType.LOCAL_VARIABLE    可以給局部變量進行注解
ElementType.METHOD            可以給方法進行注解
ElementType.PACKAGE       可以給一個包進行注解
ElementType.PARAMETER         可以給一個方法內(nèi)的參數(shù)進行注解
ElementType.TYPE          可以給一個類型進行注解，比如類、接口、枚舉

  • JDK8.0顧名思義，這個元注解肯定是和文檔有關(guān)。它的作用是能夠?qū)⒆⒔庵械脑匕?Javadoc 中去

    ElementType.TYPE_PARAMETER    可以給一個泛型進行注解
ElementType.TYPE_USE      表示該注解能寫在使用類型的任何語句中 `聲明了改類型就不用在聲明其它方式了.`

@Documented

  • 顧名思義，這個元注解肯定是和文檔有關(guān)。它的作用是能夠?qū)⒆⒔庵械脑匕?Javadoc 中去
  • 定義為Documented的注解必須設(shè)置Retention值為RUNTIME

@Inherited

  • @Inherited 元注解是一個標記注解被標注的類型是被繼承的
  • A類 使用了帶有 @Inherited的注解，B類 繼承 A類，B也會擁有A的注解~

JDK8.0 新增元注解

@Repeatable

  • 可重復(fù)注解 有時候,需要注解在類上多次聲明使用可以使用改注解.

JDK8.0 可重復(fù)注解使用：

定義可重復(fù)的注解容器注解

MyAnnotations

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotations {
    MyAnnotation[] value();             //注解屬性,是可重復(fù)注解的數(shù)組~
}

MyAnnotation

import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
@Repeatable(MyAnnotations.class)           //1.8新增可重復(fù)注解,知道注解容器~
public @interface MyAnnotation {
    String value();                         //參數(shù)~
}

TestAnnotation.java

import java.lang.annotation.Annotation;

/** 步驟2 */
public class TestAnnotation {
    public static void main(String[] args) {
        //使用反射,來完成注解是實習(xí),這里只是簡單的輸出.
        //  很多時候反射,掃描所有的類,并判斷注解的參數(shù) 完善類添新的功能~
        Class clazz = Wsm.class;
        Annotation[] annotations = clazz.getAnnotations();      //獲取當前類的注解集合~
        for(int i = 0;i < annotations.length;i++){              //輸出注解集合的值！
            System.out.println(annotations[i]);
        }
    }
}

/** 步驟1 */
@MyAnnotation("abc")        //可重復(fù)注解,可以一次添加多個屬性！
@MyAnnotation("efg")
class Wsm{
    //一個空的類,使用 自定義注解~
    public void show(){
        System.out.println("show方法()");
    }
}

運行結(jié)果：

@com.wsm.annotation2.MyAnnotations(value[@com.wsm.annotation2.MyAnnotation(value=abc),@com.wsm.annotation2.MyAnnotation(value=efg)])

輸出了多個注解的 value

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容