Java注解的简单介绍及使用

蔚落 2024-04-18 14:23 65阅读 0赞

## Java注解的定义及使用 ##

### 1.什么是注解 ###

> 百度百科给出的一个解释：**注解是一个汉语词汇，读音为zhù jiě，意思是用文字来解释字句；泛指解释；解释字句的文字；神鬼名。民间传说指阴司第一阎王殿中职掌解送鬼魂并令其注册者。**

而在Java中，注解同样具有解释的功能。但是它主要的作用是用来做一些配置信息，像spring框架中，如果要配置一个bean有两种方式，xml配置文件和注解的方式：

// 注解配置的方式，需要启用扫描包的组件
    @Component("demo") 
    public class Demo {
        // class的内容}

<bean id="demo" class="packageName.Demo"></bean>

注解存在的意义就是为了替代xml配置文件，像在springboot中是没有xml配置文件存在的。

### 2.项目中的注解 ###

*  **定义注解**：框架的工作
 *  **使用注解**：我们的工作
 *  **读取注解**：框架的工作

### 3.定义一个简单的注解 ###

所有的注解都是Annotation的子类，就像所有的类都是Object的子类一样。  
**简单的声明一个注解（无实际意义）：** 这里不详细讲述注解的属性，后面会提到。

public @interface MyAnno{
        }

### 4.使用注解 ###

*  **注解的作用目标**：类、方法、构造器、属性、方法形参、局部变量、包  
    注解的作用目标即为注解可以出现的位置。
 *  ***关于注解在包上的使用：*** 也没有过应用场景，只是测试了一下。如果想给包添加一个注解，需要创建一个文件：package-info.java

// package-info.java
    @MyAnno packageName;

***反射获取包上的注解*** ：

Package p = Package.getPackage(packageName);
    MyAn ma = p.getAnnotation(MyAnno.class);

### 5.注解的属性 ###

*  **如果java注解中不存在属性，或者说我们不需要用到属性，那么在注解的后面不需要()：**

@MyAnno
    public class Demo {
        }

*  **使用注解时给属性赋值：**

@MyAnno(name="xxx", age=111) // 这里我们假设MyAnno有这两个属性

*  **名为value的属性的特权：** 在使用注解时，如果只需要给value属性赋值，那么可以不写属性名，直接给出值即可。

### 6.注解属性支持的类型 ###

*  八种基本数据类型
 *  String
 *  enum
 *  Class
 *  其他的注解
 *  以上类型的数组类型  
    **数组类型** ：当给数组类型的属性赋值的时候，若元素的数量为1，可以省去\{\}。

### 7.注解的作用目标限定和保留策略限定 ###

*  **作用目标限定：** 举个例子，让一个注解只能作用在类上，这就是作用目标限定。

在定义我们的注解的时候，在注解上添加一个注解 **@Target**。需要给出一个value属性值，它的类型是**ElementType**（枚举）的数组类型。那么它的取值范围就是ElementType所有的枚举值：

public enum ElementType {
        
        /** Class, interface (including annotation type), or enum declaration */
        /** 作用在类上，接口（包括注解）上，或者枚举上 */
        TYPE,
        /** Field declaration (includes enum constants) */
        /** 字段即成员变量 */
        FIELD,
        /** Method declaration */
        /** 方法 */
        METHOD,
        /** Formal parameter declaration */
        /** 普通参数 */
        PARAMETER,
        /** Constructor declaration */
        /** 构造方法 */
        CONSTRUCTOR,
        /** Local variable declaration */
        /** 局部变量 */
        LOCAL_VARIABLE,
        /** Annotation type declaration */
        /** 注解 */
        ANNOTATION_TYPE,
        /** Package declaration */
        /** 包 */
        PACKAGE,
        /**
         * Type parameter declaration
         * 新的注解，字面意思类型参数
         * @since 1.8
         */
        TYPE_PARAMETER,
        /**
         * Use of a type
         * 新的注解，类型用途
         * @since 1.8
         */
        TYPE_USE
    }

*  **保留策略限定**  
    注解有三种保留策略  
    1）源代码文件（source）：注解只在源代码中存在，编译时就消失了。  
    2）字节码文件（class）：注解在源代码和编译后的class文件中存在，但是JVM加载类时会忽略注解。  
    3）jvm中（runtime）：注解在源代码和class文件中存在，并且jvm加载类时会将注解加载到内存中，它是唯一可以反射的注解。

**那么，如何限定注解的保留策略呢？使用一个注解 @Retention,它有一个枚举类型的属性RetentionPolicy,通过它提供的枚举值限定注解的保留策略:**

public enum RetentionPolicy {
        
     
       SOURCE,
       CLASS,
       UNTIME
    }
    
    // 举个例子，自定义一个注解
    @Retention(RetentionPolicy.RUNTIME) // 可以存在于jvm内存中，可以通过反射得到
    @Target(ElementType.FIELD) // 作用目标为成员变量
    public @interface AnnotationDemo {
        }

**以上就是对注解的简单介绍。**