java 新增注解,Java注解（Annotation）上-定义

Java系统注解图.png

1、Annotation定义与架构

Java注解(Annotation，也叫标注)是JDK5.0引入的一种注释机制，Java语言中的类、方法、变量、参数以及包等都可以被标注。

Java标注可以通过反射获取到标注内容：

在编译器生成类文件时，标注可以被嵌入到字节码中，JVM可以保留标注内容，在运行时可以获得标注的内容。

Annotation架构.jpeg

1.1 组成

Annotation 的每一个实现类，都 "和 1 个 RetentionPolicy 关联" 并且 " 和 1~n 个 ElementType 关联"。可以通俗的理解为：每 1 个 Annotation 对象，都会有唯一的 RetentionPolicy 属性；至于 ElementType 属性，则有 1~n 个。

public interface Annotation {

boolean equals(Object obj);

int hashCode();

String toString();

Class extends Annotation> annotationType();

}

ElementType 是 Enum 枚举类型，用来指定 Annotation 的类型。当 Annotation 与某个 ElementType 关联时，就意味着：Annotation有了某种用途。例如，若一个 Annotation 对象是 METHOD 类型，则该 Annotation 只能用来修饰方法。

public enum ElementType {

TYPE, /* 类、接口(包括注释类型)或枚举声明 */

FIELD, /* 字段声明(包括枚举常量) */

METHOD, /* 方法声明 */

PARAMETER, /* 参数声明 */

CONSTRUCTOR, /* 构造方法声明 */

LOCAL_VARIABLE, /* 局部变量声明 */

ANNOTATION_TYPE, /* 注释类型声明 */

PACKAGE /* 包声明 */

}

RetentionPolicy 也是 Enum 枚举类型，用来指定 Annotation 的策略。通俗点说，就是不同 RetentionPolicy 类型的 Annotation 的作用域不同。

public enum RetentionPolicy {

SOURCE, /* Annotation信息仅存在于编译器处理期间，

编译器处理完之后就没有该Annotation信息了 */

//例如，" @Override" 标志就是一个 Annotation。

//当它修饰一个方法的时候，就意味着该方法覆盖父类的方法；

//并且在编译期间会进行语法检查！

//编译器处理完后，"@Override" 就没有任何作用了。

CLASS, /* 编译器将Annotation存储于类对应的.class文件中。默认行为 */

RUNTIME /* 编译器将Annotation存储于class文件中，并且可由JVM读入 */

}

1.2 实现类

Annotation 有许多实现类，包括：Deprecated, Documented, Inherited, Override 等。

2、通用定义

下面的作用是定义一个 Annotation，它的名字是 MyAnnotation1。定义了 MyAnnotation1 之后，我们可以在代码中通过 "@MyAnnotation1" 来使用它。 其它的，@Documented, @Target, @Retention, @interface 都是来修饰 MyAnnotation1 的。

@Documented

@Target(ElementType.TYPE)

@Retention(RetentionPolicy.RUNTIME)

public @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。*/

}

3、常用注解

Java定义了一套注解，3个在java.lang中，4个在java.lang.annotation中，Java7和8又分别添加1和2个注解。

3.1 JDK自带-作用在代码的注解

@Override

只能标注方法，表示该方法覆盖父类中的方法。如果发现其父类或引用的接口中并没有该方法是，会编译错误。

@Deprecated

标记过时方法，所标注内容，不再被建议使用。如果使用该方法，会有编译警告。

@SuppressWarnings

所标注内容产生的警告，编译器会对这些警告保持静默。

3.2 元注解-作用在其他注解的注解

@Retention

只能被用来标注“Annotation类型”，而且它被用来指定Annotation的RetentionPolicy属性。

标识这个注解怎么报错，是只在代码中，还是编入class文件中，或者是在运行时，可以通过反射访问。

@Documented

标注这些注解是否出现在javadoc中。所标注内容，可以出现在javadoc中。

@Target

只能被用来标注“Annotation类型”，而且它被用来指定Annotation的ElementType属性。

@Inherited

只能被用来标注“Annotation类型”，它所标注的Annotation具有继承性。(默认：注解并没有继承与任何子类)

3.3 新增注解

@SafeVarargs

忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。Java7开始支持。

@FunctionInterface

标识一个匿名函数或函数式接口。Java8开始支持。

@Repeatable

标识某注解可以在用一个声明上使用多次。Java8开始支持。

3.4 常用第三方注解

@Repository:　　　　用于标注数据访问组件，即DAO组件

@Service:　　　　用于标注业务层组件

@Transactional:　　　　声明这service所有方法都需要事务管理。每一个业务方法开始时都会打开一个事务

@Controller:　　　　控制层

@Component:　　　　把该中立的类交给spring管理

@Autowired:　　　　自动装配，将bean容器里的值自动注入到bean

@Path:　　　　　　处理REST请求,接口路径

@Method:

常用的HTTP动词有下面五个(括号里是对应的SQL命令)。

GET(SELECT)：从服务器取出资源(一项或多项)。

POST(CREATE)：在服务器新建一个资源。

PUT(UPDATE)：在服务器更新资源(客户端提供改变后的完整资源)。

PATCH(UPDATE)：在服务器更新资源(客户端提供改变的属性)。

DELETE(DELETE)：从服务器删除资源。

还有两个不常用的HTTP动词。

HEAD：获取资源的元数据。

OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

@Accept和@Content-Type

@Accept:　　　　就表示接口要返回给客户端的数据格式

@Content-Type:　　　　表示客户端发送给服务器端的数据格式。这个是写REST接口时候定义的

正常如果服务器没定义Accept但是自己添加了的话会报404，没找到对应接口。

@Produces 　　表示类或者方法返回的MIME数据类型

有几种格式如下：

(1)@Produces("text/plain") 文本类型

(2)@Produces("text/html") Html类型

(3)@Produces({"application/xml"}) Xml类型

(4)@Produces({ "application/json"}) Json类型

可以一次注解两种或多种的MIME类型，格式如：{"application/xml", "application/json"}这表示两者都可以使用，但是选择的时候一般会选择前者，即application/xml,因为它第一次出现。

@Consumes　　　　代表的是一个资源可以接受的 MIME 类型

@Queryparam与@Pathparam

@Queryparam：指定的是URL中的参数是以键值对的形式出现的,而在程序中 @QueryParam("from") int from则读出URL中from的值,

例如：URL输入为:users?from=100&to=200&orderBy=age&orderBy=name

@Pathparam：URL中只出现参数的值,不出现键值对

例如： /users/100

4、Annotation的作用

Annotation 是一个辅助类，它在Junit、Struts、Spring 等工具框架中被广泛使用。我们在编程中经常会使用到的 Annotation 作用有：

4.1 编译检查

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

@SuppressWarnings, @Deprecated 和 @Override 都具有编译检查作用，见上面例子。

4.2 在反射中使用Annotation

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

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

4.3 根据 Annotation 生成帮助文档

通过给 Annotation 注解加上 @Documented 标签，能使该 Annotation 标签出现在 javadoc 中。

4.4 能够帮忙查看查看代码

通过 @Override, @Deprecated 等，我们能很方便的了解程序的大致结构。

另外，我们也可以通过自定义 Annotation 来实现一些功能。