转自:http://wanqiufeng.blog.51cto.com/409430/458883

一、什么是java注解

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

1 为什么要自定义注解

  Java从1.5版本以后默认内置三个标注:

  1. @Override:只能用在方法之上的,用来告诉别人这一个方法是改写父类的。
  2. @Deprecated:建议别人不要使用旧的API的时候用的,编译的时候会用产生警告信息,可以设定在程序里的所有的元素上.
  3. @SuppressWarnings:这一个类型可以来暂时把一些警告信息消息关闭.

  但是,仅仅这三个标注是不能满足我们开发时一些需求的。所以java允许我们自定义注解来使用。

2 如何自定义注解

  自定义步骤大致分为两步:

  1. 通过@interface关键字(注意,不是interface,是@interace)声明注解名称,以及注解的成员属性或者叫做注解的参数。
  2. 使用java内置的四个元注解对这个自定义标注的功能和范围进行一些限制

问题来了,什么是元注解?

3 什么是元注解

元注解,就是定义注解的注解,也就是说这些元注解是的作用就是专门用来约束其它注解的注解。

请区别上面那三个注解,他们也是通过元注解定义而来的。

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

 1      元注解有:@Target,@Retention,@Documented,@Inherited 2  3         @Target 表示该注解用于什么地方,可能的 ElemenetType 参数包括: 4         ElemenetType.CONSTRUCTOR 构造器声明 5         ElemenetType.FIELD 域声明(包括 enum 实例) 6         ElemenetType.LOCAL_VARIABLE 局部变量声明 7         ElemenetType.METHOD 方法声明 8         ElemenetType.PACKAGE 包声明 9         ElemenetType.PARAMETER 参数声明
10         ElemenetType.TYPE 类,接口(包括注解类型)或enum声明
11
12         @Retention 表示在什么级别保存该注解信息。可选的 RetentionPolicy 参数包括:
13         RetentionPolicy.SOURCE 注解将被编译器丢弃
14         RetentionPolicy.CLASS 注解在class文件中可用,但会被VM丢弃
15         RetentionPolicy.RUNTIME VM将在运行期也保留注释,因此可以通过反射机制读取注解的信息。
16
17         @Documented 将此注解包含在 javadoc 中
18
19         @Inherited 允许子类继承父类中的注解 

4 自定义及使用注解示例

自定义一个类级别的标注Description

 1    package lighter.javaeye.com;
 2    import java.lang.annotation.Documented;
 3    import java.lang.annotation.ElementType;
 4    import java.lang.annotation.Retention;
 5    import java.lang.annotation.RetentionPolicy;
 6    import java.lang.annotation.Target;
 7
 8    @Target(ElementType.TYPE)//这个标注应用于类
 9    @Retention(RetentionPolicy.RUNTIME)//标注会一直保留到运行时
10    @Documented//将此注解包含在javadoc中
11    public @interface Description {
12        String value();
13    }

再定义个方法级别的注解Name

 1 package lighter.javaeye.com;
 2    import java.lang.annotation.Documented;
 3    import java.lang.annotation.ElementType;
 4    import java.lang.annotation.Retention;
 5    import java.lang.annotation.RetentionPolicy;
 6    import java.lang.annotation.Target;
 7
 8     //注意这里的@Target与@Description里的不同,参数成员也不同
 9    @Target(ElementType.METHOD)
10    @Retention(RetentionPolicy.RUNTIME)
11    @Documented
12    public @interface Name {
13        String originate();
14        String community();
15    }

然后使用以上两个注解

 1 package lighter.javaeye.com;
 2
 3 @Description(value="javaeye,做最棒的软件开发交流社区")
 4 public class JavaEyer {
 5          @Name(originate="创始人:robbin",community="javaEye")
 6          public String getName()
 7          {
 8                    return null;
 9          }
10
11          @Name(originate="创始人:江南白衣",community="springside")
12          public String getName2()
13          {
14                    return "借用两位的id一用,写这一个例子,请见谅!";
15          }
16 }
17
18 说明:其中标注“@Description(value="javaeye,做最棒的软件开发交流社区")”,可以写成“@Description("javaeye,做最棒的软件开发交流社区") ”,结果也是一样的。  因为Description标注定义的时候其参数(或者说属性)为value。  而value比较特殊,它在被指定参数的时候可以不用显示的写出来。  当然如果定义的时候参数名不是value而是其它的比如des,那么使用注解的时候,必须显示写出参数名,然后再赋值:@Description(Des=”xxx”)*/

提取出注解的信息

 1  package lighter.javaeye.com;
 2
 3  import java.lang.reflect.Method;
 4  import java.util.HashSet;
 5  import java.util.Set;
 6
 7  public class TestAnnotation {
 8          /**
 9           * author lighter
10           * 说明:具体关天Annotation的API的用法请参见javaDoc文档
11           */
12        public static void main(String[] args) throws Exception {
13        String CLASS_NAME = "lighter.javaeye.com.JavaEyer";
14        Class test = Class.forName(CLASS_NAME);
15        Method[] method = test.getMethods();
16        boolean flag = test.isAnnotationPresent(Description.class);
17         if(flag)
18         {
19                  Description des = (Description)test.getAnnotation(Description.class);
20                  System.out.println("描述:"+des.value());
21                  System.out.println("-----------------");
22         }
23
24         //把JavaEyer这一类有利用到@Name的全部方法保存到Set中去
25         Set<Method> set = new HashSet<Method>();
26         for(int i=0;i<method.length;i++)
27         {
28                  boolean otherFlag = method[i].isAnnotationPresent(Name.class);
29                  if(otherFlag) set.add(method[i]);
30         }
31         for(Method m: set)
32         {
33                  Name name = m.getAnnotation(Name.class);
34                   System.out.println(name.originate());
35                  System.out.println("创建的社区:"+name.community());
36         }
37      }
38 }

注意事项:
所有的Annotation会自动继承java.lang.annotation这一个接口,所以不能再去继承别的类或是接口.
     最重要的一点,Annotation类型里面的参数该怎么设定:
     第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型.
     第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和String,Enum,Class,annotations等数据类型,
以及这一些类型的数组.例如,String value();这里的参数成员就为String.
参考资料: http://www.javaeye.com/topic/36659#
http://www.javaeye.com/topic/400085

转载于:https://www.cnblogs.com/yaowukonga/archive/2013/03/28/2987002.html

Java 注解学习笔记相关推荐

  1. Java注解学习笔记

    前言 要想理解Annotation的作用,就必须先得知道何为元数据.元数据就是关于数据的数据,是添加到程序元素诸如方法.字段.类和包上的额外信息. 注解Annotation就是Java平台的元数据,该 ...

  2. java自定义注解学习笔记

    注解学习笔记之自定义注解 @Target({1,2,3,4,5,6,7}) 1.ElementType.CONSTRUCTOR:用于描述构造器 2.ElementType.FIELD:用于描述域 3. ...

  3. Java中如何创建自定义的注解学习笔记(MD版)

    概要 Java中如何创建自定义的注解学习笔记(MD版). 博客 博客地址:IT老兵驿站. 前言 记得这篇笔记还是在泉州的龙玲酒店记录的,是一个周六的晚上,坐飞机从上海到泉州,从笔记中能勾起一些旅游的回 ...

  4. 尚学堂JAVA高级学习笔记_1/2

    尚学堂JAVA高级学习笔记 文章目录 尚学堂JAVA高级学习笔记 写在前面 第1章 手写webserver 1. 灵魂反射 2. 高效解析xml 3. 解析webxml 4. 反射webxml 5. ...

  5. 黑马程序员Java教程学习笔记(五)

    学习视频:https://www.bilibili.com/video/BV1Cv411372m 如侵权,请私信联系本人删除 文章目录 黑马程序员Java教程学习笔记(五) 日期时间:Date.Sim ...

  6. java web学习笔记(持续更新)

    java web学习笔记 一.Java Web简介 二.认识Servlet 1.什么是Servlet? 2.请求路径 3.tomcat 4.Servlet的使用 三.Servlet简单应用 1.创建S ...

  7. Java入门学习笔记——郝斌(一)概述及面向对象

    Java入门学习笔记--郝斌 1.Java概述 java的起源和发展 java的特点 java的应用领域 java学习目标 环境变量的设置 为什么要设置path? path的设置 有关classpat ...

  8. Java NIO 学习笔记(三)----Selector

    目录: Java NIO 学习笔记(一)----概述,Channel/Buffer Java NIO 学习笔记(二)----聚集和分散,通道到通道 Java NIO 学习笔记(三)----Select ...

  9. 可能是最全面的 Java G1学习笔记

    转载自 可能是最全面的 Java G1学习笔记 引子 最近遇到很多朋友过来咨询G1调优的问题,我自己去年有专门学过一次G1,但是当时只是看了个皮毛,因此自己也有不少问题.总体来讲,对于G1我有几个疑惑 ...

最新文章

  1. JPA相关--Annotation
  2. sql 将多个括号及内容删除_新浪微博将对逝者账号设置保护:不能登录、新发和删除内容...
  3. String类中的equals方法与Object类中的equals方法的不同点
  4. lucene源码分析(4)Similarity相似度算法
  5. linux主机load average的概念计算过程注意事项
  6. php用户之间的数据,什么是位于用户与操作系统之间的一层数据管理软件
  7. thymeleaf学习
  8. Python——模拟轮盘抽奖游戏
  9. NOI2019游记 —— 夏花般绚烂,繁星般璀璨
  10. SqlSessionFactoryBean
  11. R6900P/R7000P 梅林固件
  12. 木子网罗数据库笔试题(一)
  13. STM32F103系列PWM波
  14. 聚焦技术实战!MDCC 2016 移动开发者大会盛大开幕
  15. arm模拟器手机版_基于ARM的模拟器
  16. 病毒之Worm.Win32.AutoRun
  17. 南京大学计算机科学专硕培养方案,计算机科学与技术专业硕士研究生培养方案(2014版)...
  18. UWP开发入门(十三)——用Diagnostic Tool检查内存泄漏
  19. iOS 12 修改微信提示音,无需越狱不用电脑,详细教程
  20. Docker 网络连通

热门文章

  1. cookie 和session 的区别
  2. java容器类继承_JAVA容器 - weslie - OSCHINA - 中文开源技术交流社区
  3. 小程序 Typescript 最佳实践
  4. AUTOSAR从入门到精通100讲(二十五)-AutoSar架构中的Methodology
  5. AUTOSAR从入门到精通100讲(二十二)-手把手教你写Demo系列之车道线检测
  6. oracle 10g r2 for solaris x86,Oracle10g for Solaris9(x86)安装指南
  7. bigdecimal取小数部分_小数精度丢失问题分析和解决
  8. 前端全栈大佬是如何使用javaScript实现一个焦点图
  9. 一种移动端自适应屏幕的方法
  10. kail利用msf工具对ms10-087漏洞入侵渗透WinXP