java注解详解与自定义注解的实现

最新推荐文章于 2024-08-08 08:30:00 发布

置顶凌晨写博客

最新推荐文章于 2024-08-08 08:30:00 发布

阅读量1.2w

点赞数

分类专栏：框架文章标签：注解自定义注解

本文链接：https://blog.csdn.net/hj12312/article/details/87449991

版权

框架专栏收录该内容

4 篇文章 0 订阅

订阅专栏

注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。

1、java注解的优缺点

注解本质上通过反射来实现的，我们都知道，反射是一种程序的自省机制，其实反射是破坏封装的一种方式，反射的效率很低的，对程序本身访问会造成很多的额外开销。比如你采用Spring注解，@resource标识在一个类上面，那么程序会通过反射一遍遍的调用，首先通过class得到类对象，然后调取其中的getAnnotations()方法遍历类上的注解，一遍扫描和寻找注解，这其中就会有减慢效率，这不过是一种语法糖。其实通过xml来配置更好，不过不够方便，注解的最终意义也就是方便程序员而已。

优点：
　　１、保存在 class 文件中，降低维护成本。
　　２、无需工具支持，无需解析。
　　３、编译期即可验证正确性，查错变得容易。
　　４、提升开发效率。
缺点：
　　１、若要对配置项进行修改，不得不修改 Java 文件，重新编译打包应用。
　　２、配置项编码在 Java 文件中，可扩展性差

3、增加了程序的耦合性，因为注解保存在class文件中，而且比较分散

2、注解的分类

2.1 按运行机制分类

源码注解：

注解只在源码中存在，编译成.class文件就不存在了。

编译时注解：

注解在源码和.class文件中都存在。（例如：JDK的三个注解）

运行时注解：

在运行阶段还起作用，甚至会影响运行逻辑的注解。

2.2 按来源分类

JDK自带注解:

@Override 表示当前方法覆盖了父类的方法
@Deprecation 表示方法已经过时,方法上有横线，使用时会有警告。
@SuppviseWarnings 表示关闭一些警告信息(通知java编译器忽略特定的编译警告)

第三方注解

第三方注解，即第三方jar包提供的注解，比如lombok的@Data ,spring的@Autowired，@Service等等

自定义注解

顾名思义，自己在程序中定义的注解

3、自定义注解的实现

首先看一个自定义注解事例：


@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Description { //使用@interface关键字定义注解
 
	//成员以无参数无异常方式声明
	String desc();
	/* String desc(int a);
	 * String desc() throws Exception;
	 * 都是错误的声明方式
	 */
	
	String author();
	// String author() default ""; 合法的声明
	
	//可以用default为成员指定一个默认值
	int age() default 18;
	
	/*
	 * 如果声明：Map map(); 则会报错：
	 * Invalid type Map for the annotation attribute Description.map; 
	 * only primitive type, String, Class, annotation, enumeration 
	 * are permitted or 1-dimensional arrays thereof
	 * 
	 * 只有原始类型和String, Class, annotation, enumeration才可以
	 */
}

自定义注解语法如下：

1.使用@interface关键字定义注解，注意关键字的位置

使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。

2.成员以无参数无异常的方式声明，注意区别一般类成员变量的声明

3.可以使用default为成员指定一个默认值，如上所示

注解元素必须有确定的值，要么在定义注解的默认值中指定，要么在使用注解时指定，非基本类型的注解元素的值不可为null。因此, 使用空字符串或0作为默认值是一种常用的做法。这个约束使得处理器很难表现一个元素的存在或缺失的状态，因为每个注解的声明中，所有元素都存在，并且都具有相应的值，为了绕开这个约束，我们只能定义一些特殊的值，例如空字符串或者负数，一次表示某个元素不存在，在定义注解时，这已经成为一个习惯用法。

4.成员类型是受限的，合法的类型包括原始类型以及String、Class、Annotation、Enumeration （JAVA的基本数据类型有8种：byte(字节)、short(短整型)、int(整数型)、long(长整型)、float(单精度浮点数类型)、double(双精度浮点数类型)、char(字符类型)、boolean(布尔类型）

5.注解类可以没有成员，没有成员的注解称为标识注解，例如JDK注解中的@Override、@Deprecation

6.如果注解只有一个成员，并且把成员取名为value()，则在使用时可以忽略成员名和赋值号“=” ,例如JDK注解的@SuppviseWarnings ；如果成员名不为value，则使用时需指明成员名和赋值号"="

4、元注解

元注解，即注解的注解，就是给你自己定义的注解添加注解，你自己定义了一个注解，但你想要你的注解有什么样的功能，此时就需要用元注解对你的注解进行说明了。

元注解有4个，即上面事例中的4个注解：

@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented

4.1 @Target

即注解的作用域，用于说明注解的使用范围（即注解可以用在什么地方，比如类的注解，方法注解，成员变量注解等等）

取值：

ElemenetType.CONSTRUCTOR----------------------------构造器声明
ElemenetType.FIELD --------------------------------------域声明（包括 enum 实例）
ElemenetType.LOCAL_VARIABLE------------------------- 局部变量声明
ElemenetType.METHOD ----------------------------------方法声明
ElemenetType.PACKAGE --------------------------------- 包声明
ElemenetType.PARAMETER ------------------------------参数声明
ElemenetType.TYPE--------------------------------------- 类，接口（包括注解类型）或enum声明

4.2. @Retention

描述的注解在什么范围内有效。

取值有：

RetentionPolicy.SOURCE--------------------------只在源码显示，编译时会丢失
RetentionPolicy.CLASS-----------------------------编译时会记录到class中，运行时忽略
RetentionPolicy.RUNTIME------------------------- 运行时存在，可以通过反射读取