1.初始注解
注解(Annotation)一个新的代码的编写形式。让我们在编写代码不那么单调了。
在开发Java程序,尤其是Javaee应用的时候,总是免不了与各种配置文件打交道。以Javaee中典型的ssh架构来说,ssh这三个框架都有自己的XML格式的配置文件。这些配置文件需要与Java源代码保存同步,否则的话就可能出现错误。而且这些错误有可能到了运行时刻才被发现。把同一份信息保存在两个地方,总是个坏的主意。理想的情况是在一个地方维护这些信息就好了。其它部分所需的信息则通过自动的方式来生成。JDK 5中引入了源代码中的注解(annotation)这一机制。注解使得Java源代码中不但可以包含功能性的实现代码,还可以添加元数据。注解的功能类似于代码中的注释,所不同的是注解不是提供代码功能的说明,而是实现程序功能的重要组成部分。Java注解已经在很多框架中得到了广泛的使用,用来简化程序中的配置。
在我们之前使用eclipse编写代码的过程中,有时候经常会出现黄色的警告,我们都没在意过。其实我们如果按ctrl+1键我们会发现有提示带@xx的东西,如果我们加上这个东西,那么黄色警告就没有了。那么这个@xx是神马东西那。其实这个就是注解:
jdk定义在java.lang包下有三个注解:
@Override 表示当前方法是覆盖父类的方法。
@Deprecated 表示当前元素是不赞成使用的。
@SuppressWarnings 表示关闭一些不当的编译器警告信息。
那么到底什么是注解那?
注解相当于一种标记,在程序中加了注解就等于为程序打上了某种标记,没加,则等于没有某种标记,以后,javac编译器,开发工具和其他程序可以用反射来了解你的类及各种元素上有无何种标记,看你有什么标记,就去干相应的事。标记可以加在包,类,字段,方法,方法的参数以及局部量上。
2.自定义注解
要想自定义注解要先了解一下注解的结构图。
注解类:
@interface A
{
}
应用了注解的类:
@A
Class B
{
}
对“应用了注解类的类”进行反射操作的类,即使解析操作:
Class C {
B.class.isAnnotionPresent(A.class);
A a = B.class.getAnnotion(A.class);
}
注解的基本属性:
① 什么是注解的属性?
一个注解相当于一个胸牌,如果你胸前贴了胸牌,就是传智播客的学生,否则,就不是。如果还想区分出是传智播客哪个班的学生,这时候可以为 胸牌在增加一个属性来进行区分。加了属性的标记效果为:@MyAnnotation(color="red")
② 定义基本类型的属性和应用属性:
在注解类中增加String color();
@MyAnnotation(color="red")
③ 用反射方式获得注解对应的实例对象后,再通过该对象调用属性对应的方法
MyAnnotation a = (MyAnnotation)AnnotationTest.
class.getAnnotation(MyAnnotation.
class);
System.
out.println(a.color());
可以认为上面这个@MyAnnotation是MyAnnotaion类的一个实例对象
④ 为属性指定缺省值
String color() default "yellow";
⑤ value属性:
String value() default "zxx";
如果注解中有一个名称为value的属性,且你只想设置value属性(即其他属性都采用默认值或者你只有一个value属性),那么可以省略value=部 分,例如:@MyAnnotation("lhm")。
注解的高级属性:
① 数组类型的属性
int [] arrayAttr()
default {1,2,3};
@MyAnnotation(arrayAttr={2,3,4})
② 枚举类型的属性
EnumTest.TrafficLamp lamp() ;
@MyAnnotation(lamp=EnumTest.TrafficLamp.GREEN)
③ 注解类型的属性:
MetaAnnotation annotationAttr()
default @MetaAnnotation("xxxx");
@MyAnnotation(annotationAttr=@MetaAnnotation(“yyy”) )
可以认为上面这个@MyAnnotation是MyAnnotaion类的一个实例对象,同样的道理,可以认为上面这个@MetaAnnotation是MetaAnnotation类的一 个实例对象,调用代码如下:
MetaAnnotation ma = myAnnotation.annotationAttr();
System.out.println(ma.value());
元注解:元注解是指注解的注解。包括 @Retention @Target @Document @Inherited四种。
① @Retention: 定义注解的保留策略
@Retention(RetentionPolicy.SOURCE)
//注解仅存在于源码中,在class字节码文件中不包含
②
@Target:定义注解的作用目标
@Retention(RetentionPolicy.CLASS) // 默认的保留策略,注解会在class字节码文件中存在,但运行时无法获得,
@Retention(RetentionPolicy.RUNTIME) // 注解会在class字节码文件中存在,在运行时可以通过反射获取到
@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) ///包
③ @Document:说明该注解将被包含在javadoc中
④ @Inherited:说明子类可以继承父类中的该注解
注解的实际案例:
package cn.itheima.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Itheima {
String name() default "黑马程序员";
String value();
int year() default 1;
String[] teachers() default {"方老大","张孝祥"};
}
应用注解:
package cn.itheima.annotation;
@Itheima(value="黑马程序员",name="传智播客",teachers={"张泽华"},year=3)
public class TargetClass {
@Itheima("黑马方法")
public void test(){
System.out.println("黑马程序员");
}
}
解析:
package cn.itheima.annotation;
import java.lang.reflect.Method;
public class AnnotationTest {
public static void main(String[] args) throws Exception{
if(TargetClass.class.isAnnotationPresent(Itheima.class)){
Itheima itheima = TargetClass.class.getAnnotation(Itheima.class);
System.out.println(itheima.value());
System.out.println(itheima.name());
System.out.println(itheima.year());
System.out.println(itheima.teachers().length);
}
System.out.println("------------method annotation------------");
Method method = TargetClass.class.getMethod("test");
if(method.isAnnotationPresent(Itheima.class)){
Itheima MethodItheima = method.getAnnotation(Itheima.class);
System.out.println(MethodItheima.value());
System.out.println(MethodItheima.name());
System.out.println(MethodItheima.teachers().length);
}
}
}