java注解---Annotation

Java 注解用于为 Java 代码提供元数据。作为元数据,注解不直接影响你的代码执行,但也有一些类型的注解实际上可以用于这一目的。Java 注解是从 Java5 开始添加到 Java 的。

在其他博主的文章中我看到有个博主将注解类比为墨水,墨水可以挥发,可以有不同的颜色,用来解释注解正好。

但博主思绪飞快,又将墨水提升到印章。印章可以沾上不同的墨水或者印泥,可以定制印章 的文字或者图案,如果愿意它也可以被戳到你任何想戳的物体表面。

但是牛逼的是博主继续发散思维,又将印泥提升到标签,标签是一张便利纸,标签上的内容可以自由定义,常见的货架上的商品价格标签,图书馆的书本编码标签,实验室中化学材料的名称类别标签等等

往抽象地说,标签并不一定是一张纸,它可以是人和事物的属性评价。也就是可以这样理解,标签具备对于抽象事物的解释

感觉博主是真厉害,可以想到用标签来解释注解

我们可以抽象概括一下,标签是对事物行为的某些角度的评价与解释。

初学者可以这样理解注解:想像代码具有生命,注解就是对于代码中某些鲜活个体的贴上去的一张标签。简化来讲,注解如同一张标签。

注解语法

因为平常开发少见,相信有不少的人员会认为注解的地位不高。其实同 classs 和 interface 一样,注解也属于一种类型。它是在 Java SE 5.0 版本中开始引入的概念。

注解的定义

注解通过 @interface 关键字进行定义。

public @interface TestAnnotation {
}
  • 1

它的形式跟接口很类似,不过前面多了一个 @ 符号。上面的代码就创建了一个名字为 TestAnnotaion 的注解。

你可以简单理解为创建了一张名字为 TestAnnotation 的标签。

注解的应用

上面创建了一个注解,那么注解的的使用方法是什么呢。

@TestAnnotation
public class Test {
}

创建一个类 Test,然后在类定义的地方加上 @TestAnnotation 就可以用 TestAnnotation 注解这个类了。

你可以简单理解为将 TestAnnotation 这张标签贴到 Test 这个类上面。

不过,要想注解能够正常工作,还需要介绍一下一个新的概念那就是元注解。

元注解

元注解是什么意思呢?

元注解是可以注解到注解上的注解,或者说元注解是一种基本注解,但是它能够应用到其它的注解上面。

如果难于理解的话,你可以这样理解。元注解也是一张标签,但是它是一张特殊的标签,它的作用和目的就是给其他普通的标签进行解释说明的。

元标签有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。

@Retention

Retention 的英文意为保留期的意思。当 @Retention 应用到一个注解上的时候,它解释说明了这个注解的的存活时间。

它的取值如下:

  • RetentionPolicy.SOURCE 注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视。
  • RetentionPolicy.CLASS 注解只被保留到编译进行的时候,它并不会被加载到 JVM 中。
  • RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候,它会被加载进入到 JVM 中,所以在程序运行时可以获取到它们。

我们可以这样的方式来加深理解,@Retention 去给一张标签解释的时候,它指定了这张标签张贴的时间。@Retention 相当于给一张标签上面盖了一张时间戳,时间戳指明了标签张贴的时间周期。

上面的代码中,我们指定 TestAnnotation 可以在程序运行周期被获取到,因此它的生命周期非常的长。

@Target

Target 是目标的意思,@Target 指定了注解运用的地方。

你可以这样理解,当一个注解被 @Target 注解时,这个注解就被限定了运用的场景。

类比到标签,原本标签是你想张贴到哪个地方就到哪个地方,但是因为 @Target 的存在,它张贴的地方就非常具体了,比如只能张贴到方法上、类上、方法参数上等等。@Target 有下面的取值

  • ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
  • ElementType.CONSTRUCTOR 可以给构造方法进行注解
  • ElementType.FIELD 可以给属性进行注解
  • ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
  • ElementType.METHOD 可以给方法进行注解
  • ElementType.PACKAGE 可以给一个包进行注解
  • ElementType.PARAMETER 可以给一个方法内的参数进行注解
  • ElementType.TYPE 可以给一个类型进行注解,比如类、接口、枚举
### Java 注解使用教程与最佳实践 #### 一、注解概述 在现代的Java开发中,注解Annotation)已经成为一种非常强大和常用的技术。它们提供了一种在代码中嵌入元数据的方式,可以用于配置代码行为、进行代码检查和生成文档等[^1]。 #### 二、定义和使用注解 ##### 1. 定义自定义注解 为了创建自己的注解,需要使用 `@interface` 关键字。下面是一个简单的例子: ```java public @interface MyCustomAnnotation { String value(); } ``` 这个注解只有一个名为 `value` 的成员,返回类型为字符串。如果希望注解有更多参数,则可以在接口内声明多个方法形式的成员变量。 ##### 2. 应用注解到类或方法上 一旦定义好了注解之后就可以将其应用到任何合适的程序元素上了,比如类、字段、方法等等。例如: ```java @MyCustomAnnotation("这是一个测试") public class MyClass { @MyCustomAnnotation("这是另一个测试") public void myMethod() {} } ``` 这里给整个类以及其中一个具体的方法都加上了前面所定义好的自定义注解。 ##### 3. 处理注解信息 要读取并处理这些附加的信息,可以通过反射机制来完成。对于上述的例子来说,在运行时获取指定对象上的所有注解如下所示: ```java import java.lang.annotation.Annotation; // 获取Class级别的注解 MyClass obj = new MyClass(); for (Annotation anno : obj.getClass().getAnnotations()) { System.out.println(anno); } // 获取Method级别的注解 try { Method method = obj.getClass().getMethod("myMethod"); for (Annotation anno : method.getAnnotations()) { System.out.println(anno); } } catch (NoSuchMethodException e) { e.printStackTrace(); } ``` 这段代码展示了如何遍历目标组件上的每一个注解实例,并打印出来。 #### 三、常见场景下的最佳实践 当涉及到实际项目中的运用时,应该遵循以下几个原则以确保良好的设计模式和技术栈集成度: - **保持简单**:只针对确实有必要的情况引入新的注解;过多复杂的逻辑会降低系统的可理解性和维护成本。 - **标准化命名空间**:采用统一前缀或其他约定俗成的方式来区分不同用途之间的差异,便于识别和管理。 - **考虑生命周期影响**:某些操作可能会影响应用程序启动速度或者其他性能指标,所以在决定何时何地使用特定类型的注解之前应当充分评估其潜在后果。 另外值得注意的是,像 Spring 这样的框架提供了许多内置的支持功能,如依赖注入(`@Autowired`)和服务激活(`@PostConstruct`)等,这些都是基于标准 JDK 提供的基础之上构建而成的高级特性[^5]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

打赏作者

牛老师来巡山~

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

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

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

打赏作者

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

抵扣说明:

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

余额充值