java注解相关

本文参考很多大神的文档,特别再次表示感谢分享!!

1.何为注解?

 概念:注解(Annotation),也叫元数据。一种代码级别的说明。

它是JDK1.5及以后版本引入的一个特性,与类、接口、枚举是在同一个层次。

它可以声明在包、类、字段、方法、局部变量、方法参数等的前面,用来对这些元素进行注释说明.

Annotations提供一些本来不属于程序的数据.

2.注解的分类

2.1 按照运行机制  (往后会讲)

源码注解:

注解只在源码中存在,编译成.class文件就不存在了。

编译时注解:

注解在源码和.class文件中都存在。(例如:JDK的三个注解)

运行时注解:

在运行阶段还起作用,甚至会影响运行逻辑的注解。

2.2 按照来源分

来自JDK的注:上面图片的三个@Override  @Deprecated  @SuppressWarning,

第三方的注解:比如Spring框架、Mybatis框架的注解等等,以后再说吧

自己定义的注解:往后会详细地讲

3.JDK自带注解

@Override 表示当前方法覆盖了父类的方法

@Deprecation 表示方法已经过时,方法上有横线,使用时会有警告。

@SuppviseWarnings 表示关闭一些警告信息(通知java编译器忽略特定的编译警告)

1部分 Annotation架构


先看看Annotation的架构图:

从中,我们可以看出:

(01) 1个Annotation 和 1个RetentionPolicy关联。

可以理解为:每1个Annotation对象,都会有唯一的RetentionPolicy属性。

(02) 1个Annotation 和 1~n个ElementType关联。

可以理解为:对于每1个Annotation对象,可以有若干个ElementType属性。

(03) Annotation 有许多实现类,包括:Deprecated, Documented, Inherited, Override等等。

(04) Annotation 的每一个实现类,都“和1个RetentionPolicy关联”并且“和1~n个ElementType关联”。

2部分 Annotation组成部分


1 annotation组成成分

java annotation 的组成中,有3个非常重要的主干类。它们分别是:

(01) Annotation.java

annotationType();
}
" v:shapes="文本框_x0020_2">

(02) ElementType.java

(03) RetentionPolicy.java

说明:

(01) Annotation 就是个接口。

“每1个Annotation” 都与 “1个RetentionPolicy”关联,并且与 “1~n个ElementType”关联。可以通俗的理解为:每1个Annotation对象,都会有唯一的RetentionPolicy属性;至于ElementType属性,则有1~n个。

(02) ElementType 是Enum枚举类型,它用来指定Annotation的类型。

“每1个Annotation” 都与 “1~n个ElementType”关联。当Annotation与某个ElementType关联时,就意味着:Annotation有了某种用途。

例如,若一个Annotation对象是METHOD类型,则该Annotation只能用来修饰方法。

(03) RetentionPolicy 是Enum枚举类型,它用来指定Annotation的策略。通俗点说,就是不同RetentionPolicy类型的Annotation的作用域不同。

“每1个Annotation” 都与 “1个RetentionPolicy”关联。

a) 若Annotation的类型为 SOURCE,则意味着:Annotation仅存在于编译器处理期间,编译器处理完之后,该Annotation就没用了。

例如,“ @Override ”标志就是一个Annotation。当它修饰一个方法的时候,就意味着该方法覆盖父类的方法;并且在编译期间会进行语法检查!编译器处理完后,“@Override”就没有任何作用了。

b) 若Annotation的类型为 CLASS,则意味着:编译器将Annotation存储于类对应的.class文件中,它是Annotation的默认行为。

c) 若Annotation的类型为 RUNTIME,则意味着:编译器将Annotation存储于class文件中,并且可由JVM读入。

这时,只需要记住1Annotation” 都与 “1RetentionPolicy”关联,并且与 “1nElementType”关联。学完后面的内容之后,再回头看这些内容,会更容易理解。

3部分 java自带的Annotation


理解了上面的3个类的作用之后,我们接下来可以讲解Annotation实现类的语法定义了。

1 Annotation通用定义

@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation1 {
}

说明:

上面的作用是定义一个Annotation,它的名字是MyAnnotation1。

定义了MyAnnotation1之后,我们可以在代码中通过“@MyAnnotation1”来使用它。

其它的,@Documented,
@Target, @Retention, @interface都是来修饰MyAnnotation1的。下面分别说说它们的含义:

(01) @interface

使用@interface定义注解时,意味着它实现了java.lang.annotation.Annotation接口,即该注解就是一个Annotation。

 定义Annotation时,@interface是必须的。

注意:它和我们通常的implemented实现接口的方法不同。Annotation接口的实现细节都由编译器完成。通过@interface定义注解后,该注解不能继承其他的注解或接口。

(02) @Documented

类和方法的Annotation在缺省情况下是不出现在javadoc中的。如果使用@Documented修饰该Annotation,则表示它可以出现在javadoc中。

定义Annotation时,@Documented可有可无;若没有定义,则Annotation不会出现在javadoc中。

(03) @Target(ElementType.TYPE)

前面我们说过,ElementType
是Annotation的类型属性。而@Target的作用,就是来指定Annotation的类型属性。

@Target(ElementType.TYPE) 的意思就是指定该Annotation的类型是ElementType.TYPE。这就意味着,MyAnnotation1是来修饰“类、接口(包括注释类型)或枚举声明”的注解。

定义Annotation时,@Target可有可无。若有@Target,则该Annotation只能用于它所指定的地方;若没有@Target,则该Annotation可以用于任何地方。

(04) @Retention(RetentionPolicy.RUNTIME)

前面我们说过,RetentionPolicy
是Annotation的策略属性,而@Retention的作用,就是指定Annotation的策略属性。

@Retention(RetentionPolicy.RUNTIME) 的意思就是指定该Annotation的策略是RetentionPolicy.RUNTIME。这就意味着,编译器会将该Annotation信息保留在.class文件中,并且能被虚拟机读取。

定义Annotation时,@Retention可有可无。若没有@Retention,则默认是RetentionPolicy.CLASS

2 java自带的Annotation

通过上面的示例,我们能理解:

@interface用来声明Annotation,

@Documented用来表示该Annotation是否会出现在javadoc中,

@Target用来指定Annotation的类型,

@Retention用来指定Annotation的策略。

java 常用的Annotation

@Deprecated  -- @Deprecated 所标注内容,不再被建议使用。
@Override    -- @Override 只能标注方法,表示该方法覆盖父类中的方法。
@Documented  -- @Documented 所标注内容,可以出现在javadoc中。
@Inherited   -- @Inherited只能被用来标注“Annotation类型”,它所标注的Annotation具有继承性。
@Retention   -- @Retention只能被用来标注“Annotation类型”,而且它被用来指定Annotation的RetentionPolicy属性。
@Target      -- @Target只能被用来标注“Annotation类型”,而且它被用来指定Annotation的ElementType属性。
@SuppressWarnings -- @SuppressWarnings 所标注内容产生的警告,编译器会对这些警告保持静默。

4部分 Annotation 的作用


Annotation 是一个辅助类,它在Junit、Struts、Spring等工具框架中被广泛使用。

我们在编程中经常会使用到的Annotation作用有:

1 编译检查

Annotation具有“让编译器进行编译检查的作用”。

2 在反射中使用Annotation

在反射的Class, Method, Field等函数中,有许多于Annotation相关的接口。

这也意味着,我们可以在反射中解析并使用Annotation。

时间: 2024-10-05 20:57:14

java注解相关的相关文章

Java注解介绍

原文链接: Java Annotations: An Introduction原文日期: 2005年10月14日翻译日期: 2014年07月20日翻译人员: 铁锚 翻译完后,感觉这篇文章是不是在http://www.developer.com被挖坟了? Java注解介绍 基于注解(Annotation-based)的Java开发无疑是最新的开发趋势.[译者注: 这是05年的文章,在2014年,毫无疑问,多人合作的开发,使用注解变成很好的合作方式,相互之间的影响和耦合可以很低]. 基于注解的开发将

java注解基础入门

前言 这篇博客主要是对java注解相关的知识进行入门级的讲解,包括**,核心内容主要体现在对java注解的理解以及如何使用.希望通过写这篇博客的过程中让自己对java注解有更深入的理解,在工作中可以巧妙的使用注解,完善自己对基础知识的理解和使用. 目录 1.注解概述 2.注解作用 3.java常见的注解 4.如何自定义注解       5.元注解       6.注解反射 1.注解的概述 注解,告诉编译器如何运行程序! 2.注解的作用 1)告诉编译器如何运行程序:         2)跟踪代码依

Java注解(3)-注解处理器(编译期|RetentionPolicy.SOURCE)

注解的处理除了可以在运行时通过反射机制处理外,还可以在编译期进行处理.在编译期处理注解时,会处理到不再产生新的源文件为止,之后再对所有源文件进行编译. Java5中提供了apt工具来进行编译期的注解处理.apt是命令行工具,与之配套的是一套描述"程序在编译时刻的静态结构"的API:Mirror API(com.sun.mirror.*).通过Mirror API可以获取到被注解的Java类型元素的信息,从而提供自定义的处理逻辑.具体的处理工具交给apt来处理.编写注解处理器的核心是两个

Java注解

注解是一种元数据形式,提供关于不是程序部分的程序的数据.操作代码上的注解不影响注解的代码. 注解有许多用途,其中: 编译器信息 -- 注解被用于编译器检测错误或抑制警告. 编译时和部署时处理 -- 软件工具能处理注解信息生成代码.XML文件等等. 运行时处理 -- 一些注解可用在运行时检查. 1     注解基础 1.1    注解的格式 最简单的注解形式如下所示: @Entity 在符号字符(@)告诉编译器这是一个注解.在下面的例子中,注解的名称是Override: @Override voi

19.Java 注解

19.Java注解 1.Java内置注解----注解代码 @Deprecated                                    //不推荐使用的过时方法 @Deprecated public void badMethod(){ System.out.println("I am a old function"); } @Override                                        //必须是覆盖父类(接口)的函数 @Overrid

java注解(Annotation)解析

注解(Annotation)在java中应用非常广泛.它既能帮助我们在编码中减少错误,(比如最常见的Override注解),还可以帮助我们减少各种xml文件的配置,比如定义AOP切面用@AspectJ模式代替Schema模式,特别是最近接触了一点Spring MVC,每次编写Controller的时候用@RequestMapping(),@RequestParam,@ResponseBody等等. 我们所用的java中自带的注解都是定义好了的,直接拿来用,它就能发挥作用.当然了,自己也可以定义注

深入理解Java注解类型(@Annotation)

"-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 深入理解Java注解类型(@Annotation) - zejian的博客 - 博客频道 - CSDN.NET zejian的博客 目录视图 摘要视图 订阅 [活动]2017 CSDN博客专栏评选 &nbsp [5月书讯]流畅的Python,终于等到你!    &am

Java注解实践

Java注解实践 注解对代码的语意没有直接影响, 他们只负责提供信息给相关的程序使用. 注解永远不会改变被注解代码的含义, 但可以通过工具对被注解的代码进行特殊处理. JDK 基本Annotation 注解 说明 @Override 重写 @Deprecated 已过时 @SuppressWarnings(value = "unchecked") 压制编辑器警告 @SafeVarargs 修饰"堆污染"警告 @FunctionalInterface Java8特有的

java 注解——使用详解

在一些强大的第三方框架中我们常常可以见到注解的身影.xUtils.Retrofit等. 那么注解到底有什么魅力和好处让我们在设计种种框架的时候用到它呢? 对于注解的理解: (仅仅为个人理解) 1,我们通过注解给某个常量.方法或者类一个标记.那么这些常量就有了某种特征或者某种标记. 2,这些标记不参与我们的逻辑处理.这也是为什么它会写在方法或者类的外面的原因. 3,但是我们可以通过获取方法上的标记即注解来间接的影响程序的逻辑. 4,注解是被动的,它影响程序取决于程序员是否去使用它. 由此看来,注解