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

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

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

一.注解的概念

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

相关推荐

MySQL进阶五之自动读写分离mysql-proxy

自动读写分离目前,大量现网用户的业务场景中存在读多写少、业务负载无法预测等情况,在有大量读请求的应用场景下,单个实例可能无法承受读取压力,甚至会对业务产生影响。为了实现读取能力的弹性扩展,分担数据库压...

Postgres vs MySQL_vs2022连接mysql数据库

...

3分钟短文 | Laravel SQL筛选两个日期之间的记录,怎么写?

引言今天说一个细分的需求,在模型中,或者使用laravel提供的EloquentORM功能,构造查询语句时,返回位于两个指定的日期之间的条目。应该怎么写?本文通过几个例子,为大家梳理一下。学习时...

一文由浅入深带你完全掌握MySQL的锁机制原理与应用

本文将跟大家聊聊InnoDB的锁。本文比较长,包括一条SQL是如何加锁的,一些加锁规则、如何分析和解决死锁问题等内容,建议耐心读完,肯定对大家有帮助的。为什么需要加锁呢?...

验证Mysql中联合索引的最左匹配原则

后端面试中一定是必问mysql的,在以往的面试中好几个面试官都反馈我Mysql基础不行,今天来着重复习一下自己的弱点知识。在Mysql调优中索引优化又是非常重要的方法,不管公司的大小只要后端项目中用到...

MySQL索引解析(联合索引/最左前缀/覆盖索引/索引下推)

目录1.索引基础...

你会看 MySQL 的执行计划(EXPLAIN)吗?

SQL执行太慢怎么办?我们通常会使用EXPLAIN命令来查看SQL的执行计划,然后根据执行计划找出问题所在并进行优化。用法简介...

MySQL 从入门到精通(四)之索引结构

索引概述索引(index),是帮助MySQL高效获取数据的数据结构(有序),在数据之外,数据库系统还维护者满足特定查询算法的数据结构,这些数据结构以某种方式引用(指向)数据,这样就可以在这些数据结构...

mysql总结——面试中最常问到的知识点

mysql作为开源数据库中的榜一大哥,一直是面试官们考察的重中之重。今天,我们来总结一下mysql的知识点,供大家复习参照,看完这些知识点,再加上一些边角细节,基本上能够应付大多mysql相关面试了(...

mysql总结——面试中最常问到的知识点(2)

首先我们回顾一下上篇内容,主要复习了索引,事务,锁,以及SQL优化的工具。本篇文章接着写后面的内容。性能优化索引优化,SQL中索引的相关优化主要有以下几个方面:最好是全匹配。如果是联合索引的话,遵循最...

MySQL基础全知全解!超详细无废话!轻松上手~

本期内容提醒:全篇2300+字,篇幅较长,可搭配饭菜一同“食”用,全篇无废话(除了这句),干货满满,可收藏供后期反复观看。注:MySQL中语法不区分大小写,本篇中...

深入剖析 MySQL 中的锁机制原理_mysql 锁详解

在互联网软件开发领域,MySQL作为一款广泛应用的关系型数据库管理系统,其锁机制在保障数据一致性和实现并发控制方面扮演着举足轻重的角色。对于互联网软件开发人员而言,深入理解MySQL的锁机制原理...

Java 与 MySQL 性能优化:MySQL分区表设计与性能优化全解析

引言在数据库管理领域,随着数据量的不断增长,如何高效地管理和操作数据成为了一个关键问题。MySQL分区表作为一种有效的数据管理技术,能够将大型表划分为多个更小、更易管理的分区,从而提升数据库的性能和可...

MySQL基础篇:DQL数据查询操作_mysql 查

一、基础查询DQL基础查询语法SELECT字段列表FROM表名列表WHERE条件列表GROUPBY分组字段列表HAVING分组后条件列表ORDERBY排序字段列表LIMIT...

MySql:索引的基本使用_mysql索引的使用和原理

一、索引基础概念1.什么是索引?索引是数据库表的特殊数据结构(通常是B+树),用于...