文章目录

• ⚽ 注解的概述
• ⚽ 常见注解的使用示例
• • 🏐 文档相关的注解
  • 🏐 在编译时进行格式检查(JDK内置的三个基本注解)
  • 🏐 跟踪代码依赖性，实现替代配置文件功能
• ⚽ 自定义注解
• ⚽ JDK中的元注解
• • 🏐 Retention
  • 🏐 Target
  • 🏐 Documented(实际应用中，使用较少)
  • 🏐 Inherited(实际应用中，使用较少)
• ⚽ JDK8新特性
• • 🏐 可重复注解
  • • 🏀 JDK8之前实现重复注解
    • 🏀 JDK8之后实现重复注解
  • 🏐 类型注解

---

⚽ 注解的概述

从 JDK 5.0 开始, Java 增加了对元数据(MetaData) 的支持, 也就是Annotation(注解)。Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用 Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。

Annotation 可以像修饰符一样被使用, 可用于修饰包,类, 构造器, 方法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在 Annotation 的 “name=value” 对中。

在JavaSE中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在JavaEE/Android中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替JavaEE旧版中所遗留的繁冗代码和XML配置等。未来的开发模式都是基于注解的，JPA是基于注解的，Spring2.5以上都是基于注解的，Hibernate3.x以后也是基于注解的，现在的Struts2有一部分也是基于注解的了，注解是一种趋势，一定程度上可以说：框架 = 注解 + 反射 + 设计模式。

⚽ 常见注解的使用示例

使用 Annotation 时要在其前面增加 @ 符号, 并把该 Annotation 当成一个修饰符使用，用于修饰它支持的程序元素

🏐 文档相关的注解

• @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 shkstart
* @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: 限定重写父类方法, 该注解只能用于方法，编译时会校验修饰的方法是否重写父类的方法

  class Person {
      public Person() {
      }
      public void walk() {
          System.out.println("walk");
      }
  }
  class Student extends Person{
      @Override
      public void walk() {
          System.out.println("stu-walk");
      }
  }
  

• @Deprecated: 用于表示所修饰的元素(类, 方法, 属性, 构造器等)已过时。通常是因为所修饰的结构危险或存在更好的选择。标识类、属性或方法已经过时了，但是依旧可以使用。

      public static void main(String[] args) {
          Date date = new Date(2020, 10, 11);
          System.out.println(date);
      }
  

  
  

• @SuppressWarnings: 抑制编译器警告
  
  

  // 可以传入一个字符串数组，抑制多种类型的警告
  // “all” 抑制所有警告
  @SuppressWarnings({"unused", "rawtypes"})
  

🏐 跟踪代码依赖性，实现替代配置文件功能

Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署。

使用xml文件进行Servlet的部署：

<servlet>
	<servlet-name>LoginServlet</servlet-name>
	<servlet-class>com.servlet.LoginServlet</servlet-class>
</servlet>
<servlet-mapping>
	<servlet-name>LoginServlet</servlet-name>
	<url-pattern>/login</url-pattern>
</servlet-mapping>

使用注解进行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);
	} 
}

⚽ 自定义注解

• 自定义新的 Annotation 类型使用 @interface 关键字，自定义注解自动继承了java.lang.annotation.Annotation接口
• Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组。
• 可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始值可使用 default 关键字
• 如果只有一个参数成员，建议使用参数名为value

public @interface MyAnnotation {
    String value() default "test";
}

• 如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认值。格式是“参数名 = 参数值”，如果只有一个参数成员，且名称为value，可以省略“value=”

class Person {
    @MyAnnotation()
    public Person() {
    }
    @MyAnnotation(value = "hello")
    public void walk() {
        System.out.println("walk");
    }
    @MyAnnotation("world")
    public void read() {
        System.out.println("read");
    }
}

• 没有成员定义的 Annotation 称为标记; 包含成员变量的 Annotation 称为元数据 Annotation
• 注意：自定义注解必须配上注解的信息处理流程才有意义，通过反射实现，通过反射获取注解中的值，根据注解的值执行相应的操作。

⚽ JDK中的元注解

JDK 的元 Annotation 用于修饰其他 Annotation 定义，即元注解是用于修饰其他注解的注解。

元数据：用于修饰数据的数据
例如，String name = "ZS"，其中“ZS”为真实数据，String和name是对该数据的修饰，“ZS”是一个字符串类型的数据，"ZS"是表示一个人名的变量。

• JDK5.0提供了4个标准的meta-annotation(元注解)类型，分别是：
  • Retention
  • Target
  • Documented
  • Inherited

🏐 Retention

• @Retention: 只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 的生命周期, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用
  @Rentention 时必须为该 value 成员变量指定值:
  • RetentionPolicy.SOURCE:在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注释
  • RetentionPolicy.CLASS:在class文件中有效（即class保留） ， 当运行 Java 程序时, JVM不会保留注解。 这是默认值
  • RetentionPolicy.RUNTIME:在运行时有效（即运行时保留），当运行 Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释。

🏐 Target

@Target: 用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于修饰哪些程序元素，即用于指定注解能够修改哪些程序元素(类、方法、属性、构造器等)。@Target 也包含一个名为 value 的成员变量。如果没有使用@Target修饰注解，则该注解在任何程序元素上都可用。

🏐 Documented(实际应用中，使用较少)

@Documented: 用于指定被该元 Annotation 修饰的 Annotation 类将被javadoc 工具提取成文档。默认情况下，javadoc是不包括注解的。定义为Documented的注解必须设置Retention值为RUNTIME。

🏐 Inherited(实际应用中，使用较少)

@Inherited: 被它修饰的 Annotation 将具有继承性。如果某个类使用了被@Inherited 修饰的 Annotation, 则其子类将自动具有该注解。比如：如果把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解

⚽ JDK8新特性

Java 8对注解处理提供了两点改进：可重复的注解及可用于类型的注解。此外，反射也得到了加强，在Java8中能够得到方法参数的名称。这会简化标注在方法参数上的注解。

🏐 可重复注解

重复注解，即在同一个使用一个注解两次，只是注解的值不同。

🏀 JDK8之前实现重复注解

定义会被重复使用的注解：

public @interface MyAnnotation {
    String value() default "test";
}

定义一个注解，其中的成员参数为MyAnnotation类型的数组：

public @interface MyAnnotations {
    MyAnnotation[] value();
}

使用注解：

@MyAnnotations({@MyAnnotation("hello"), @MyAnnotation("world")})
class Person {}

🏀 JDK8之后实现重复注解

注意可重复注解的Retention、Inherited和Target等元注解要一致。

定义会被重复使用的注解：

@Repeatable(MyAnnotations.class) // 定义为可重用注解
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String value() default "test";
}

定义一个注解，其中的成员参数为MyAnnotation类型的数组：

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotations {
    MyAnnotation[] value();
}

使用注解：

@MyAnnotation("hello")
@MyAnnotation("world")
class Person {}

🏐 类型注解

• JDK1.8之后，关于元注解@Target的参数类型ElementType枚举值多了两个：TYPE_PARAMETER、TYPE_USE。在Java 8之前，注解只能是在声明的地方所使用，Java8开始，注解可以应用在任何地方。

  • ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中（如：泛型声明）。

    @Repeatable(MyAnnotations.class) // 定义为可重用注解
    @Target({ElementType.TYPE, ElementType.METHOD, ElementType.TYPE_PARAMETER})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface MyAnnotation {
        String value() default "test";
    }
    
    class Test<@MyAnnotation T> {}
    

  • ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中。

    @Repeatable(MyAnnotations.class) // 定义为可重用注解
    @Target({ElementType.TYPE, ElementType.METHOD, ElementType.TYPE_PARAMETER, ElementType.TYPE_USE})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface MyAnnotation {
        String value() default "test";
    }
    

        public void show() throws @MyAnnotation Exception {
            ArrayList<@MyAnnotation String> list = new ArrayList<>();
            int num = (@MyAnnotation int) 10L;
        }