Java SE 注解

Java SE 注解

1、注解的介绍

  注解是Java 1.5 引入的，目前已被广泛应用于各种Java框架，如Hibernate，Jersey，Spring。注解相当于是一种嵌入在程序中的 元数据 ，可以使用注解解析工具或编译器对其进行解析，也可以指定注解在编译期或运行期有效。在注解诞生之前，程序的元数据存在的形式仅限于java注释或javadoc，但注解可以提供更多功能，它不仅包含元数据，还能作用于运行期，注解解析器能够使用注解决定处理流程。

    Annotation(注解)就是Java提供了一种元程序中的元素关联任何信息和任何元数据 (metadata)的途径和方法。**Annotation是一个接口，程序可以通过反射来获取指定程序元素的Annotation对象，然后通过Annotation对象来获取注解里面的元数据。注解API非常强大，被广泛应用于各种Java框架。

元数据：描述数据的数据

1.2、作用:

• 注释
• 标识|标志
• 传递数据
• 代替配置文件的存在

2、注释的分类

根据注解使用方法和用途分类

• 1)、JDK内置系统注解
• 2)、元注解
• 3)、自定义注解

2.1、内置注解

• 1)、标记注解:一个没有成员定义的Annotation类型被称为标记注解。
• 2)、单值注解:只有一个值
• 3)、完整注解:拥有多个值

   @Override : 标识重写方法
   @Deprecated : 标记过时
   @SuppressWarnings : 抑制警告

2.2、元注解

• 注解注解的注解
• 自定义注解

3、使用:

​ @注解名(参数)

位置:

• 类的上面

• 方法的上面

• 属性的上面
  …
  由定义的人决定!!!

4、内置注解

JavaSE中内置三个标准注解，定义在java.lang中：

4.1、@Override

    限定重写父类方法，若想要重写父类的一个方法时，需要使用该注解告知编译器我们正在重写一个方法。如此一来，当父类的方法被删除或修改了，编译器会提示错误信息；或者该方法不是重写也会提示错误。

public interface Car { 
void run(); 
}
class QQ implements Car{ 
		@Override public void run() {} 
}
class Bmw implements Car{ 
		@Override void run() {} 
}

4.2、@Deprecated

    标记已过时，当我们想要让编译器知道一个方法已经被弃用(deprecate)时，应该使用这个注解。Java推荐在javadoc中提供信息，告知用户为什么这个方法被弃用了，以及替代方法是什么

/*** Deprecated -->该方法过时(有更好的解决方案) */ 
public class TestDeprecated { 
		@Deprecated 
		public int test(){ 
				System.out.println("TestDeprecated.test()"); 
				return 0; 
		}
	 public void test(int a){ 
	 System.out.println("TestDeprecated.test(int)"); 
	 } 
}

4.3、@ SuppressWarnings

    抑制编译器警告，该注解仅仅告知编译器，忽略它们产生了特殊警告。如：在java泛型中使用原始类型。其保持性策略(retention policy)是SOURCE，在编译器中将被丢弃。

/*** SuppressWarnings 压制警告 * @author Administrator */ 
public class TestSuppressWarnings { 
		public static void main(String[] args) { 
				@SuppressWarnings("unused") 
				List<String> list =new ArrayList<String>(); 
		}
				
		@SuppressWarnings("rawtypes") //没有定义范型 
		public static List test(){ 
				return new ArrayList(); 
		} 
}

5、元注解

    元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的 meta-annotation 类型，它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解有四个，这些类型和它们所支持的类在java.lang.annotation包中可以找到。

5.1、@Target

用于描述注解的使用范围（即：被描述的注解可以用在什么地方）。

• CONSTRUCTOR:用于描述构造器
• FIELD:用于描述域
• LOCAL_VARIABLE:用于描述局部变量
• METHOD:用于描述方法
• PACKAGE:用于描述包
• PARAMETER:用于描述参数
• TYPE:用于描述类、接口(包括注解类型) 或enum声明

//此注解只能用在方法上 
@Target(ElementType.METHOD) 
@interface TestMethod {}

5.2、@Retention

表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有

效）表示注解类型保留时间的长短。取值(RetentionPoicy)有：

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

// 此注解可以用于注解类、接口(包括注解类型) 或enum声明 
@Target(ElementType.TYPE) 
//该注解运行时有效。注解处理器可以通过反射，获取到该注解的属性值，从而去做一些运行时的逻辑处理 @Retention(RetentionPolicy.RUNTIME) 
@interface TestRn{ }

5.3、@Documented

  表示使用该注解的元素应被javadoc或类似工具文档化，它应用于类型声明，类型声明的注解会影响客户端对注解元素的使用。如果一个类型声明添加了Documented注解，那么它的注解会成为被注解元素的公共API的一部分，@Documented是一个标记注解。

//可以被例如javadoc此类的工具文档化 
@Documented 
@interface TestDoc{ }

5.4、@Inherited

  表示一个注解类型会被自动继承，如果用户在类声明的时候查询注解类型，同时类声明中也没有这个类型的注解，那么注解类型会自动查询该类的父类，这个过程将会不停地重复，直到该类型的注解被找到为止，或是到达类结构的顶层（Object）。

//被子类继承的注解 
@Inherited 
@interface TestInheri{}

6、自定义注解

使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。

6.1 格式

  @interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。

public @interface 注解名{定义体}

6.2、 注解参数(即方法)

修饰符：

​ 只能用public或默认(default)这两个访问权修饰 ，默认为default

方法的类型

注解体中的方法的返回值，作为注解参数，只支持以下数据类型

• 基本数据类型（int,float,boolean,byte,double,char,long,short)；

• String类型；

• Class类型；

• enum类型；

• Annotation类型;

• 以上所有类型的数组

命名（方法的名字）：对取名没有要求，如果只有一个参数成员,最好把参数名称设为"value"，后加小括号。

参数：注解中的方法不能存在参数

默认值：可以包含默认值，使用default来声明默认值

注意事项：

• 注解必须Retention存在运行期间才能够通过反射使用
• 1.使用**@interface定义注解类型**
• 2.默认隐式的实现类java.lang.Annotation
• 3.自定义的注解类型不能再继承其他类,并且实现其他接口了
• 4.注解类型添加属性,字段–>数据类型 属性名()
• 5.如果属性**字段只有一个,建议属性名定义为value,**赋值的时候可以直接赋值,否则需要属性名=属性值
• 6.属性的数据类型: 可以为基本数据类型,String,Annotation,枚举类型,或者以上类型的数组类型
• 7.通过default关键字为属性定义默认值

6.3 例子

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented()
public @interface MyAnnotation {
    int value() default 0;
}