• 一文带你深入理解【Java基础】· 注解

    写在前面

            Hello大家好， 我是【麟-小白】，一位软件工程专业的学生，喜好计算机知识。希望大家能够一起学习进步呀！本人是一名在读大学生，专业水平有限，如发现错误或不足之处，请多多指正！谢谢大家！！！

            如果小哥哥小姐姐们对我的文章感兴趣，请不要吝啬你们的小手，多多点赞加关注呀！❤❤❤ 爱你们！！！

    目录

    写在前面

    1. 注解概述

    1.1 注解 (Annotation) 概述

    1.2 常见的Annotation示例

     2. 自定义 Annotation

    2.1 自定义注解说明

    2.2 JDK 中的元注解

    2.3 利用反射获取注解信息

    2.4 JDK8中注解的新特性

    3. 注解代码演示

    3.1 注解的使用

    结语

    【往期回顾】

    一文带你深入理解【Java基础】· 枚举类

    一文带你深入理解【Java基础】· 常用类（上）字符串相关类

    一文带你深入理解【Java基础】· 多线程（上）

    一文带你深入理解【Java基础】· 异常处理

    一文带你深入理解【Java基础】· 面向对象编程（上）

    一文带你深入理解【Java基础】· 数组

    1. 注解概述

    1.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有一部分也是基于注解的了，注解是一种趋势，一定程度上可以说：框架 = 注解 + 反射 + 设计模式。

    1.2 常见的Annotation示例

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

    示例一：生成文档相关的注解

    • @author 标明开发该类模块的作者，多个作者之间使用,分割
    • @version 标明该类模块的版本
    • @see 参考转向，也就是相关主题
    • @since 从哪个版本开始增加的
    • @param 对方法中某参数的说明，如果没有参数就不能写
    • @return 对方法返回值的说明，如果方法的返回值类型是void就不能写
    • @exception 对方法可能抛出的异常进行说明 ，如果方法没有用throws显式抛出的异常就不能写。其中：
      • @param @return 和 @exception 这三个标记都是只用于方法的。
      • @param的格式要求：@param 形参名 形参类型 形参说明
      • @return 的格式要求：@return 返回值类型 返回值说明
      • @exception的格式要求：@exception 异常类型 异常说明
      • @param和@exception可以并列多个
    1. package com.annotation.javadoc;
    2. /**
    3. * @author linxiaobai
    4. * @version 1.0
    5. * @see Math.java
    6. */
    7. public class JavadocTest {
    8.     /**
    9.     * 程序的主方法，程序的入口
    10.     * @param args String[] 命令行参数
    11.     */
    12.     public static void main(String[] args) {
    13.  
    14.     }
    15.     /**
    16.     * 求圆面积的方法
    17.     * @param radius double 半径值
    18.     * @return double 圆的面积
    19.     */
    20.     public static double getArea(double radius) {
    21.         return Math.PI * radius * radius;
    22.     }
    23. }

    示例二：在编译时进行格式检查 (JDK 内置的三个基本注解 )
    • @Override: 限定重写父类方法, 该注解只能用于方法
    • @Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
    • @SuppressWarnings: 抑制编译器警告
    1. package com.annotation.javadoc;
    2. public class AnnotationTest {
    3.     public static void main(String[] args) {
    4.         @SuppressWarnings("unused")
    5.         int a = 10;
    6.     }
    7.     @Deprecated
    8.     public void print() {
    9.         System.out.println("过时的方法");
    10.     }
    11.     @Override
    12.     public String toString() {
    13.         return "重写的toString方法()";
    14.     }
    15. }

    示例三：跟踪代码依赖性，实现替代配置文件功能
    • Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署。
    1. @WebServlet("/login")
    2. public class LoginServlet extends HttpServlet {
    3.     private static final long serialVersionUID = 1L;
    4.     protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    5. }
    6.     protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    7.     doGet(request, response);
    8.     } 
    9. }
    1. <servlet>
    2.     <servlet-name>LoginServletservlet-name>
    3.     <servlet-class>com.servlet.LoginServletservlet-class>
    4. servlet>
    5. <servlet-mapping>
    6.     <servlet-name>LoginServletservlet-name>
    7.     <url-pattern>/loginurl-pattern>
    8. servlet-mapping>
    • spring框架中关于“事务”的管理
    1. @Transactional(propagation=Propagation.REQUIRES_NEW,isolation=Isolation.READ_COMMITTED,readOnly=false,timeout=3)
    2. public void buyBook(String username, String isbn) {
    3.     //1.查询书的单价
    4.     int price = bookShopDao.findBookPriceByIsbn(isbn);
    5.     //2. 更新库存
    6.     bookShopDao.updateBookStock(isbn);
    7.     //3. 更新用户的余额
    8.     bookShopDao.updateUserAccount(username, price);
    9. }
    2. <tx:advice transaction-manager="dataSourceTransactionManager" id="txAdvice">
    3.     <tx:attributes>
    4.     
    5.     <tx:method name="buyBook" propagation="REQUIRES_NEW"
    6.         isolation="READ_COMMITTED" read-only="false" timeout="3" />
    7.     tx:attributes>
    8. tx:advice>

     2. 自定义 Annotation

    2.1 自定义注解说明

    • 定义新的 Annotation 类型使用 @interface 关键字
    • 自定义注解自动继承了java.lang.annotation.Annotation接口
    • Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组。
    • 可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始值可使用 default 关键字
    • 如果只有一个参数成员，建议使用参数名为value
    • 如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认值。格式是“参数名 = 参数值” ，如果只有一个参数成员，且名称为value，可以省略“value=”
    • 没有成员定义的 Annotation 称为标记; 包含成员变量的 Annotation 称为元数据 Annotation
    • 注意：自定义注解必须配上注解的信息处理流程才有意义。

    2.2 JDK 中的元注解

    • JDK 的元 Annotation 用于修饰其他 Annotation 定义
    • JDK5.0提供了4个标准的meta-annotation类型，分别是：
      • Retention
      • Target
      • Documented
      • Inherited

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

    • @Target: 用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于修饰哪些程序元素。 @Target 也包含一个名为 value 的成员变量。

    • @Documented: 用于指定被该元 Annotation 修饰的 Annotation 类将被javadoc 工具提取成文档。默认情况下，javadoc是不包括注解的。
      • 定义为Documented的注解必须设置Retention值为RUNTIME。
    • @Inherited: 被它修饰的 Annotation 将具有继承性。如果某个类使用了被@Inherited 修饰的 Annotation, 则其子类将自动具有该注解。
      • 比如：如果把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解
      • 实际应用中，使用较少

    2.3 利用反射获取注解信息

    • JDK 5.0 在 java.lang.reflect 包下新增了 AnnotatedElement 接口, 该接口代表程序中可以接受注解的程序元素
    • 当一个 Annotation 类型被定义为运行时 Annotation 后, 该注解才是运行时可见, 当 class 文件被载入时保存在 class 文件中的 Annotation 才会被虚拟机读取
    • 程序可以调用 AnnotatedElement对象的如下方法来访问 Annotation 信息

    2.4 JDK8中注解的新特性

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

    类型注解：
    • JDK1.8之后，关于元注解@Target的参数类型ElementType枚举值多了两个： TYPE_PARAMETER,TYPE_USE。
    • 在Java 8之前，注解只能是在声明的地方所使用，Java8开始，注解可以应用在任何地方。
    • ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中（如：泛型声明）。
    • ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中。 
    1. public class TestTypeDefine<@TypeDefine() U> {
    2.     private U u;
    3.     public <@TypeDefine() T> void test(T t) {
    4.     }
    5. }
    6. @Target({ElementType.TYPE_PARAMETER})
    7. @interface TypeDefine {
    8. }
    1. @MyAnnotation
    2. public class AnnotationTest {
    3.     @MyAnnotation
    4.     private String name;
    5.     public static void main(String[] args) {
    6.         AnnotationTest<@MyAnnotation String> t = null;
    7.         int a = (@MyAnnotation int) 2L;
    8.         @MyAnnotation
    9.         int b = 10;
    10.     }
    11.     public static <@MyAnnotation T> void method(T t) {
    12.     }
    13.     public static void test(@MyAnnotation String arg) throws @MyAnnotation Exception {
    14.     }
    15. }
    16. @Target(ElementType.TYPE_USE)
    17. @interface MyAnnotation {
    18. }

    3. 注解代码演示

    3.1 注解的使用

    1. import org.junit.Test;
    2.  
    3. import java.lang.annotation.Annotation;
    4. import java.util.ArrayList;
    5. import java.util.Date;
    6.  
    7. /**
    8.  * 注解的使用
    9.  *
    10.  * 1. 理解Annotation:
    11.  * ① jdk 5.0 新增的功能
    12.  *
    13.  * ② Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用 Annotation,
    14.  * 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。
    15.  *
    16.  * ③在JavaSE中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在JavaEE/Android
    17.  * 中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替JavaEE旧版中所遗留的繁冗
    18.  * 代码和XML配置等。
    19.  *
    20.  * 2. Annocation的使用示例
    21.  * 示例一：生成文档相关的注解
    22.  * 示例二：在编译时进行格式检查(JDK内置的三个基本注解)
    23.  @Override: 限定重写父类方法, 该注解只能用于方法
    24.  @Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
    25.  @SuppressWarnings: 抑制编译器警告
    27.   * 示例三：跟踪代码依赖性，实现替代配置文件功能
    28.   *
    29.   * 3. 如何自定义注解：参照@SuppressWarnings定义
    30.   * ① 注解声明为：@interface
    31.   * ② 内部定义成员，通常使用value表示
    32.   * ③ 可以指定成员的默认值，使用default定义
    33.   * ④ 如果自定义注解没有成员，表明是一个标识作用。
    35.  如果注解有成员，在使用注解时，需要指明成员的值。
    36.  自定义注解必须配上注解的信息处理流程(使用反射)才有意义。
    37.  自定义注解通过都会指明两个元注解：Retention、Target
    39.  4. jdk 提供的4种元注解
    40.  元注解：对现有的注解进行解释说明的注解
    41.  Retention：指定所修饰的 Annotation 的生命周期：SOURCE\CLASS（默认行为）\RUNTIME
    42.  只有声明为RUNTIME生命周期的注解，才能通过反射获取。
    43.  Target:用于指定被修饰的 Annotation 能用于修饰哪些程序元素
    44.   *******出现的频率较低*******
    45.  Documented:表示所修饰的注解在被javadoc解析时，保留下来。
    46.  Inherited:被它修饰的 Annotation 将具有继承性。
    48.  5.通过反射获取注解信息 ---到反射内容时系统讲解
    50.  6. jdk 8 中注解的新特性：可重复注解、类型注解
    52.  6.1 可重复注解:
    53.  ① 在MyAnnotation上声明@Repeatable，成员值为MyAnnotations.class
    54.  ② MyAnnotation的Target和Retention等元注解与MyAnnotations相同。
    56.  6.2 类型注解：
    57.  ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中（如：泛型声明）。
    58.  ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中。
    59.  */
    60. public class AnnotationTest {
    61.     public static void main(String[] args) {
    62.         Person p = new Student();
    63.         p.walk();
    64.  
    65.         Date date = new Date(2020, 10, 11);
    66.         System.out.println(date);
    67.  
    68.         @SuppressWarnings("unused")
    69.         int num = 10;
    70.         // System.out.println(num);
    71.  
    72.         @SuppressWarnings({"unused", "rawtypes"})
    73.         ArrayList list = new ArrayList();
    74. }
    75.  
    76.     @Test
    77.     public void testGetAnnotation() {
    78.         Class clazz = Student.class;
    79.         Annotation[] annotations = clazz.getAnnotations();
    80.         for (int i = 0; i < annotations.length; i++) {
    81.             System.out.println(annotations[i]);
    82.         }
    83.     }
    84. }
    85.  
    86. // jdk 8之前的写法：
    87. // @MyAnnotations({@MyAnnotation(value="hi"),@MyAnnotation(value="hi")})
    88. @MyAnnotation(value = "hi")
    89. @MyAnnotation(value = "abc")
    90. class Person {
    91.     private String name;
    92.     private int age;
    93.  
    94.     public Person() {
    95.     }
    96.  
    97.     @MyAnnotation
    98.     public Person(String name, int age) {
    99.         this.name = name;
    100.         this.age = age;
    101.     }
    102.  
    103.     @MyAnnotation
    104.     public void walk() {
    105.         System.out.println("人走路");
    106.     }
    107.  
    108.     public void eat() {
    109.         System.out.println("人吃饭");
    110.     }
    111. }
    112.  
    113. interface Info {
    114.     void show();
    115. }
    116.  
    117. class Student extends Person implements Info {
    118.  
    119.     @Override
    120.     public void walk() {
    121.         System.out.println("学生走路");
    122.     }
    123.  
    124.     public void show() {
    125.  
    126.     }
    127. }
    128.  
    129. class Generic<@MyAnnotation T> {
    130.     public void show() throws @MyAnnotation RuntimeException {
    131.         ArrayList<@MyAnnotation String> list = new ArrayList<>();
    132.         int num = (@MyAnnotation int) 10L;
    133.     }
    134. }

    结语

    本人会持续更新文章的哦！希望大家一键三连，你们的鼓励就是作者不断更新的动力

  • 相关阅读:
    多样性和VE的进化
    C#集成ViewFaceCore人脸检测识别库
    机器学习笔记之高斯混合模型(三)EM算法求解高斯混合模型(E步操作)
    个人编程笔记 - 子类和父类有同名的成员？
    海外媒体发稿：葡萄牙-实现高效媒体软文发稿计划-大舍传媒
    计算机毕业设计ssm基于SSM框架的网上订餐系统r1u1u系统+程序+源码+lw+远程部署
    《银行法律法规》三、银行管理——4、资本管理
    什么是Nacos及实战使用教程
    差值结构表达的吸引能
    python基础语法-类与对象（简单实用）
  • 原文地址：https://blog.csdn.net/qq_34025246/article/details/128052284