Java 注解(Annotation)(上)

news2025/1/12 22:48:48

Java 注解(Annotation

Java 语言中的类、方法、变量、参数和包等都可以被标注。和 Javadoc 不同,Java 标注可以通过反射获取标注内容。在编译器生成类文件时,标注可以被嵌入到字节码中。Java 虚拟机可以保留标注内容,在运行时可以获取到标注内容。当然它也支持自定义 Java 标注。

内置的注解

Java 定义了一套注解,共有 7 个,3 个在 java.lang 中,剩下 4 个在 java.lang.annotation 中。

作用在代码的注解是

  • @Override - 检查该方法是否是重写方法。如果发现其父类,或者是引用的接口中并没有该方法时,会报编译错误。
  • @Deprecated - 标记过时方法。如果使用该方法,会报编译警告。
  • @SuppressWarnings - 指示编译器去忽略注解中声明的警告。

作用在其他注解的注解(或者说 元注解):

  • @Retention(保持,维持) - 标识这个注解怎么保存,是只在代码中,还是编入class文件中,或者是在运行时可以通过反射访问。
  • @Documented - 标记这些注解是否包含在用户文档中。
  • @Target - 标记这个注解应该是哪种 Java 成员。
  • @Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)

Java 7 开始,额外添加了 3 个注解:

  • @SafeVarargs - Java 7 开始支持,忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。
  • @FunctionalInterface - Java 8 开始支持,标识一个匿名函数或函数式接口。
  • @Repeatable - Java 8 开始支持,标识某注解可以在同一个声明上使用多次。

1Annotation 架构

从中,我们可以看出:

(01) 1 Annotation 1 RetentionPolicy 关联。

可以理解为:每1Annotation对象,都会有唯一的RetentionPolicy属性。

(02) 1 Annotation 1~n ElementType 关联。

可以理解为:对于每 1 Annotation 对象,可以有若干个 ElementType 属性。

(03) Annotation 有许多实现类,包括:Deprecated, Documented, Inherited, Override 等等。

Annotation 的每一个实现类,都 " 1 RetentionPolicy 关联" 并且 " 1~n ElementType 关联"

下面,我先介绍框架图的左半边(如下图),即 Annotation, RetentionPolicy, ElementType;然后在就 Annotation 的实现类进行举例说明。

2Annotation 组成部分

java Annotation 的组成中,有 3 个非常重要的主干类。它们分别是:

Annotation.java

package java.lang.annotation;
public interface Annotation {

    boolean equals(Object obj);

    int hashCode();

    String toString();

    Class<? extends Annotation> annotationType();
}

ElementType.java

package java.lang.annotation;

public enum ElementType {
    TYPE,               /* 类、接口(包括注释类型)或枚举声明  */

    FIELD,              /* 字段声明(包括枚举常量)  */

    METHOD,             /* 方法声明  */

    PARAMETER,          /* 参数声明  */

    CONSTRUCTOR,        /* 构造方法声明  */

    LOCAL_VARIABLE,     /* 局部变量声明  */

    ANNOTATION_TYPE,    /* 注释类型声明  */

    PACKAGE             /* 包声明  */
}

RetentionPolicy.java

package java.lang.annotation;
public enum RetentionPolicy {
    SOURCE,            /* Annotation信息仅存在于编译器处理期间,编译器处理完之后就没有该Annotation信息了  */

    CLASS,             /* 编译器将Annotation存储于类对应的.class文件中。默认行为  */

    RUNTIME            /* 编译器将Annotation存储于class文件中,并且可由JVM读入 */
}

说明:

(01) Annotation 就是个接口。

" 1 Annotation" 都与 "1 RetentionPolicy" 关联,并且与 "1n ElementType" 关联。可以通俗的理解为:每 1 Annotation 对象,都会有唯一的 RetentionPolicy 属性;至于 ElementType 属性,则有 1~n 个。

(02) ElementType Enum 枚举类型,它用来指定 Annotation 的类型。

" 1 Annotation" 都与 "1n ElementType" 关联。当 Annotation 与某个 ElementType 关联时,就意味着:Annotation有了某种用途。例如,若一个 Annotation 对象是 METHOD 类型,则该 Annotation 只能用来修饰方法。

(03) RetentionPolicy Enum 枚举类型,它用来指定 Annotation 的策略。通俗点说,就是不同 RetentionPolicy 类型的 Annotation 的作用域不同。

" 1 Annotation" 都与 "1 RetentionPolicy" 关联。

  • a) Annotation 的类型为 SOURCE,则意味着:Annotation 仅存在于编译器处理期间,编译器处理完之后,该 Annotation 就没用了。 例如," @Override" 标志就是一个 Annotation。当它修饰一个方法的时候,就意味着该方法覆盖父类的方法;并且在编译期间会进行语法检查!编译器处理完后,"@Override" 就没有任何作用了。
  • b) Annotation 的类型为 CLASS,则意味着:编译器将 Annotation 存储于类对应的 .class 文件中,它是 Annotation 的默认行为。
  • c) Annotation 的类型为 RUNTIME,则意味着:编译器将 Annotation 存储于 class 文件中,并且可由JVM读入。

这时,只需要记住" 1 Annotation" 都与 "1 RetentionPolicy" 关联,并且与 "1n ElementType" 关联。学完后面的内容之后,再回头看这些内容,会更容易理解。

3java 自带的 Annotation

理解了上面的 3 个类的作用之后,我们接下来可以讲解 Annotation 实现类的语法定义了。

1Annotation 通用定义

@Documented

@Target(ElementType.TYPE)

@Retention(RetentionPolicy.RUNTIME)

public @interface MyAnnotation1 {

}

说明:

上面的作用是定义一个 Annotation,它的名字是 MyAnnotation1。定义了 MyAnnotation1 之后,我们可以在代码中通过 "@MyAnnotation1" 来使用它。 其它的,@Documented, @Target, @Retention, @interface 都是来修饰 MyAnnotation1 的。下面分别说说它们的含义:

(01) @interface

使用 @interface 定义注解时,意味着它实现了 java.lang.annotation.Annotation 接口,即该注解就是一个Annotation

定义 Annotation 时,@interface 是必须的。

注意:它和我们通常的 implemented 实现接口的方法不同。Annotation 接口的实现细节都由编译器完成。通过 @interface 定义注解后,该注解不能继承其他的注解或接口。

(02) @Documented

类和方法的 Annotation 在缺省情况下是不出现在 javadoc 中的。如果使用 @Documented 修饰该 Annotation,则表示它可以出现在 javadoc 中。

定义 Annotation 时,@Documented 可有可无;若没有定义,则 Annotation 不会出现在 javadoc 中。

(03) @Target(ElementType.TYPE)

前面我们说过,ElementType Annotation 的类型属性。而 @Target 的作用,就是来指定 Annotation 的类型属性。

@Target(ElementType.TYPE) 的意思就是指定该 Annotation 的类型是 ElementType.TYPE。这就意味着,MyAnnotation1 是来修饰"类、接口(包括注释类型)或枚举声明"的注解。

定义 Annotation 时,@Target 可有可无。若有 @Target,则该 Annotation 只能用于它所指定的地方;若没有 @Target,则该 Annotation 可以用于任何地方。

(04) @Retention(RetentionPolicy.RUNTIME)

前面我们说过,RetentionPolicy Annotation 的策略属性,而 @Retention 的作用,就是指定 Annotation 的策略属性。

@Retention(RetentionPolicy.RUNTIME) 的意思就是指定该 Annotation 的策略是 RetentionPolicy.RUNTIME。这就意味着,编译器会将该 Annotation 信息保留在 .class 文件中,并且能被虚拟机读取。

定义 Annotation 时,@Retention 可有可无。若没有 @Retention,则默认是 RetentionPolicy.CLASS

2java自带的Annotation

通过上面的示例,我们能理解:@interface 用来声明 Annotation@Documented 用来表示该 Annotation 是否会出现在 javadoc 中, @Target 用来指定 Annotation 的类型,@Retention 用来指定 Annotation 的策略。

理解这一点之后,我们就很容易理解 java 中自带的 Annotation 的实现类,即 Annotation 架构图的右半边。如下图:

@Controller和@RestController的区别?

@RestController注解相当于@ResponseBody @Controller合在一起的作用

1)如果只是使用@RestController注解Controller,则Controller中的方法无法返回jsp页面,配置的视图解析器InternalResourceViewResolver不起作用,返回的内容就是Return里的内容。

例如:本来应该到success.jsp页面的,则其显示success.

2)如果需要返回到指定页面,则需要用@Controller配合视图解析器InternalResourceViewResolver才行。
3)如果需要返回JSONXML或自定义mediaType内容到页面,则需要在对应的方法上加上@ResponseBody注解。

例如:

1.使用@Controller 注解

在对应的方法上,视图解析器可以解析return jsp,html页面,并且跳转到相应页面。若返回json等内容到页面,则需要加@ResponseBody注解

//Spring Boot跨域(@CrossOrigin)

@CrossOrigin

@Controller

public class FileUploadController {

//跳转到上传文件的页面

@RequestMapping(value="/gouploadimg", method = RequestMethod.GET)

public String goUploadImg() {

//跳转到 templates 目录下的 uploadimg.html

return "uploadimg";

}

//处理文件上传

@RequestMapping(value="/testuploadimg", method = RequestMethod.POST)

public @ResponseBody String uploadImg(@RequestParam("file") MultipartFile file,

HttpServletRequest request) {

System.out.println("调用文件上传方法");

String contentType = file.getContentType();

String fileName = file.getOriginalFilename();

  2.@RestController注解

相当于@Controller+@ResponseBody两个注解的结合,返回json数据不需要在方法前面加@ResponseBody注解了,但使用@RestController这个注解,就不能返回jsp,html页面,视图解析器无法解析jsp,html页面

@CrossOrigin

@RestController /* @Controller + @ResponseBody*/

public class HospitalController {

    //注入Service服务对象

    @Autowired

    private HospitalService hospitalService;

    /**

     * 查询所有医院信息(未分页)

     */

    @RequestMapping(value = "findAllHospital",method = RequestMethod.GET)

    public  List<Hospital> findAllHospital(){

        List<Hospital> hospitalList= hospitalService.findAllHospital();

        return hospitalList;

    }

@RequestMapping注解+@RequestParam注解+@RequestPart注解

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/74841.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

设计模式,究竟有着怎样的力量?(初读修言老师设计模式)

每一个模式描述了一个在我们周围不断重复发生的问题&#xff0c;以及该问题的解决方案的核心。这样&#xff0c;你就能一次又一次地使用该方案而不必做重复劳动。 —— Christopher Alexander 设计模式是“拿来主义”在软件领域的贯彻实践。和很多人的主观臆断相反&#xff0c;…

HBase的Region Split详解

什么是Region Split region split是hbases水平扩展一个重要因素。随着数据的不断写入&#xff0c;将一个region切分为两个小region&#xff0c;并将切分后的region放在不同的节点上&#xff0c;以达到将负载进行均衡到其他节点。 Region Split的流程 在zookeeper的/hbase/regio…

从股票市场选择配对的股票:共同趋势协整模型

让我们回忆一下共同趋势模型。给定两个时间序列和&#xff0c;我们有 其 中和是随机游走&#xff0c;即非平稳部分&#xff0c;或者说共同趋势部分(common trends)。以及是平稳的部分&#xff0c;即特定部分&#xff08;specific component&#xff09;。如果两个时间序列是协整…

归并排序应用——剑指 Offer 51. 数组中的逆序对

文章目录题目1.错误示范2. 分析逆序对的判断统计出某个数后面有多少个数比它小举例(完整过程解析)第一次循环第二次循环第三次循环第四次循环第五次循环循环结束的两种存在情况3. 正确代码4.递归展开图题目 1.在数组中的两个数字&#xff0c;如果前面一个数字大于后面的数字&am…

全球发展,布局城市核心区域,放眼世界看郁锦香酒店有多百变

随着消费需求的不断升级&#xff0c;酒店消费场景也进行着多元化的发展&#xff0c;城市高端度假品牌正积极溯源消费需求&#xff0c;寻得品牌文化延伸的可靠路径。同时&#xff0c;各大酒店品牌也加快在市场布局的脚步&#xff0c;希望通过布局城市核心区域获得可持续发展的更…

鸿蒙所谓的软总线

鸿蒙网上资料 分布式软总线组件 简介 由于设备通信方式多种多样(WIFI、蓝牙等)&#xff0c;不同通信方式使用差异大&#xff0c;问题多。同时通信链路的融合共享和冲突无法处理。分布式软总线实现近场设备间统一的分布式通信能力管理&#xff0c;提供不区分链路的设备发现连…

IFR202型红外雨量传感器

IFR202型红外雨量传感器是专用于测量降雨量的仪器&#xff0c;拥有知识产权&#xff0c;采用光学扫描原理&#xff0c;实现雨滴大小及雨滴数量的实时扫描&#xff0c;进而计算出降雨量输出。支持脉冲输出与RS232输出当使用脉冲输出功能时&#xff0c;可以完全替代翻斗式雨量计。…

【电巢】三星核心供应商名单公布,删除京东方新增13家(附103家厂商名录)

前言 11月30日&#xff0c;据韩媒The ELEC报道&#xff0c;三星在最新公布的「供应商名单」中&#xff0c;悄然删除了国内企业京东方、群创&#xff0c;以及日企阿尔卑斯电气、日东电工、罗姆等10家企业&#xff0c;同时&#xff0c;新增了舜宇光学、Simmtech等13家企业。 以下…

Self-Attention 、 Multi-Head Attention 、VIT 学习记录及源码分享

这里写目录标题1 参考资料2 重点记录2.1 Self-Attention2.2 Multi-Head Attention3. Vision Transformer(VIT)3.1 纯VIT3.2 Hybrid VIT4 代码使用前言&#xff1a;想要看懂VIT中的一些内容&#xff0c;需要的基础知识点就是自己跑过一些CV方向的Demo&#xff0c;知道常见CV领域…

ADI Blackfin DSP处理器-BF533的开发详解13:LDF内存分配的详解(含源代码)

硬件准备 ADSP-EDU-BF533&#xff1a;BF533开发板 AD-HP530ICE&#xff1a;ADI DSP仿真器 软件准备 Visual DSP软件 硬件链接 功能介绍 ADSP上的LDF&#xff08;Linker Description Files&#xff09;连接器描述文件是处理器用来进行资源分配的文件&#xff0c;通过对LDF文…

中国新能源汽车产销量居世界第一,SCM系统实现企业订单可持续高效流转

近年来&#xff0c;中国汽车产业发生了翻天覆地的变化&#xff0c;而新能源汽车正是这一巨变的中坚力量。从不足10万辆&#xff0c;到突破千万辆&#xff0c;新能源汽车在国家政策扶持下&#xff0c;产品供给不断丰富、企业创新活力竞相迸发、使用环境日臻完善以及消费者认可度…

【MOOC】数据结构-2022秋期末考试

判断题 T 解析 第一个地址为2&#xff0c;第二个地址为21&#xff0c;第三个地址为24&#xff0c;第四个为29&#xff0c;即下标为0。 T 解析 在任一有向图中&#xff0c;所有顶点的入度之和等于所有顶点的出度之和。 F 解析 应该是当且仅当该树是满二叉树 F 解析 应该是交换次…

ABAP中的类与对象(Local class )

文章目录1 Definition1.1 What is the object&#xff1f;1.2 Differentiation of classes2 Factor of class2.1 classification2.2 Class Definition3 Access area4 Create local class4.1 Define the project of class (Attributes , Method, Event)4.2 Implement method of …

【C++进阶】哈希(万字详解)—— 学习篇(上)

&#x1f387;C学习历程&#xff1a;入门 博客主页&#xff1a;一起去看日落吗持续分享博主的C学习历程博主的能力有限&#xff0c;出现错误希望大家不吝赐教分享给大家一句我很喜欢的话&#xff1a; 也许你现在做的事情&#xff0c;暂时看不到成果&#xff0c;但不要忘记&…

成功的软件项目管理的职责和方法

软件项目管理是指项目管理的一个分支&#xff0c;专注于软件和Web项目的规划、资源分配、执行、跟踪和交付。软件开发领域的项目管理不同于经典的项目管理&#xff0c;因为软件项目有一个特殊的生命周期&#xff0c;包括多轮测试、更新和客户反馈。大多数IT项目都依赖敏捷方法来…

简介Object类+接口实例(深浅拷贝、对象数组排序)

本期目录前言一、初识Object类&#x1f351;1、toString()&#x1f351;2、hashCode()&#x1f351;3、equals()&#x1f351;4、clone()三、对象的深浅拷贝&#x1f351;1、浅拷贝&#x1f351;2、深拷贝&#x1f351;3、深浅拷贝的特点二、对象数组排序&#x1f351;1、通过C…

什么是BadUSB攻击以及如何预防

BadUSB 攻击是指 USB 设备存在内置固件漏洞&#xff0c;该漏洞允许自身伪装成人机接口设备。一旦连接到其目标计算机&#xff0c;BadUSB 就可以谨慎地执行有害命令或注入恶意负载。 一种常见的BadUSB攻击类型是橡皮鸭。它可以通过使用使用隐藏漏洞创建的闪存驱动器来执行&…

第二证券|卡塔尔给体育烧的钱,不止世界杯

11月&#xff0c;世界杯史上首次在北半球冬季打响。 全世界的目光也聚焦到了卡塔尔——这个面积仅11576平方千米、人口不足300万的中东小国。 虽然面积小&#xff0c;卡塔尔人花钱却很大方。 本届世界杯总计2200亿美元的投入&#xff0c;为历届世界杯花费之最。巴西世界杯和俄…

java基于springboot的新生宿舍管理系统-计算机毕业设计

项目介绍 随着科学技术的飞速发展&#xff0c;社会的方方面面、各行各业都在努力与现代的先进技术接轨&#xff0c;通过科技手段来提高自身的优势&#xff0c;新生宿舍管理系统当然也不能排除在外。新生宿舍管理系统是以实际运用为开发背景&#xff0c;运用软件工程原理和开发…

海外社媒运营,推特内容营销

Twitter 成立于 2006 年&#xff0c;已成为全球第三大用户社交平台&#xff0c;月活跃用户达 3.89 亿。推特最大的特点就是字数限制和信息短小&#xff0c;正好符合现代人的阅读习惯。 对于跨境卖家来说&#xff0c;推特不仅可以获取有价值的客户信息&#xff0c;收集粉丝反馈…