注解简单介绍

1注解的分类

  1. JDK注解
  2. 元注解
  3. 自定义注解

1.1JDK注解

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

1.2 元注解

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

@Target 注解

用来指定一个注解的使用范围,即被 @Target 修饰的注解可以用在什么地方。@Target 注解有一个成员变量(value)用来设置适用目标,value 是 java.lang.annotation.ElementType 枚举类型的数组,下表为 ElementType 常用的枚举常量。

名称说明
CONSTRUCTOR用于构造方法
FIELD用于成员变量(包括枚举常量)
LOCAL_VARIABLE用于局部变量
METHOD用于方法
PACKAGE用于包
PARAMETER用于类型参数
TYPE用于类、接口(包括注解类型)或 enum 声明

@Retention

@Retention 用于描述注解的生命周期,也就是该注解被保留的时间长短。@Retention 注解中的成员变量(value)用来设置保留策略,value 是 java.lang.annotation.RetentionPolicy 枚举类型,RetentionPolicy 有 3 个枚举常量,如下所示。

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

生命周期大小排序为 SOURCE < CLASS < RUNTIME,前者能使用的地方后者一定也能使用。如果需要在运行时去动态获取注解信息,那只能用 RUNTIME 注解;如果要在编译时进行一些预处理操作,比如生成一些辅助代码(如 ButterKnife),就用 CLASS 注解;如果只是做一些检查性的操作,比如 @Override 和 @SuppressWarnings,则可选用 SOURCE 注解。

1.3自定义注解

声明自定义注解使用 @interface 关键字(interface 关键字前加 @ 符号)实现。定义注解与定义接口非常像,如下代码可定义一个简单形式的注解类型。

  // 定义一个简单的注解类型
    public @interface Test {
    }

上述代码声明了一个 Test 注解。默认情况下,注解可以在程序的任何地方使用,通常用于修饰类、接口、方法和变量等。

定义注解和定义类相似,注解前面的访问修饰符和类一样有两种,分别是公有访问权限(public)和默认访问权限(默认不写)。一个源程序文件中可以声明多个注解,但只能有一个是公有访问权限的注解。且源程序文件命名和公有访问权限的注解名一致。

不包含任何成员变量的注解称为标记注解,例如上面声明的 Test 注解以及基本注解中的 @Override 注解都属于标记注解。根据需要,注解中可以定义成员变量,成员变量以无形参的方法形式来声明,其方法名和返回值定义了该成员变量的名字和类型。代码如下所示:

 public @interface MyTag {
        // 定义带两个成员变量的注解
        // 注解中的成员变量以方法的形式来定义
        String name();
        int age();
    }

以上代码中声明了一个 MyTag 注解,定义了两个成员变量,分别是 name 和 age。成员变量也可以有访问权限修饰符,但是只能有公有权限和默认权限。

如果在注解里定义了成员变量,那么使用该注解时就应该为它的成员变量指定值,如下代码所示。

 public class Test {
        // 使用带成员变量的注解时,需要为成员变量赋值
        @MyTag(name="java小鲤鱼", age=20)
        public void info() {
        }
    }

注解中的成员变量也可以有默认值,可使用 default 关键字。如下代码定义了 @MyTag 注解,该注解里包含了 name 和 age 两个成员变量。

  public @interface MyTag {
        // 定义了两个成员变量的注解
        // 使用default为两个成员变量指定初始值
        String name() default "java小鲤鱼";
        int age() default 10;
    }

如果为注解的成员变量指定了默认值,那么使用该注解时就可以不为这些成员变量赋值,而是直接使用默认值。

public class Test {
    // 使用带成员变量的注解
    // MyTag注释的成员变量有默认值,所以可以不为它的成员变量赋值
    @MyTag
    public void info() {
    }
}

当然也可以在使用 MyTag 注解时为成员变量指定值,如果为 MyTag 的成员变量指定了值,则默认值不会起作用。

根据注解是否包含成员变量,可以分为如下两类。

  1. 标记注解:没有定义成员变量的注解类型被称为标记注解。这种注解仅利用自身的存在与否来提供信息,如前面介绍的 @Override、@Test 等都是标记注解。
  2. 元数据注解:包含成员变量的注解,因为它们可以接受更多的元数据,所以也被称为元数据注解。

1.3.1 自定义注解练习

package cn.tedu.annotation;

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

/*本类用于注解的学习*/
public class TestAnnotation {
}

//2.通过@Target注解标记自定义注解可以使用的位置
@Target({ElementType.METHOD, ElementType.TYPE})//用于方法和类
/*3.通过@Target元注解规定自定义注解可以使用的位置
 * 我们使用"ElementType.静态常量"的方式来指定自定义注解具体可以加到什么位置
 * 而且,这里的值可以写多个,格式:@Target({ElementType.XX1,ElementType.XX2})
 * */
//3.通过@Retention注解标记自定义注解的生命周期
@Retention(RetentionPolicy.RUNTIME)
//到运行时都有效
        /*4.我们通过@Retention元注解规定自定义注解的生命周期
         * 我们使用"RetentionPolicy.静态常量"的方式来指定自定义注解具体的生命周期
         * 注意:这个值只能写一个:SOURCE CLASS RUNTIMR 3选一
         * */
//1.定义自定义注解
        /*1.首先注意:注解定义的语法与java不同
         * 2.定义自定义注解的格式:@interface 注解名
         * */
@interface Rice {
    //5.我们可以给注解进行功能增强---添加注解的属性
    /*5.注意:int age();不是方法的定义,二十年我们给自定义注解添加了一个age属性*/
    //int age();//给Rice注解添加了一个普通的int类型的age属性
    int age() default 0;//给普通属性age赋默认值0
    //6.给自定义注解添加特殊属性value
    /*自定义注解中还可以添加特殊属性value
    * 特殊属性的定义方式与赋予默认值时的方式和普通属性一样
    * 但要注意:特殊属性的名字必须是value,类型不做限制
    * */
    //String value();//定义一个特殊属性value,类型是String
    String value() default "lemon";
}
//@Rice
@SuppressWarnings("all")
class TestAnno{
    /*测试1:分别给TestAnno类/name属性/eat方法添加Rice注解
    * 结论:属性上的注解报错了,说明自定义注解可以加在什么位置,由@Target决定
    * */
    //@Rice
    String name;
    /*测试2:当我们给Rice注解添加了一个age属性后。@Rice注解使用时直接报错
    *  结论:当注解没有定义属性时,可以直接使用
    *       当注解定义了属性以后,必须给属性赋值,格式:@Rice(age=10)
    * 测试3:给age属性赋予默认值以后,就可以直接使用Rice注解了
    *      不需要给age属性赋值,此时属性的值就是默认值0
    * 测试4;给Rice注解添加了特殊属性value以后,必须给属性赋值
    *      只不过特殊属性赋值是可以简写成:@Rice("Apple")
    * 测试5:如果特殊属性也赋予了默认值,那么可以不赋值直接使用注解
    *      但是如果想要给注解的所有属性赋值,每条赋值语句包括特殊属性,都不可以简写
    *  */
    //@Rice(age = 10)
    //@Rice("Apple")
    //@Rice//不报错,因为我们定义了两个属性,但两个属性都有默认值
    @Rice(age = 10,value = "beach") 
    public void rat(){
        System.out.println("一会又能干饭啦~");
    }
}
  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

java小鲤鱼

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值