百度360必应搜狗淘宝本站头条
当前位置:网站首页 > IT技术 > 正文

自定义注解_自定义注解如何生效

wptr33 2025-02-21 15:39 25 浏览

一.注解的概念

/**  注解是一种能被添加到java代码中的元数据,
*    类、方法、变量、参数和包都可以用注解来修饰。
*    注解对于它所修饰的代码并没有直接的影响。 
**/
An annotation is a form of metadata, that can be added to Java source code. Classes, methods, variables, parameters and packages may be annotated. Annotations have no direct effect on the operation of the code they annotate.

说明:

  1. 注解是一种元数据形式。即注解是属于java的一种数据类型,和类、接口、数组、枚举类似。
  2. 注解用来修饰,类、方法、变量、参数、包。
  3. 注解不会对所修饰的代码产生直接的影响

二.注解的声明

1.定义注解:

自定义注解的语法,使用关键字@interface标识,在底层实现上,所有定义的注解都会自动继承
java.lang.annotation.Annotation接口:

@Target() 
@Retention() 
@Documented 
@Inherited
public @interface AnnotationName{

}

@Target 用于定义在注解上边,表明该注解可以使用的范围,如该@Target未指定value,表明该注解可以用于任何范围。查看源码如下:

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
    /**
     * Returns an array of the kinds of elements an annotation type
     * can be applied to.
     * @return an array of the kinds of elements an annotation type
     * can be applied to
     */
    ElementType[] value();
}

可以看出,ElementType是一个数组类型的,可以选一个或者多个,如果是多个的情况下,用逗号分割开。继续点开ElementType查看源码如下:

public enum ElementType {
    /** Class, interface (including annotation type), or enum declaration 
    * 表明此注解可以用在类、接口(包括注释类型)或枚举声明
    */
    TYPE,

    /** Field declaration (includes enum constants) 
    * 该注解可以用于属性包括枚举常量
    */
    FIELD,

    /** Method declaration
    * 该注解可以用于方法上
    */
    METHOD,

    /** Formal parameter declaration 
    * 该注解可以用于参数
    */
    PARAMETER,

    /** Constructor declaration 
    * 该注解可以用于构造器上
    */
    CONSTRUCTOR,

    /** Local variable declaration 
    * 该注解可以用于本地变量
    */
    LOCAL_VARIABLE,

    /** Annotation type declaration 
    * 该注解可以用于注解
    */
    ANNOTATION_TYPE,

    /** Package declaration 
    * 该注解可以用于包类型,用于记录java文件的package文件信息,
                   不使用在一般的类中,而用在固定文件package-info.java中。
                   注意命名一定是“package-info”。
                   由于package- info.java并不是一个合法的类,
                  使用eclipse创建类的方式会提示不合法,所以需要以创建
                  文件的方式来创建package-info.java
    */
    PACKAGE,

    /**
     * Type parameter declaration
     * 该注解可以用于类型参数生命
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * Use of a type
     * 该注解可以用于类型使用生命
     * @since 1.8
     */
    TYPE_USE
}

@Retention() 的作用:定义被它所注解的注解保留多久,一共有三种,查看源码如下:

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
    /**
     * Returns the retention policy.
     * @return the retention policy
     */
    RetentionPolicy value();
}

再继续查看RetentionPolicy源码如下:

public enum RetentionPolicy {
    /**
     * Annotations are to be discarded by the compiler.
     * 注解被保留在编译器中,当Java文件别编译成class文件的时候,注解被遗弃,被编译器忽略
     */
    SOURCE,

    /**
     * Annotations are to be recorded in the class file by the compiler
     * but need not be retained by the VM at run time.  This is the default
     * behavior.
     * 注解被保留在clas文件中,但jvm加载class文件时被遗弃,这是默认的生命周期
     */
    CLASS,

    /**
     * Annotations are to be recorded in the class file by the compiler and
     * retained by the VM at run time, so they may be read reflectively.
     * 注解不仅被保留在class文件中,而且虚拟机在加载class文件后,仍然存在
     * @see java.lang.reflect.AnnotatedElement
     */
    RUNTIME
}

这3个生命周期分别对应于:Java源文件(.java文件) ---> .class文件 ---> 内存中的字节码。

那怎么来选择合适的注解生命周期呢?

首先要明确生命周期长度 SOURCE < CLASS < RUNTIME ,所以前者能作用的地方后者一定也能作用。一般如果需要在运行时去动态获取注解信息,那只能用 RUNTIME 注解;如果要在编译时进行一些预处理操作,比如生成一些辅助代码(如 ButterKnife,就用 CLASS注解;如果只是做一些检查性的操作,比如 @Override@SuppressWarnings,则可选用 SOURCE 注解。

@Documented的作用:用来指定自定义注解是否能随被定义的java文件生成到javadoc文档中,查看源码如下:

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Documented {
}

@Inherited,是指定某个自定义注解如果写在了父类的声明部分,那么子类的声明部分也能自动拥有该注解。@Inherited注解只对那些@Target被定义为ElementType.TYPE的自定义注解起作用。查看源码如下:

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Inherited {
}

定义注解类型元素时需要注意如下几点:

1、访问修饰符必须为public,不写默认为public;

2、该元素的类型只能是基本数据类型、String、Class、枚举类型、注解类型(体现了注解的嵌套效果)以及上述类型的一位数组;

3、该元素的名称一般定义为名词,如果注解中只有一个元素,请把名字起为value(后面使用会带来便利操作);

4、()不是定义方法参数的地方,也不能在括号中定义任何参数,仅仅只是一个特殊的语法;

5、default代表默认值,值必须和第2点定义的类型一致;

6、如果没有默认值,代表后续使用注解时必须给该类型元素赋值

特殊用法:

1.如果注解本身没有注解类型元素,那么在使用注解时可以省略(),直接写@注解名,它和标准语法@注解名()等效

2.如果注解本身只有一个注解类型元素,且名称为value,那么在使用注解时可以直接用:@注解名(),其等效于@注解名(value=XXX)

3.如果注解中,注解元素的类型是数组,在使用时,注解元素需要传入的值只有一个时,可以使用@注解名(类型名=XXX),他的语法和@注解名(类型名={XXX})是一样的

注解的定义,

三.注解声明样例

注解的定义

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SysLog {

    String value() default "";
}

注解的使用

@SysLog("测试")
@PostMapping("/testQuery")
@ResponseBody
public Map testQuery(@RequestBody  TestReqBO testReqBO){
    return testService.testQuery(testReqBO);
}

四.注解使用场景

1.结合AOP,完成日志记录

2.权限控制

相关推荐

Python自动化脚本应用与示例(python办公自动化脚本)

Python是编写自动化脚本的绝佳选择,因其语法简洁、库丰富且跨平台兼容性强。以下是Python自动化脚本的常见应用场景及示例,帮助你快速上手:一、常见自动化场景文件与目录操作...

Python文件操作常用库高级应用教程

本文是在前面《Python文件操作常用库使用教程》的基础上,进一步学习Python文件操作库的高级应用。一、高级文件系统监控1.1watchdog库-实时文件系统监控安装与基本使用:...

Python办公自动化系列篇之六:文件系统与操作系统任务

作为高效办公自动化领域的主流编程语言,Python凭借其优雅的语法结构、完善的技术生态及成熟的第三方工具库集合,已成为企业数字化转型过程中提升运营效率的理想选择。该语言在结构化数据处理、自动化文档生成...

14《Python 办公自动化教程》os 模块操作文件与文件夹

在日常工作中,我们经常会和文件、文件夹打交道,比如将服务器上指定目录下文件进行归档,或将爬虫爬取的数据根据时间创建对应的文件夹/文件,如果这些还依靠手动来进行操作,无疑是费时费力的,这时候Pyt...

python中os模块详解(python os.path模块)

os模块是Python标准库中的一个模块,它提供了与操作系统交互的方法。使用os模块可以方便地执行许多常见的系统任务,如文件和目录操作、进程管理、环境变量管理等。下面是os模块中一些常用的函数和方法:...

21-Python-文件操作(python文件的操作步骤)

在Python中,文件操作是非常重要的一部分,它允许我们读取、写入和修改文件。下面将详细讲解Python文件操作的各个方面,并给出相应的示例。1-打开文件...

轻松玩转Python文件操作:移动、删除

哈喽,大家好,我是木头左!Python文件操作基础在处理计算机文件时,经常需要执行如移动和删除等基本操作。Python提供了一些内置的库来帮助完成这些任务,其中最常用的就是os模块和shutil模块。...

Python 初学者练习:删除文件和文件夹

在本教程中,你将学习如何在Python中删除文件和文件夹。使用os.remove()函数删除文件...

引人遐想,用 Python 获取你想要的“某个人”摄像头照片

仅用来学习,希望给你们有提供到学习上的作用。1.安装库需要安装python3.5以上版本,在官网下载即可。然后安装库opencv-python,安装方式为打开终端输入命令行。...

Python如何使用临时文件和目录(python目录下文件)

在某些项目中,有时候会有大量的临时数据,比如各种日志,这时候我们要做数据分析,并把最后的结果储存起来,这些大量的临时数据如果常驻内存,将消耗大量内存资源,我们可以使用临时文件,存储这些临时数据。使用标...

Linux 下海量文件删除方法效率对比,最慢的竟然是 rm

Linux下海量文件删除方法效率对比,本次参赛选手一共6位,分别是:rm、find、findwithdelete、rsync、Python、Perl.首先建立50万个文件$testfor...

Python 开发工程师必会的 5 个系统命令操作库

当我们需要编写自动化脚本、部署工具、监控程序时,熟练操作系统命令几乎是必备技能。今天就来聊聊我在实际项目中高频使用的5个系统命令操作库,这些可都是能让你效率翻倍的"瑞士军刀"。一...

Python常用文件操作库使用详解(python文件操作选项)

Python生态系统提供了丰富的文件操作库,可以处理各种复杂的文件操作需求。本教程将介绍Python中最常用的文件操作库及其实际应用。一、标准库核心模块1.1os模块-操作系统接口主要功能...

11. 文件与IO操作(文件io和网络io)

本章深入探讨Go语言文件处理与IO操作的核心技术,结合高性能实践与安全规范,提供企业级解决方案。11.1文件读写11.1.1基础操作...

Python os模块的20个应用实例(python中 import os模块用法)

在Python中,...