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

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

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

一.注解的概念

/**  注解是一种能被添加到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.权限控制

相关推荐

redis的八种使用场景

前言:redis是我们工作开发中,经常要打交道的,下面对redis的使用场景做总结介绍也是对redis举报的功能做梳理。缓存Redis最常见的用途是作为缓存,用于加速应用程序的响应速度。...

基于Redis的3种分布式ID生成策略

在分布式系统设计中,全局唯一ID是一个基础而关键的组件。随着业务规模扩大和系统架构向微服务演进,传统的单机自增ID已无法满足需求。高并发、高可用的分布式ID生成方案成为构建可靠分布式系统的必要条件。R...

基于OpenWrt系统路由器的模式切换与网页设计

摘要:目前商用WiFi路由器已应用到多个领域,商家通过给用户提供一个稳定免费WiFi热点达到吸引客户、提升服务的目标。传统路由器自带的Luci界面提供了工厂模式的Web界面,用户可通过该界面配置路...

这篇文章教你看明白 nginx-ingress 控制器

主机nginx一般nginx做主机反向代理(网关)有以下配置...

如何用redis实现注册中心

一句话总结使用Redis实现注册中心:服务注册...

爱可可老师24小时热门分享(2020.5.10)

No1.看自己以前写的代码是种什么体验?No2.DooM-chip!国外网友SylvainLefebvre自制的无CPU、无操作码、无指令计数器...No3.我认为CS学位可以更好,如...

Apportable:拯救程序员,IOS一秒变安卓

摘要:还在为了跨平台使用cocos2d-x吗,拯救objc程序员的奇葩来了,ApportableSDK:FreeAndroidsupportforcocos2d-iPhone。App...

JAVA实现超买超卖方案汇总,那个最适合你,一篇文章彻底讲透

以下是几种Java实现超买超卖问题的核心解决方案及代码示例,针对高并发场景下的库存扣减问题:方案一:Redis原子操作+Lua脚本(推荐)//使用Redis+Lua保证原子性publicbo...

3月26日更新 快速施法自动施法可独立设置

2016年3月26日DOTA2有一个79.6MB的更新主要是针对自动施法和快速施法的调整本来内容不多不少朋友都有自动施法和快速施法的困扰英文更新日志一些视觉BUG修复就不翻译了主要翻译自动施...

Redis 是如何提供服务的

在刚刚接触Redis的时候,最想要知道的是一个’setnameJhon’命令到达Redis服务器的时候,它是如何返回’OK’的?里面命令处理的流程如何,具体细节怎么样?你一定有问过自己...

lua _G、_VERSION使用

到这里我们已经把lua基础库中的函数介绍完了,除了函数外基础库中还有两个常量,一个是_G,另一个是_VERSION。_G是基础库本身,指向自己,这个变量很有意思,可以无限引用自己,最后得到的还是自己,...

China&#39;s top diplomat to chair third China-Pacific Island countries foreign ministers&#39; meeting

BEIJING,May21(Xinhua)--ChineseForeignMinisterWangYi,alsoamemberofthePoliticalBureau...

移动工作交流工具Lua推出Insights数据分析产品

Lua是一个适用于各种职业人士的移动交流平台,它在今天推出了一项叫做Insights的全新功能。Insights是一个数据平台,客户可以在上面实时看到员工之间的交流情况,并分析这些情况对公司发展的影响...

Redis 7新武器:用Redis Stack实现向量搜索的极限压测

当传统关系型数据库还在为向量相似度搜索的性能挣扎时,Redis7的RedisStack...

Nginx/OpenResty详解,Nginx Lua编程,重定向与内部子请求

重定向与内部子请求Nginx的rewrite指令不仅可以在Nginx内部的server、location之间进行跳转,还可以进行外部链接的重定向。通过ngx_lua模块的Lua函数除了能实现Nginx...