深入java--注解

Java注解

1、什么是java注解
注解，顾名思义，注解,就是对某一事物进行添加注释说明，会存放一些信息，这些信息可能对以后某个时段来说是很有用处的。
Java注解又叫java标注，java提供了一套机制，使得我们可以对方法、类、参数、包、域以及变量等添加标准(即附上某些信息)。且在以后某个时段通过反射将标注的信息提取出来以供使用。

2 为什么要自定义注解
Java从1.5版本以后默认内置三个标注：
Ø @Override:只能用在方法之上的，用来告诉别人这一个方法是改写父类的。
Ø @Deprecated:建议别人不要使用旧的API的时候用的,编译的时候会用产生警告信息,可以设定在程序里的所有的元素上.
Ø @SuppressWarnings:这一个类型可以来暂时把一些警告信息消息关闭.
但是，仅仅这三个标注是不能满足我们开发时一些需求的。所以java允许我们自定义注解来使用。
3 为什么要自定义注解
Java从1.5版本以后默认内置三个标注：
  @Override:只能用在方法之上的，用来告诉别人这一个方法是改写父类的。
  @Deprecated:建议别人不要使用旧的API的时候用的,编译的时候会用产生警告信息,可以设定在程序里的所有的元素上.
  @SuppressWarnings:这一个类型可以来暂时把一些警告信息消息关闭.
但是，仅仅这三个标注是不能满足我们开发时一些需求的。所以java允许我们自定义注解来使用。
4 如何自定义注解
自定义步骤大致分为两步：
1， 通过@interface关键字(注意，不是interface，是@interace)声明注解名称，以及注解的成员属性或者叫做注解的参数。
2， 使用java内置的四个元注解对这个自定义标注的功能和范围进行一些限制
问题来了，什么是元注解？
5 什么是元注解
元注解，就是定义注解的注解，也就是说这些元注解是的作用就是专门用来约束其它注解的注解。请区别上面那三个注解，他们也是通过元注解定义而来的。

元注解有哪些呢，主要有四个@Target,@Retention,@Documented,@Inherited？

@Target：表示该注解可以用在什么地方，可能的ElementType参数包括：

                CONSTUCTOR :构造器的声明

                FIELD：域声明包括（Enum的实例）

                LOCAL_VARIABLE局部变量的声明

               METHOD方法的声明

               PACKAGE包的声明

               PARAMETER参数的声明

               TYPE类 接口或enum声明

@Retention是保留的意思，表示需要在社么级别保存=该注解信息可选的RetentionPolicy参数包括

               SOURCE注解将被编译器丢弃

               CLASS注解将在class文件中可用 但是会被VM丢弃

               RUNTIME  VM在运行期间也会保留注解  因此可以通过反射机制读取该注解的信息

@Documented

               注解将会保存在Javadoc中

@Inherited？

                允许子类继承父类的注解

大多数时候程序员主要定义自己的注解

6 注解加反射的程序使用举例，加反射就可以动态的查询（比如自己输入）对应的注解信息：

package test2.com.itany.www;import java.lang.annotation.Documented;import java.lang.annotation.ElementType;import java.lang.annotation.Inherited;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;/* * 自定义一个类级别的标注Description  */@Target(ElementType.TYPE)//表示该注解可以用在什么地方 TYPE类 接口或enum声明@Retention(RetentionPolicy.RUNTIME)// VM在运行期间也会保留注解  因此可以通过反射机制读取该注解的信息@Documented//注解将会保存在Javadoc中@Inherited//允许子类继承父类的注解public @interface PersonDescription{    String value();//可以说是注解中的属性或域}

package test2.com.itany.www;import java.lang.annotation.Documented;import java.lang.annotation.ElementType;import java.lang.annotation.Inherited;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;/* * 自定义一个方法级别的注解Name */@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)@Documented//注解将会保存在Javadoc中@Inherited//允许子类继承父类的注解public @interface Name{    String name();    String stuNumber();}

package test2.com.itany.www;@PersonDescription(value="一个学生类的注解信息")public class Student{    @Name(name="wangfei",stuNumber="1214032801")    public String getPersonalInfo()    {        return null;    }    @Name(name="wangfei2",stuNumber="1214032802")    public String getPersonalInfo2()    {        return null;    }}

package test2.com.itany.www;import java.lang.reflect.Method;import java.util.HashSet;import java.util.Set;public class Test{    public static void main(String[] args)    {        try        {            //test2.com.itany.www是可以动态的使用 比如输入一个这样的类名进来  通过反射可以查找相关类注解的信息            Class Class_Student=Class.forName("test2.com.itany.www.Student");            //表示在Student类上有没有PersonDescription这个类注解的信息  这个PersonDescription类注解在不同的java类可能表示的参数不一样            boolean flag=Class_Student.isAnnotationPresent(PersonDescription.class);            Method[] method=Class_Student.getMethods();            //如果Student类上有PersonDescription这个类注解的信息 那么            if(flag)            {                //这里需要强制转换   因为方法返回<A extends Annotation>                PersonDescription pd=(PersonDescription)Class_Student.getAnnotation(PersonDescription.class);                System.out.println("类注解PersonDescription在java类Student上的注解信息："+pd.value());            }            //把Student这一类有利用到@Name的全部方法保存到Set中去            Set<Method> methods=new HashSet<Method>();            for(int i=0;i<method.length;i++)            {                //每一个方法上如果有Name的注解就加入methods集合                if(method[i].isAnnotationPresent(Name.class))                {                    methods.add(method[i]);                }            }            //打印出有利用到@Name的全部方法            for(Method m:methods)            {                Name n=(Name)m.getAnnotation(Name.class);                System.out.println("在方法名："+m.getName()+"上的注解是："+n.name());                System.out.println("在方法名："+m.getName()+"上的注解是："+n.stuNumber());            }        }        catch (ClassNotFoundException e)        {            e.printStackTrace();        }    }}

输出结果：

类注解PersonDescription在java类Student上的注解信息：一个学生类的注解信息
在方法名：getPersonalInfo上的注解是：wangfei
在方法名：getPersonalInfo上的注解是：1214032801
在方法名：getPersonalInfo2上的注解是：wangfei2
在方法名：getPersonalInfo2上的注解是：1214032802

注解作用：比如说项目经理需要了解到一个项目进度  比如说要查找程序员们提交的对应类来判断，那么就可以查找这个类对应的注解信息，看看到了哪一步即可

7 注解元素

什么事注解元素？比如上例中的String类型的value就是一个注解元素

注解元素可用的元素类型如下所示：

所有基本类型：Int float boolean 等

String

Class

enum

Annotation

以上类型的数组

如果使用了其他类型 那么编译会报错  注意不允许使用其他类型 不过由于有自动的包装机制 其实这个也不算限制

注解也可以作为元素的类型 也就是说注解里面可以嵌套其他的注解  这个是一个非常有用的技巧

String value() default "A";//可以说是注解中的元素 ，元素必须有默认值 或者是在使用注解时提供默认值    /*     * 在每个注解的声明中，所有的元素都是存在的，并且都具有相应的值，为了绕开这个约束，我们只能自己定义一些特殊的值，例如     * 空字符串或者负数                               */    int id() default -1;//表示不存在    String idname() default "";//表示不存在