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？

下面举个例子：

1、定义应用与类级别的注释

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ProptertyAnnotation {
 public String value();
}

这里定义的类注释，包含一个成员属性value。

2、定义方法级别的注释

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MethodAnnotation {
 String originate();
 String community();
}

这里定义的方法级别的注释包含2个成员属性：originate、community

3、自定义注释的具体应用

@ProptertyAnnotation(value="Property Annotation Test")
public class AnnotationInvoker {
 @MethodAnnotation(originate="test",community="china")
 public void setName(){
   }
}

4、编写测试类，采用反射方式获取类中定义的注解内容

private static void printClassAnnotation(Class clazz){
  if(clazz == null){
   return;
  }
  
  ProptertyAnnotation proptertyAnnotation = (ProptertyAnnotation)clazz.getAnnotation(ProptertyAnnotation.class);
  if(proptertyAnnotation != null){
    System.out.println(proptertyAnnotation.value());
  }
 }
 
 private static void printMethodAnnotatiion(Method method){
  if(method == null){
   return;
  }
  
  MethodAnnotation methodAnnotation = method.getAnnotation(MethodAnnotation.class);
  if(methodAnnotation != null){
   System.out.println("originate=" + methodAnnotation.originate() + ";community=" + methodAnnotation.community());
  }
  
 }

 public static void main(String[] args) {
  // TODO Auto-generated method stub
  Class clazz = AnnotationInvoker.class;
  printClassAnnotation(clazz);
  Method method = null;
  try {
   method = clazz.getMethod("setName", null);
  } catch (Exception e) {
   e.printStackTrace();
  }
  printMethodAnnotatiion(method);
  
 }

运行main方法，控制台打印

Property Annotation Test
originate=test;community=china

《完》