java中的注解Annotation

Posted 2021-05-13 一乐乐

java中的注解Annotation

目录：

1，概念

2，关于注解~作用

3，java 注解格式

4，注解的分类

　　1）按照运行机制划分

　　2）按照来源划分

　　3）元注解

5，Java内置注解

　   @Override
　   @Deprecated
　   @SuppressWarnnings

6，自定义注解

　　✿ 语法

　　✿自定义注解在实际中小例子：

　　✿定义注解中的属性

 

 

 

1，概念：　Annotation（注解）就是Java提供了一种元程序中的元素关联任何信息和着任何元数据（metadata）的途径和方法。Annotion(注解)是一个接口，程序可以通过反射来获取指定程序元素的Annotion对象，然后通过Annotion对象来获取注解里面的元数据。注解本质是一个接口，该接口默认继承 java.lang.annotation.Annotation 接口。注解中的属性是抽象方法。

 

2，关于注解：

✿注解本身不起作用，起作用的是注解解释器，注解需要和反射一起使用才能发挥大的威力。（通过反射获取注解信息）在Java技术里注解的典型应用是：可以通过反射技术去得到类里面的注解，以决定怎么去运行类。（ps: 注解并不会自己生效（因为注解是接口）。必须通过某些程序或者是注解器或者是某些工具来获取并处理注解。例如，通过反射获取。）

①    生成文档。这是最常见的，也是java 最早提供的注解。常用的有@see @param @return 等；

② 跟踪代码依赖性，实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。作用就是减少配置。现在的框架基本都使用了这种配置来减少配置文件的数量；

③ 标记检查，在编译时进行格式检查。如@Override放在方法前，如果你这个方法并不是覆盖了超类方法，则编译时就能检查出；

④编译时和部署时处理ーー软件工具可以处理注释信息以生成代码、 XML 文件等等。

3，java 注解格式：以@ 作为标志的格式为：@+自定义字符串

 

4，注解的分类

1）按照运行机制划分：
【源码注解→编译时注解→运行时注解】

源码注解：只在源码中存在，编译成.class文件就不存在了。

编译时注解：在源码和.class文件中都存在。像前面的@Override、@Deprecated、@SuppressWarnings，他们都属于编译时注解。

运行时注解：在运行阶段还起作用，甚至会影响运行逻辑的注解。像@Autowired自动注入的这样一种注解就属于运行时注解，它会在程序运行的时候把你的成员变量自动的注入进来。

2）按照来源划分：
【来自JDK的注解——来自第三方的注解——自定义注解】

3）元注解：
元注解是给注解进行注解，可以理解为注解的注解就是元注解。

 

元注解？

简单的来说就是注解的注解就是元注解，它主要用来标识你写的注解保留范围（作用范围）以及出现的位置。对于自定义注解接口的执行，需要有元注解才能解释注解。

JDK中定义了四种元注解：

@Retention：注解的保留范围，是个枚举，有如下可选值

        RetentionPolicy.SOURCE:注解存在于源文件中

        RetentionPolicy.CLASS:注解存在于源字节码文件中

        RetentionPolicy.RUNTIME:注解存在于运行时

@Target：注解出现的位置(比如字段上、方法上等等)，也是个枚举，有如下可选值

　　ElementType.ANNOTATION _ type 应用于注释类型。

　　ElementType.CONSTRUCTOR 应用于构造函数。

　　ElementType.FIELD 应用于字段或属性。

　　ElementType.LOCAL_VARIABLE 应用于局部变量。

　　ElementType.METHOD应用于方法级注释。

　　ElementType.PACKAGE 应用于包声明。

　　ElementType.PARAMETER 应用于方法的参数。

　　ElementType.TYPE应用于类的任何元素。

@Documented: 用于指定被该元 Annotation 修饰的 Annotation 类将被 javadoc 工具提取成文档.

@Inherited: 被它修饰的 Annotation 将具有继承性.如果某个类使用了被 @Inherited 修饰的 Annotation, 则其子类将自动具有该注解

 

5，Java内置注解：

　@Override：用于修饰此方法覆盖了父类的方法;
　@Deprecated：用于修饰已经过时的方法;
　@SuppressWarnnings:用于通知java编译器禁止特定的编译警告。

 

6，自定义注解：

✿ 语法：

声明一个注解要用到的东西

• 修饰符
    访问修饰符必须为public,不写默认为pubic；
• 关键字
    关键字为@interface；
• 注解名称
    注解名称为自定义注解的名称；
• 注解类型元素
    注解类型元素是注解中内容，可以理解成自定义接口的实现部分；

代码示例：

public @interface Info {

    String value() default "tracy";

    boolean isDelete();

}

✿自定义注解在实际中小例子：

例如要求书写的类带上作者、时间、版本等信息，那么可能张三使用注释的方式，李四使用文档注释的方式，王五使用注解的方式，每一个人的写法和顺序可能都不一样。----leader 直接定义一个注解 @interface 

 

✿定义注解中的属性：

基本形式：类型属性名称();    比如：String name();

特别注意：

（1）属性值后边有一个括号！！！这个是和之前定义属性不一样的地方

（2）注解的属性的类型只能是：基本类型、String、Class、枚举、注解类型及以上类型的一维数组。

（3）默认值的关键字是default。

   

代码：

@Retention(RetentionPolicy.RUNTIME)

@Target(ElementType.METHOD)

public @interface MyAnnotation {

    String value() default "abc";

    String name() default "zhangsan";

}

注解属性定义完以后，使用注解：@MyAnnotation(value = "123",name = "lisi")

举例：使用注解

public class Test {

    @MyAnnotation(value = "123",name = "lisi")

    public static void test(){

        System.out.println("这是test");

    }

}

举例：利用反射获取方法上的注解，并获取对应的值

public class Test {

    public static void main(String[] args) throws Exception {

       Class clazz = Class.forName("com.fours.intercepter.Test");

        Method[] ms = clazz.getMethods();

        for (Method m : ms) {

            if(m.isAnnotationPresent(MyAnnotation.class)){

                String value = m.getAnnotation(MyAnnotation.class).value();

                String name = m.getAnnotation(MyAnnotation.class).name();

                System.out.println("value:"+value);

                System.out.println("name:"+name);

            }

        }

    }

    @MyAnnotation(value = "123",name = "lisi")

    public static void test(){

        System.out.println("这是test");

    }

}

参考自：

https://blog.csdn.net/ju_362204801/article/details/90697479  《Java中的注解以及自定义注解》

https://blog.csdn.net/u013703461/article/details/66259013    《Annotation详解》

https://blog.csdn.net/li_xiao_ming/article/details/90692900    《Java注解的作用》

https://blog.csdn.net/zt15732625878/article/details/100061528   《Java实现自定义注解》