目录
1、注解 (Annotation) 概述
- 从 JDK 5.0 开始, Java 增加了对元数据(MetaData) 的支持, 也就是 Annotation(注解)
- Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加 载, 运行时被读取, 并执行相应的处理。通过使用 Annotation, 程序员 可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证 或者进行部署
- Annotation 可以像修饰符一样被使用, 可用于修饰包,类, 构造器, 方法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在 Annotation 的 “name=value” 对中。
- 在JavaSE中,注解的使用目的比较简单,例如标记过时的功能, 忽略警告等。在JavaEE/Android中注解占据了更重要的角色,例如 用来配置应用程序的任何切面,代替JavaEE旧版中所遗留的繁冗 代码和XML配置等。
- 未来的开发模式都是基于注解的,JPA是基于注解的,Spring2.5以 上都是基于注解的,Hibernate3.x以后也是基于注解的,现在的 Struts2有一部分也是基于注解的了,注解是一种趋势,一定程度上 可以说:框架 = 注解 + 反射 + 设计模式。
2、常见的Annocation的使用示例
示例一:生成文档相关的注解
@author标明开发该类模块的作者,多个作者之间使用,分割
@version标明该类模块的版本
@see参考转向,也就是相关主题
@since从哪个版本开始增加的
@param对方法中某参数的说明,如果没有参数就不能写
@return对方法返回值的说明,如果方法的返回值类型是void就不能写
@exception对方法可能抛出的异常进行说明 ,如果方法没有用throws显式抛出的异常就不能写
其中
@param @return和 @exception这三个标记都是只用于方法的。
@param的格式要求:@param形参名 形参类型 形参说明
@return的格式要求:@return 返回值类型 返回值说明
@exception的格式要求:@exception异常类型 异常说明
@param和@exception可以并列多个
package com.annotation.javadoc;
/**
* @author cyf
* @version 1.0
* @see Math.java
*/
public class JavadocTest {
/**
* 程序的主方法,程序的入口
* @param args String[] 命令行参数
*/
public static void main(String[] args) {
}
/**
* 求圆面积的方法
* @param radius double 半径值
* @return double 圆的面积
*/
public static double getArea(double radius){
return Math.PI * radius * radius;
}
}
示例二:在编译时进行格式检查(JDK内置的三个基本注解)
- @Override: 限定重写父类方法, 该注解只能用于方法
- @Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
- @SuppressWarnings: 抑制编译器警告
package com.annotation.javadoc;
public class AnnotationTest{
public static void main(String[] args) {
@SuppressWarnings("unused")
int a = 10;
}
@Deprecated
public void print(){
System.out.println("过时的方法");
}
@Override
public String toString() {
return "重写的toString方法()";
}
}
示例三:跟踪代码依赖性,实现替代配置文件功能
Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署
@WebServlet("/login")
public class LoginServlet extends HttpServlet {
private static final long serialVersionUID = 1L;
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws
ServletException, IOException {}
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws
ServletException, IOException {
doGet(request, response);
}
}
<servlet>
<servlet-name>LoginServlet</servlet-name>
<servlet-class>com.servlet.LoginServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>LoginServlet</servlet-name>
<servlet-mapping>/login</servlet-mapping>
</servlet-mapping>
3、自定义注解
- 定义新的 Annotation类型使用 @interface 关键字
- 自定义注解自动继承了java.lang.annotation.Annotation接口
- Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、 以上所有类型的数组。
- 可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始值可使用 default关键字
- 如果只有一个参数成员,建议使用参数名为value
- 如果定义的注解含有配置参数,那么使用时必须指定参数值,除非它有默认值。格式是“参数名 = 参数值”,如果只有一个参数成员,且名称为value, 可以省略“value=”
- 没有成员定义的 Annotation 称为标记; 包含成员变量的 Annotation 称为元数据 Annotation
注意:自定义注解必须配上注解的信息处理流程才有意义
@MyAnnotion("我爱尚硅谷")
public class MyAnnotionTest{
public static void main(String[] args) {
Class clazz = MyAnnotionTest.class;
Annotation a = clazz.getAnnotation(MyAnnotion.class);
MyAnnotion m = (MyAnnotion) a;
String info = m.value();
System.out.println(info);
}
}
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@interface MyAnnotion{
String value() default "atguigu";
}
jdk5.0 提供的4种元注解:
@Retention
@Retention: 只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 的生命周期, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用@Rentention 时必须为该 value 成员变量指定值:
- RetentionPolicy.SOURCE:在源文件中有效(即源文件保留),编译器直接丢弃这种策略的注释
- RetentionPolicy.CLASS:在class文件中有效(即class保留) , 当运行 Java 程序时, JVM 不会保留注解。 这是默认值
- RetentionPolicy.RUNTIME:在运行时有效(即运行时保留),当运行 Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释。
public enum RetentionPolicy {
SOURCE,
CLASS,
RUNTIME
}
@Target
@Target: 用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于 修饰哪些程序元素。@Target 也包含一个名为 value 的成员变量。
@Documented
@Documented: 用于指定被该元注解修饰的 Annotation 类将被 javadoc 工具提取成文档。默认情况下,javadoc是不包括注解的。
- 定义为Documented的注解必须设置Retention值为RUNTIME。
@Inherited
@Inherited: 被它修饰的 Annotation 将具有继承性。如果某个类使用了被 @Inherited 修饰的 Annotation, 则其子类将自动具有该注解。
- 比如:如果把标有@Inherited注解的自定义的注解标注在类级别上,子类则可以继承父类类级别的注解
- 实际应用中,使用较少
元数据的理解: String name = “atguigu”;
4、JDK8中注解的新特性
Java 8对注解处理提供了两点改进:可重复的注解及可用于类型的注解。此外, 反射也得到了加强,在Java8中能够得到方法参数的名称。这会简化标注在方法参数上的注解。
1)可重复注解
JDK8之前:
@MyAnnotions({@MyAnnotion("我爱"),@MyAnnotion("尚硅谷")})
public class MyAnnotionTest{
public static void main(String[] args) {
Class clazz = MyAnnotionTest.class;
Annotation a = clazz.getAnnotation(MyAnnotions.class);
MyAnnotions m = (MyAnnotions) a;
MyAnnotion[] value = m.value();
for (MyAnnotion myAnnotion : value) {
System.out.println(myAnnotion.value());
}
}
}
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE,ElementType.METHOD})
@interface MyAnnotion{
String value() default "atguigu";
}
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE,ElementType.METHOD})
@interface MyAnnotions{
MyAnnotion[] value();
}
JDK8之后,可重复的注解:
- 在MyAnnotation上声明@Repeatable,成员值为MyAnnotations.class
- 在MyAnnotation的Target和Retention和MyAnnotations等元注解相同
@MyAnnotion("我爱")
@MyAnnotion("尚硅谷")
public class MyAnnotionTest{
public static void main(String[] args) {
Class clazz = MyAnnotionTest.class;
Annotation a = clazz.getAnnotation(MyAnnotions.class);
MyAnnotions m = (MyAnnotions) a;
MyAnnotion[] value = m.value();
for (MyAnnotion myAnnotion : value) {
System.out.println(myAnnotion.value());
}
}
}
@Repeatable(MyAnnotions.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE,ElementType.METHOD})
@interface MyAnnotion{
String value() default "atguigu";
}
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE,ElementType.METHOD})
@interface MyAnnotions{
MyAnnotion[] value();
}
2)类型注解
JDK1.8之后,关于元注解@Target的参数类型ElementType枚举值多了两个。
- ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中(如:泛型声明)。
- ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中。
public class MyAnnotionTest{
@MyAnnotion
private String name;
public List<@MyAnnotion String> method1(@MyAnnotion long a) throws @MyAnnotion Exception{
String s1 = "a";
@MyAnnotion
String s2 = "b";
@MyAnnotion
String s3 = s1 + s2;
int b = (@MyAnnotion int) a;
ArrayList<String> list = new ArrayList<>();
return list;
}
}