4.8 注解与自定义注解

关注

原创 2024-01-30 10:40:05 172 阅读 AI 写同款· GEO 优化 ›

Java自定义注解开发指南 Java注解深度解析与应用指南摘要：本文系统剖析了Java注解的底层机制（基于JDK动态代理实现），详细讲解了自定义注解的四步开发流程（定义、设计、解析、使用），并提供了六大典型应用场景的实战案例，包括数据校验、ORM映射、权限控制等。文章特别强调了Java8+的类型注解与重复注解特性，同时给出性能优化建议（反射缓存、编译时处理）和设计原则（单一职责、明确生命周期）。通过完整的代码示例，开发者可快速掌握注解从基础到进阶的全面应用。阅读详情

1.概述

在注解刚出现时，曾受到过好多程序员的鄙夷，觉得这就是多此一举的操作；

但随着时间的推移，越来越的多觉得使用注解是一个无比轻松愉快的事情，它可以大大的提高开发效率；

注解很厉害，它可以增强我们的java代码，同时利用反射技术可以扩充实现很多功能。它们被广泛应用于三大框架底层。

传统我们通过xml文本文件声明方式(如下图,但是XML比较繁琐且不易检查)，而现在最主流的开发都是基于注解方式，代码量少，框架可以根据注解去自动生成很多代码，从而减少代码量，程序更易读。例如最火爆的SpringBoot就完全基于注解技术实现。
在这里插入图片描述

注解设计非常精巧，初学时觉得很另类甚至多余，甚至垃圾。有了java代码干嘛还要有@注解呢？但熟练之后你会赞叹，它竟然可以超越java代码的功能，让java代码瞬间变得强大。大家慢慢体会吧。

2.注解的分类

注解一共分为3大类,我们先来认识一下:

JDK自带注解
元注解
自定义注解

2.1 JDK注解

JDK注解的注解，就5个：

@Override :用来标识重写方法
@Deprecated标记就表明这个方法已经过时了，但我就要用，别提示我过期
@SuppressWarnings(“deprecation”) 忽略警告
@SafeVarargs jdk1.7出现，堆污染，不常用
@FunctionallInterface jdk1.8出现，配合函数式编程拉姆达表达式，不常用

2.2 元注解

用来描述注解的注解，就5个：

@Target 注解用在哪里：类上、方法上、属性上等等
@Retention 注解的生命周期：源文件中、字节码文件中、运行中
@Inherited 允许子注解继承
@Documented 生成javadoc时会包含注解，不常用
@Repeatable注解为可重复类型注解，可以在同一个地方多次使用，不常用

2.2.1 @Target ElementType…

描述注解存在的位置：

ElementType.TYPE：应用于类的元素
ElementType.METHOD：应用于方法级
ElementType.FIELD：应用于字段或属性(成员变量)
ElementType.ANNOTATION_TYPE：应用于注解类型
ElementType.CONSTRUCTOR：应用于构造函数
ElementType.LOCAL_VARIABLE：应用于局部变量
ElementType.PACKAGE：应用于包声明
ElementType.PARAMETER：应用于方法的参数

2.2.2 @Retention RetentionPolicy…

该注解定义了自定义注解被保留的时间长短,比如某些注解仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的注解可能会被虚拟机忽略，而另一些在class被装载时将被读取。
在这里插入图片描述
为何要分字节码文件中有还是没有呢？如果没有时，反射技术就拿不到，从而就无法去识别处理。它的值一共3种:

SOURCE: 在源文件中有效（即源文件保留）
CLASS: 在class文件中有效（即class保留）
RUNTIME: 在运行时有效（即运行时保留）

3 自定义注解

注意：注解的语法写法和常规java的语法写法不同

package partFour;

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

/*本类用于完成自定义注解*/

public class TestAnotation {
}
//2.通过@Target注解标记自定义注解的使用位置
/*3.通过元注解@Target规定自定义注解可以使用的位置
 *   我们使用"ElemetType.静态常量"的方式来指定自定义注解具体可以加在什么位置
 *   而且，值可以写多个，格式@Target({ElementType.xxx,ElementType.xxx})*/
@Target({ElementType.METHOD,ElementType.TYPE})
//3.通过@Retention注解标记自定义注解的生命周期
/*4.通过元注解@Retention规则自定义注解的生命周期
 *   我们使用"Retention.静态常量"的方式来指定自定义注解的生命周期
 *   注意：值只能写一个：SOURCE CLASS RUNTIME*/
@Retention(RetentionPolicy.RUNTIME)//到运行时都有效
//1.定义自定义注解
        /* 1.首先注意:注解定义的语法与java不同
         * 2.定义自定义注解的格式：@interface  注解名*/
@interface Rice{
    //5.我们可以给注解进行功能增强--添加注解的属性
    /*5.注意：int age();不是方法的定义，而是给自定义注解添加了一个age属性*/
    //int age();//给自定义注解添加一个普通属性age，类型是int
    int age() default 0;//给自定义注解的普通属性赋予默认值0
    /*6.注解中，还可以添加特殊属性value
     * 特殊属性的定义方式和普通属性一样，主要是使用方式不同
     * 注意：特殊属性的名字必须叫value，但是类型不做限制
     * 特殊属性也可以赋予默认值，格式与普通属性一样，不能简写*/
    //String value(); //定义一个特殊属性value，类型是String
    String value() default "lemon";//定义特殊属性并给特殊属性并赋值
}

//4.定义一个类用来测试自定义注解
//@Rice
class TesAnno{
    /*测试1：分别给TestAnno类 name属性 eat方法都添加Rice注解
     * 结论：属性上的注解报错了，说明自定义注解可以加在什么位置，由@Target决定*/
    //@Rice
    String name;
    /*测试2：当我们给Rice注解添加了一个age属性以后，@Rice注解使用时直接报错
     * 结论：当注解没有定义属性时，可以直接使用
     *      当注解定义了属性以后，必须给属性赋值，格式@Rice(age = 10)*/
    /*测试3：给age属性赋予默认值以后，可以直接使用@Rice注解
     * 不需要给age属性赋值，因为age属性已经有默认值0了*/
    /*测试4：给Rice注解添加了特殊属性value以后，必须给属性赋值
     *  只不过特殊属性赋值时可以简写成@Rice("apple")*/
    /*测试5：如果特殊属性也赋予了默认值，那么可以直接使用这个注解
     * 如果要给注解的所有属性赋值，每条赋值都不能简写*/
    @Rice(age = 10,value = "orange")
    //@Rice("apple")//特殊属性可以简写
    //@Rice(age = 10)//普通属性赋值形式
    //@Rice(10) //不能简写，普通属性没有这种格式
    public void eat(){
        System.out.println("干饭不积极，思想有问题");
    }
}