自定义注解
注解:Annotation
注解的好处:
1.能够读懂别人写的代码,特别是框架相关的代码。
2.本来可能需要很多配置文件,需要很多逻辑才能实现的内容,就可以使用一个或者多个注解来替代,这样就使得编程更加简洁,代码更加清晰。
3.(重点)刮目相看。
(但是怎么样才能让别人刮目相看呢?会用注解不是目的,最重要的是要使用自定义注解来解决问题。)
元注解:
元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型,它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解:
这些类型和它们所支持的类在java.lang.annotation包中可以找到。
1.@Target 用于描述注解的使用范围(即:被描述的注解可以用在什么地方)
2.@Retention 表示需要在什么级别保存该注释信息,用于描述注解的生命周期
3.@Documented 说明子类可以继承父类中的该注解
4.@Inherited 说明该注解将被包含在javado
下面我们看一下每个元注解的作用和相应分参数的使用说明。
@Target:
@Target说明了Annotation所修饰的对象范围:Annotation可被用于 packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。
作用:用于描述注解的使用范围(即:被描述的注解可以用在什么地方)
取值(ElementType)有:
1.CONSTRUCTOR:用于描述构造器
2.FIELD:用于描述域
3.LOCAL_VARIABLE:用于描述局部变量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述参数
7.TYPE:用于描述类、接口(包括注解类型) 或enum声明
四个定义注解时候的限定数据
@Target(ElementType.TYPE) :接口、类、枚举、注解
@Target(ElementType.FIELD) :字段、枚举的常量
@Target(ElementType.METHOD) :方法
@Target(ElementType.PARAMETER) :方法参数
@Target(ElementType.CONSTRUCTOR) :构造函数
@Target(ElementType.LOCAL_VARIABLE) :局部变量
@Target(ElementType.ANNOTATION_TYPE):注解
@Target(ElementType.PACKAGE) :包
@Retention(RetentionPolicy.SOURCE) :在源文件中有效(即源文件保留)
@Retention(RetentionPolicy.CLASS) :在class文件中有效(即class保留)
@Retention(RetentionPolicy.RUNTIME) :在运行时有效(即运行时保留)
@Inherited:说明子类可以继承父类中的该注解
@Document:说明该注解将被包含在javado
使用@interface自定义注解时,自动继承了java.lang.annotation.Annotation接口,由编译程序自动完成其他细节。在定义注解时,不能继承其他的注解或接口。
@interface用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。
方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。可以通过default来声明参数的默认值。
定义注解格式:
public @interface 注解名 {定义体}
注解参数的可支持数据类型:
1.所有基本数据类型(int,float,boolean,byte,double,char,long,short)
2.String类型
3.Class类型
4.enum类型
5.Annotation类型
自定义注解实例
/*
元注解 描述注解的适用范围 即被描述的注解可以用在什么地方
取值(ElementType)有:
1.CONSTRUCTOR:用于描述构造器
2.FIELD:用于描述域
3.LOCAL_VARIABLE:用于描述局部变量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述参数
7.TYPE:用于描述类、接口(包括注解类型) 或enum声明*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Apple {
String name();
String sex() default "男";
String phone() default "15931787945";
int age() default 2;
}
public class AppleTest {
@Apple(name="张朵朵")
public void show(){
System.out.println("==============");
}
}
测试类:
/**
* 自定义注解
* @throws Exception
*/
@Test
public void test() throws Exception{
Class<AppleTest> appleTestClass = AppleTest.class;
Apple show = appleTestClass.getMethod("show").getAnnotation(Apple.class);
System.out.println(show.name());
System.out.println(show.phone());
}
效果: