注解

  • 一、注解概述
  • (1)注释的概念
  • (2)注解的概念
  • (3)注解的完整定义
  • (4)作用的分类
  • ①编写文档:通过代码里标识的注解生成文档【生成文档doc文档】
  • ②代码分析:通过代码里标识的注解对代码进行分析【使用反射】
  • ③编译检查:通过代码里标识的注解让编译器能够实现基本的编译检查【Override】
  • 二、JDK中预定义的一些注解
  • (1)@Override
  • (2)@Deprecated
  • (3)@SuppressWarnings
  • 三、自定义注解
  • (1)自定义注解的格式
  • (2)自定义注解的本质
  • (3)自定义注解的属性
  • (4)自定义注解的要求
  • ①属性的返回值类型有下列取值
  • ②定义了属性,在使用时需要给属性赋值
  • 四、元注解:用于描述注解的注解
  • 五、在程序使用(解析)注解:获取注解中定义的属性值
  • (1)案例需求
  • (2)步骤
  • (3)具体实现


一、注解概述

(1)注释的概念

  • 用文字描述程序的。给程序员看的

(2)注解的概念

  • 说明程序的,给计算机看的

(3)注解的完整定义

  • 注解(Annotation),也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性,与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面,用来对这些元素进行说明,注释。

(4)作用的分类

①编写文档:通过代码里标识的注解生成文档【生成文档doc文档】

例如下方一个简单的方法:

java注解实现站内消息发送 javaweb注解_自定义注解


我们将类复制一份

java注解实现站内消息发送 javaweb注解_自定义注解_02


并将其粘贴到随意一个文件夹中

java注解实现站内消息发送 javaweb注解_java_03


右键单击此文件选择在终端中打开

java注解实现站内消息发送 javaweb注解_开发语言_04


java注解实现站内消息发送 javaweb注解_java注解实现站内消息发送_05


输入javadoc AnnoDemo01.java并回车

java注解实现站内消息发送 javaweb注解_学习_06


然后就抽取出了许多信息

java注解实现站内消息发送 javaweb注解_java_07


点开其中的index.html

java注解实现站内消息发送 javaweb注解_java注解实现站内消息发送_08


点击Annotation01,就可以看见注解javadoc演示啦~

java注解实现站内消息发送 javaweb注解_学习_09


java注解实现站内消息发送 javaweb注解_开发语言_10

②代码分析:通过代码里标识的注解对代码进行分析【使用反射】
③编译检查:通过代码里标识的注解让编译器能够实现基本的编译检查【Override】

例如重写toString方法

java注解实现站内消息发送 javaweb注解_自定义注解_11


当把方法名由toString改为toStrin1时,就会报错,显示没有重写父类方法,即进行了编译检查

java注解实现站内消息发送 javaweb注解_学习_12


java注解实现站内消息发送 javaweb注解_java注解实现站内消息发送_13

二、JDK中预定义的一些注解

(1)@Override

  • 检测被该注解标注的方法是否是继承自父类(接口)的

(2)@Deprecated

  • 该注解标注的内容,表示已过时


    但@Override标注的方法虽然过时,但仍然可以正常使用
    除了我们自己标注的,还有好多的方法都已经过时了,例如:

(3)@SuppressWarnings

  • 压制警告
  • 一般传递参数all @SuppressWarnings(“all”)

例如:show2方法,原先是有警告的,显示未被使用

java注解实现站内消息发送 javaweb注解_开发语言_14


标注@SuppressWarnings(“all”)后就不警告了

java注解实现站内消息发送 javaweb注解_自定义注解_15

三、自定义注解

(1)自定义注解的格式

元注解
		public @interface 注解名称{
			属性列表;
		}

java注解实现站内消息发送 javaweb注解_学习_16


java注解实现站内消息发送 javaweb注解_java注解实现站内消息发送_17

(2)自定义注解的本质

  • 注解本质上就是一个接口,该接口默认继承Annotation接口
  • public interface MyAnno extends java.lang.annotation.Annotation {}

(3)自定义注解的属性

  • 接口中的抽象方法

(4)自定义注解的要求

①属性的返回值类型有下列取值
  • 基本数据类型
  • String
  • 枚举
  • 注解
  • 以上类型的数组

②定义了属性,在使用时需要给属性赋值
  • 如果定义属性时,使用default关键字给属性默认初始化值,则使用注解时,可以不进行属性的赋值。
  • java注解实现站内消息发送 javaweb注解_java注解实现站内消息发送_18


  • java注解实现站内消息发送 javaweb注解_开发语言_19

  • 如果只有一个属性需要赋值,并且属性的名称是value,则value可以省略,直接定义值即可。
  • java注解实现站内消息发送 javaweb注解_学习_20


  • java注解实现站内消息发送 javaweb注解_java注解实现站内消息发送_21

  • 数组赋值时,值使用{ }包裹。如果数组中只有一个值,则{ }可以省略
  • java注解实现站内消息发送 javaweb注解_java注解实现站内消息发送_22


  • java注解实现站内消息发送 javaweb注解_java注解实现站内消息发送_23

四、元注解:用于描述注解的注解

  • @Target:描述注解能够作用的位置
  • ElementType取值:
  • TYPE:可以作用于类上
  • METHOD:可以作用于方法上
  • FIELD:可以作用于成员变量上
  • @Retention:描述注解被保留的阶段
  • @Retention(RetentionPolicy.RUNTIME):当前被描述的注解,会保留到class字节码文件中,并被JVM读取到
  • @Documented:描述注解是否被抽取到api文档中
  • @Inherited:描述注解是否被子类继承

java注解实现站内消息发送 javaweb注解_学习_24

五、在程序使用(解析)注解:获取注解中定义的属性值

(1)案例需求

写一个"框架",不能改变该类的任何代码的前提下,可以帮我们创建任意类的对象,并且执行其中任意方法

(2)步骤

  1. 获取注解定义的位置的对象 (Class,Method,Field)
  2. 获取指定的注解 getAnnotation(Class)
  • 其实就是在内存中生成了一个该注解接口的子类实现对象
public class ProImpl implements Pro{
              public String className(){
                  return "cn.itcast.annotation.Demo1";
              }
              public String methodName(){
                  return "show";
              }
          }
  1. 调用注解中的抽象方法获取配置的属性值

(3)具体实现

java注解实现站内消息发送 javaweb注解_自定义注解_25


java注解实现站内消息发送 javaweb注解_自定义注解_26


java注解实现站内消息发送 javaweb注解_java_27


java注解实现站内消息发送 javaweb注解_java注解实现站内消息发送_28


java注解实现站内消息发送 javaweb注解_自定义注解_29

public class Demo1 {
    public void show(){
        System.out.println("Demo1...show...");
    }
}
public class Demo2 {
    public void show(){
        System.out.println("Demo2...show...");
    }
}
/**
 * 描述需要执行的类名,和方法名
 */

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

    String className();//代表了一套规范
    String methodName();
}
/**
 * 框架类
 */


@Pro(className = "Annotation01.Demo1",methodName = "show")
public class ReflectTest {
    public static void main(String[] args) throws Exception {

        /*
            前提:不能改变该类的任何代码。可以创建任意类的对象,可以执行任意方法
         */


        //1.解析注解
        //1.1获取该类的字节码文件对象
        Class<ReflectTest> reflectTestClass = ReflectTest.class;
        //2.获取上边的注解对象
        //其实就是在内存中生成了一个该注解接口的子类实现对象
        /*

            public class ProImpl implements Pro{
                public String className(){
                    return "Annotation01.Demo1";
                }
                public String methodName(){
                    return "show";
                }

            }
 */

        Pro an = reflectTestClass.getAnnotation(Pro.class);
        //3.调用注解对象中定义的抽象方法,获取返回值
        String className = an.className();
        String methodName = an.methodName();
        System.out.println(className);
        System.out.println(methodName);





        //3.加载该类进内存
        Class cls = Class.forName(className);
        //4.创建对象
        Object obj = cls.newInstance();
        //5.获取方法对象
        Method method = cls.getMethod(methodName);
        //6.执行方法
        method.invoke(obj);
    }
}