詳解java注解相關(guān)知識(shí)

更新時(shí)間：2021年06月25日 11:50:02 作者：紅旗下的小兵

今天給大家?guī)?lái)的是關(guān)于Java的相關(guān)知識(shí),文章圍繞著java注解的使用展開(kāi),文中有非常詳細(xì)的介紹及代碼示例,需要的朋友可以參考下

定義

1、如果注解中有屬性，那么必須給屬性賦值。

package com.lxc.Test;
 
// 定義一個(gè)注解
public @interface Annotation {
    String name(); // 看似name像一個(gè)方法，實(shí)際上我們把name稱(chēng)為屬性
}

使用上邊注解：

package com.lxc.Test;
 
public class Test {
    @Annotation(name="lxc")
    public void test() {
    }
}

2、如果注解中有屬性，且沒(méi)有定義默認(rèn)值，那么在使用注解的時(shí)候，必須給屬性賦值。

public @interface Annotation {
    String name();
    int age();
}

public class Test {
    @Annotation(name="lxc", age=20)
    public void test() {
    }
}

但是注解中如果有默認(rèn)值，在使用注解時(shí)，可以不給屬性賦值

public class Test {
    @Annotation(name="lxc")
    public void test() {
    }
}

public @interface Annotation {
    String name();
    String password() default "123";
}

3、value() 屬性

如果注解中的一個(gè)屬性名是value，且有且只有一個(gè)value()，在使用注解的時(shí)候，屬性名可以省略

public class Test {
    @Annotation("lxc")
    public void test() {
    }
}

public @interface Annotation {
    String value();
    String password() default "123";
}

注解中屬性的類(lèi)型有哪些

byte、short、int、float、double、boolean、char、String、Class、枚舉

數(shù)組：

如果數(shù)組屬性中有一個(gè)元素，那么數(shù)組的大括號(hào)可以省略：

public @interface Annotation {
    String[] name();
}

public class Test {
    // @Annotation(name={"lxc"}) // 寫(xiě)法一
    @Annotation(name="lxc") // 寫(xiě)法二
    public void test() {
    }
}

枚舉：

public enum MyEnum {
    className, name, age,
}

public @interface Annotation {
    String[] name();
    MyEnum[] student();
}

public class Test {
    @Annotation(name="lxc", student = {MyEnum.className, MyEnum.age})
    public void test() {
    }
}

注解如何使用：

（1）標(biāo)記一個(gè)注解只能出現(xiàn)在類(lèi)或者方法上

@Target(value = {ElementType.TYPE, ElementType.METHOD})
public @interface Annotation {
    String userName();
    MyEnum[] student();
}

（2）標(biāo)記一個(gè)注解可以被反射機(jī)制所讀取

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
// 標(biāo)記注解只能出現(xiàn)在類(lèi)上
@Target(value = {ElementType.TYPE, ElementType.METHOD})
// 標(biāo)記注解可以被反射機(jī)制所讀取
@Retention(RetentionPolicy.RUNTIME)
public @interface Annotation {
    String userName();
    MyEnum[] student();
}

獲取注解中的屬性值

通過(guò)反射機(jī)制來(lái)獲取。

（1）獲取類(lèi)上邊注解的屬性：

注解類(lèi)：

package com.lxc.Test;
 
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
// 標(biāo)記注解只能出現(xiàn)在類(lèi)上
@Target(value = {ElementType.TYPE, ElementType.METHOD})
// 標(biāo)記注解可以被反射機(jī)制所讀取
@Retention(RetentionPolicy.RUNTIME)
public @interface Annotation {
    String userName() default "呂星辰";
}

使用注解類(lèi)：

// myAnnotation 
@Annotation(userName = "哈哈")
public class myAnnotation {
}

獲取注解類(lèi)中的屬性：

package com.lxc.Test;
/**
 * c.isAnnotationPresent(注解類(lèi).class) : 判斷一個(gè)類(lèi)上是否有注解,返回true、false
 * c.getAnnotation(注解類(lèi).class) : 獲取注解類(lèi)的實(shí)例
 *
 */
public class Test {
    public static void main(String[] args) throws Exception{
        Class c = Class.forName("com.lxc.Test.myAnnotation");
        System.out.println(c.isAnnotationPresent(Annotation.class));
        // 判斷一個(gè)類(lèi)是否有：Annotation這個(gè)注解
        if(c.isAnnotationPresent(Annotation.class)) {
            // 獲取注解對(duì)象
            Annotation ann = (Annotation) c.getAnnotation(Annotation.class);
            // 通過(guò)注解對(duì)象獲取屬性值
            System.out.println(ann.userName());
        }
    }
}

（2）獲取類(lèi)中方法上邊注解的屬性：

注解類(lèi)：

package com.lxc.Test;
 
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
// 標(biāo)記注解只能出現(xiàn)在類(lèi)上
@Target(value = {ElementType.TYPE, ElementType.METHOD})
// 標(biāo)記注解可以被反射機(jī)制所讀取
@Retention(RetentionPolicy.RUNTIME)
public @interface Annotation {
    String userName();
    String password();
}

在方法上使用注解及獲取方法上邊的注解：
分析：想獲取方法上的注解，首先需要獲取該方法，獲取該方法的前提，獲取該方法的類(lèi)：

package com.lxc.Test;
 
import java.lang.reflect.Method;
 
public class UserAnnotation {
    @Annotation(userName = "lxc", password = "123")
    public void getUser() {}
 
    public static void main(String[] args) throws Exception{
        // 通過(guò)反射獲取類(lèi)
        Class c = Class.forName("com.lxc.Test.UserAnnotation");
        // 通過(guò)反射獲取類(lèi)中的方法
        Method getUserMethod = c.getDeclaredMethod("getUser");
        // 判斷方法是否有 Annotation 這個(gè)注解
        if(getUserMethod.isAnnotationPresent(Annotation.class)) {
            Annotation ann = getUserMethod.getAnnotation(Annotation.class);
            System.out.println(ann.userName()); // lxc
            System.out.println(ann.password()); // 123
        }
    }
}