彻底搞懂 Java 中的注解 Annotation


Java注解是一系列元数据，它提供数据用来解释程序代码，但是注解并非是所解释的代码本身的一部分。注解对于代码的运行效果没有直接影响。

网络上对注解的解释过于严肃、刻板，这并不是我喜欢的风格。尽管这样的解释听起来非常的专业。

为了缓解大家对“注解”的陌生感，我来说点有意思的。其实我对“注解”这个词的第一印象并不是Java的注解，而是朱熹的名作《四书章句集注》。为什么我会有这么大的脑洞呢？因为当我试着去翻译Annotation这个单词的时候，得到的结果是“注释”而不是“注解”。《四书章句集注》正是朱熹对《大学》、《中庸》、《论语》、《孟子》四书做出的重要的注释。要知道，该书可是明清以后科举考试的题库和标准答案！

注解（Annotation）是在 Java SE 5.0 版本中开始引入的概念，同class和interface一样，也属于一种类型。很多开发人员认为注解的地位不高，但其实不是这样的。像@Transactional、@Service、@RestController、@RequestMapping、@CrossOrigin等等这些注解的使用频率越来越高。

01、为什么要使用注解呢？

为什么要使用注解呢？让我们从另外一个问题说起。

“跨域”这两个字就像一块狗皮膏药黏在每一个前端开发者的身上；我也不例外，虽然我并不是一个纯粹的前端开发者。

跨域问题的出现，源于浏览器的同源策略——限制一个源加载的脚本去访问另外一个源的资源，可有效地隔离潜在的恶意文件，是一种重要的安全机制。

跨域问题

跨域问题的解决方案也有很多，比如说：

1）JSONP

2）Nginx代理

3）"跨域资源共享"（Cross-origin resource sharing），简称CORS，可以说是处理跨域问题的标准做法。

记得第一次遇到跨域问题的时候，我特意向一个同学请教了解决方案，他告诉我的答案如下。

第一步，在web.xml添加filter。

<filter><filter-name>contextfilter</filter-name><filter-class>com.cmower.filter.WebContextFilter</filter-class>
</filter>
<filter-mapping><filter-name>contextfilter</filter-name><url-pattern>/*</url-pattern>
</filter-mapping>

第二步，实现WebContextFilter类。

public class WebContextFilter implements Filter {@Overridepublic void destroy() {}@Overridepublic void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)throws IOException, ServletException {HttpServletResponse  httpServletResponse = (HttpServletResponse) response;httpServletResponse.setHeader("Access-Control-Allow-Origin", "*");httpServletResponse.setHeader("Access-Control-Allow-Headers", "accept,content-type"); httpServletResponse.setHeader("Access-Control-Allow-Methods", "OPTIONS,GET,POST,DELETE,PUT"); chain.doFilter(request, httpServletResponse);}@Overridepublic void init(FilterConfig arg0) throws ServletException {}}

看到这样的解决方案，我真的是蛮崩溃的。不就一个跨域问题嘛，用得着这么多代码吗？

我对这样的解决方案非常的不满意。于是下定决心要好好的研究一番，大概花了半天的时间吧，我终于搞清楚了“跨域”问题，以及它的标准解决方案CORS。并且找到了一个极为简洁的解决方案——@CrossOrigin，只要在Controller类上加上这个注解，就可以轻松地解决跨域问题。

代码如下。

@RestController
@RequestMapping("course")
@CrossOrigin
public class CourseController {
}

如果没有找到@CrossOrigin这个注解，我真的就要按照同学提供的方案去解决跨域的问题了。但那样做就好像，我们卖掉家里的小汽车，然后出行的时候驾一辆马车一样。

这也正是我想告诉你的，为什么要使用注解的原因：它让我们的代码看起来更简洁，更有时代的进步感。

02、该如何定义注解呢？

注解需要通过@interface关键字（形式和接口非常的相似，只是前面多了一个@）进行定义。我们可以打开@CrossOrigin的源码来看一下。

@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface CrossOrigin {/*** List of allowed origins, e.g. {@code "http://domain1.com"}.* <p>These values are placed in the {@code Access-Control-Allow-Origin}* header of both the pre-flight response and the actual response.* {@code "*"} means that all origins are allowed.* <p>If undefined, all origins are allowed.* @see #value*/@AliasFor("value")String[] origins() default {};/*** List of request headers that can be used during the actual request.* <p>This property controls the value of the pre-flight response's* {@code Access-Control-Allow-Headers} header.* {@code "*"}  means that all headers requested by the client are allowed.* <p>If undefined, all requested headers are allowed.*/String[] allowedHeaders() default {};/*** List of supported HTTP request methods, e.g.* {@code "{RequestMethod.GET, RequestMethod.POST}"}.* <p>Methods specified here override those specified via {@code RequestMapping}.* <p>If undefined, methods defined by {@link RequestMapping} annotation* are used.*/RequestMethod[] methods() default {};
}

从上面的代码可以看得出来，“注解”真的很“注解”，除了注释多和“元注解”多之外，真没有别的了。

“元注解”？什么是“元注解”呢？

“元注解”是用来注解（动词）注解（名词）的注解（名词）。请感受汉语的博大精深。@Target、@Retention和@Documented就是所谓的元注解。

1）@Target

Target是目标的意思，@Target指定了注解运用的场景。都有哪些场景值呢？

  • ElementType.ANNOTATION_TYPE：可以给注解进行注解

  • ElementType.CONSTRUCTOR：可以给构造方法进行注解

  • ElementType.FIELD：可以给字段进行注解

  • ElementType.LOCAL_VARIABLE：可以给局部变量进行注解

  • ElementType.METHOD：可以给方法进行注解

  • ElementType.PACKAGE：可以给包进行注解

  • ElementType.PARAMETER：可以给方法内的参数进行注解

  • ElementType.TYPE：可以给类型进行注解，比如类、接口和枚举

2）@Retention

Retention这个单词的意思为保留期。也就是说，当@Retention应用到一个注解上的时候，它解释说明了这个注解的存活时间。来看它的取值范围。

  • RetentionPolicy.SOURCE：注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。

  • RetentionPolicy.CLASS：注解只被保留到编译进行的时候，并不会被加载到 JVM 中。

  • RetentionPolicy.RUNTIME：注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们。

3）@Documented

Documented就比较容易理解，它和文档有关。作用就是能够将注解中的元素包含到 Javadoc 中。

当我们了解了元注解的概念后，再回头看一下@CrossOrigin的源码，是不是感觉清晰多了呢？

如果能够细致地读一读源码中的注释，你就会看到WebContextFilter类中出现的关键字，诸如Access-Control-Allow-Origin、Access-Control-Allow-Headers、Access-Control-Allow-Methods。也就是说，当我们通过@CrossOrigin对Controller类注解后，SpringMVC就能够在运行时对这个类自动加上解决跨域问题的过滤器。

03、注解可以反射吗？

注解是可以通过反射获取的。

1）可以通过 Class 对象的 isAnnotationPresent() 方法判断该类是否应用了某个指定的注解。

2）通过 getAnnotation() 方法来获取注解对象。

3）当获取到注解对象后，就可以获取使用注解时定义的属性值。

示例如下：

@CrossOrigin(origins = "http://qingmiaokeji.com", allowedHeaders = "accept,content-type", methods = { RequestMethod.GET, RequestMethod.POST })
public class TestController {public static void main(String[] args) {Class c = TestController.class;if (c.isAnnotationPresent(CrossOrigin.class)) {CrossOrigin crossOrigin = (CrossOrigin) c.getAnnotation(CrossOrigin.class);System.out.println(Arrays.asList(crossOrigin.allowedHeaders()));System.out.println(Arrays.asList(crossOrigin.methods()));System.out.println(Arrays.asList(crossOrigin.origins()));}}
}// 输出：[accept,content-type]
// [GET, POST]
// [http://qingmiaokeji.com]

04、注解经常用在哪里呢？

1）@Transactional：Spring 为事务管理提供的功能支持。

2）@ Service：Spring在进行包扫描的时候，会自动将这个类注册到Spring容器中。

3）@RestController：是@ResponseBody和@Controller的组合注解。

也就是说，下面这段代码与下下面的代码等同。

@RestController
public class HelloController {@RequestMapping(value="hello")public String sayHello(){return "hello";}
}

@Controller
@ResponseBody
public class HelloController {@RequestMapping(value="hello")public String sayHello(){return "hello";}
}

4）@RequestMapping ：Spring Web 应用程序中最常用到的注解之一，将 HTTP 请求映射到 MVC 和 REST 控制器的处理方法上。

5）@Select：MyBatis提供的查询语句注解。示例如下：

@Select("select * from city")
List<City> getCitys();

6）还有很多很多，就不再一一列举了。

最后

我想说的是，注解有许多用处，主要有：

  • 提供信息给编译器： 编译器可以利用注解来探测错误和警告信息。

  • 编译阶段时的处理：  软件工具可以利用注解信息来生成代码、HTML文档。

  • 运行时的处理：  某些注解可以在程序运行的时候接受代码的提取。

别忘了：

四书章句集注
近期热点推荐

Java 最常见的 200+ 面试题

Java 200+ 面试题补充③ Dubbo 模块

Java 200+ 面试题补充② Netty 模块

Java 200+ 面试题补充 ThreadLocal 模块

面试题 == 和 equals 的区别

面试经验分享|精华篇

精美简历合集II

精美简历合集I

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

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

cs时间校准

cs时间校准

2019独角兽企业重金招聘Python工程师标准>>> c/s结构中的时间校准 拜读了风云的一篇博客 思路比较明显简单: C发包打时间戳 S收包打时间戳 S回应包打时间戳 C收包打时间戳 4个时间戳可以进行计算校准. 假设来回时间相等 转载于:https://my.oschina.net/u/1449566/bl…
阅读更多...
使用ACME部署生成阿里云免费HTTPS证书

使用ACME部署生成阿里云免费HTTPS证书

使用ACME部署HTTPS证书 背景 现在越来越多的服务都是基于web&#xff0c;大多数默认使用HTTP协议。HTTP协议是一种没有加密的协议&#xff0c;所有数据都通过明文传输&#xff0c;即便是只在内网使用也存在一定的安全风险。尤其是对于登录等操作&#xff0c;账号密码通过HTTP…
阅读更多...
Java性能优化的50个细节（珍藏版）

Java性能优化的50个细节（珍藏版）

来源&#xff1a;http://t.cn/EMze6kc在JAVA程序中&#xff0c;性能问题的大部分原因并不在于JAVA语言&#xff0c;而是程序本身。养成良好的编码习惯非常重要&#xff0c;能够显著地提升程序性能。1. 尽量在合适的场合使用单例使用单例可以减轻加载的负担&#xff0c;缩短加载…
阅读更多...
强化学习基础篇 OpenAI Gym 环境搭建demo

强化学习基础篇 OpenAI Gym 环境搭建demo

1. Gym介绍 Gym是一个研究和开发强化学习相关算法的仿真平台&#xff0c;无需智能体先验知识&#xff0c;由以下两部分组成 Gym开源库&#xff1a;测试问题的集合。当你测试强化学习的时候&#xff0c;测试问题就是环境&#xff0c;比如机器人玩游戏&#xff0c;环境的集合就…
阅读更多...
九、PyQt5 QLineEdit输入的子网字符串校验QRegExp

九、PyQt5 QLineEdit输入的子网字符串校验QRegExp

自己编写的用于对lineEdit编辑框输入的子网，例如：192.168.60.1/24字符串校验是否合规。 # 限制lineEdit编辑框只能输入./字符和数字reg = QRegExp([0-9./]+$)validator = QRegExpValidator(self)validator.setRegExp(reg)self.lineEditSubNet.setValidator(validator)
阅读更多...
为什么阿里巴巴不建议在for循环中使用+进行字符串拼接

为什么阿里巴巴不建议在for循环中使用+进行字符串拼接

本文&#xff0c;也是对于Java中字符串相关知识的一个补充&#xff0c;主要来介绍一下字符串拼接相关的知识。本文基于jdk1.8.0_181。字符串拼接字符串拼接是我们在Java代码中比较经常要做的事情&#xff0c;就是把多个字符串拼接到一起。我们都知道&#xff0c;String是Java中…
阅读更多...
Google强化学习框架SEED RL环境部署

Google强化学习框架SEED RL环境部署

如上述博客有任何错误或者疑问&#xff0c;请加VX&#xff1a;1755337994&#xff0c;及时告知&#xff01;万分感激&#xff01; 本框架是Google发布于ICLR2020顶会上&#xff0c;这两天发布于Google Blog上 **论文Arxiv&#xff1a;**https://arxiv.org/abs/1910.06591 ||…
阅读更多...
PLSQL连接oracel数据库_用户无法登陆_oci.dll_配置问题

PLSQL连接oracel数据库_用户无法登陆_oci.dll_配置问题

为什么80%的码农都做不了架构师&#xff1f;>>> 由于工作需要换了台新电脑&#xff0c;在抚摸新笔记本满怀新鲜感和喜悦心情之余&#xff08;其实纯屌丝味尽显无余&#xff0c;就基本和双手捧托一颗高大上的茶叶蛋般内心激动且泪眼汪汪&#xff09;&#xff0c;重新…
阅读更多...
CentOS7搭建部署Ambari 2.6.2.0最新版(HDP-UTILS、HDP-GPL)大数据平台

CentOS7搭建部署Ambari 2.6.2.0最新版(HDP-UTILS、HDP-GPL)大数据平台

如上述博客有任何错误或者疑问&#xff0c;请加VX&#xff1a;1755337994&#xff0c;及时告知&#xff01;万分感激&#xff01; 注&#xff1a;本文基于root用户操作 一、安装环境准备 操作系统 centos7.5 hdc-data1&#xff1a;192.168.163.51 hdc-data2&#xff1a;192.16…
阅读更多...
阿里面试题BIO和NIO数量问题附答案和代码

阿里面试题BIO和NIO数量问题附答案和代码

一、问题 BIO 和 NIO 作为 Server 端&#xff0c;当建立了 10 个连接时&#xff0c;分别产生多少个线程&#xff1f; 答案&#xff1a; 因为传统的 IO 也就是 BIO 是同步线程堵塞的&#xff0c;所以每个连接都要分配一个专用线程来处理请求&#xff0c;这样 10 个连接就会创建…
阅读更多...
CentOS7搭建离线部署Cloudera CDH 6.2.0大数据平台

CentOS7搭建离线部署Cloudera CDH 6.2.0大数据平台

如上述博客有任何错误或者疑问&#xff0c;请加VX&#xff1a;1755337994&#xff0c;及时告知&#xff01;万分感激&#xff01; 1.概述 CDH&#xff0c;全称Clouderas Distribution, including Apache Hadoop。是Hadoop众多分支中对应中的一种&#xff0c;由Cloudera维护&a…
阅读更多...
负载均衡实现的几种方式

负载均衡实现的几种方式

负载均衡&#xff0c;英文名Load Balance&#xff0c;作用是将操作分摊到多个执行单元上执行。随着如今网络流量的不断增大&#xff0c;服务的负载均衡是必须的&#xff0c;这里就来讲一讲负载均衡的结构。 说到负载均衡&#xff0c;同学最容易想到的可能就是nginx了&…
阅读更多...
CheckBox as Image use button

CheckBox as Image use button

为什么80%的码农都做不了架构师&#xff1f;>>> <CheckBox android:id"id/notificationPhoneIcon" android:layout_width"wrap_content" android:layout_height"wrap_content" android:layout_centerVertical"true" an…
阅读更多...
1-1.Win10系统利用Pycharm社区版安装Django搭建一个简单Python Web项目的步骤之一

1-1.Win10系统利用Pycharm社区版安装Django搭建一个简单Python Web项目的步骤之一

首先&#xff0c;安装python3.8和pycharm参考其他教程。 一、安装django 使用下面命令默认安装最新版的django pip install django也可以从django官网查看安装一个LTS长期稳定支持版本&#xff0c;从下图看到3.2是LTS版本&#xff0c;能够长期支持2021年&#xff5e;2024年&…
阅读更多...
python装饰器函数传参

python装饰器函数传参

python装饰器函数传参 装饰器 装饰器是一个返回函数的高阶函数。 装饰器常见用法&#xff1a; 打印日志 def logger(func):def wrapper(*args, **kw):print do {}.format(func.__name__)func(*args, **kw)print finishreturn wrapperlogger def add(x,y):print {} {} {}.…
阅读更多...
Tomcat工作原理及简单模拟实现

Tomcat工作原理及简单模拟实现

Tomcat应该都不陌生&#xff0c;我们经常会把写好的代码打包放在Tomcat里并启动&#xff0c;然后在浏览器里就能愉快的调用我们写的代码来实现相应的功能了&#xff0c;那么Tomcat是如何工作的&#xff1f;一、Tomcat工作原理我们启动Tomcat时双击的startup.bat文件的主要作用是…
阅读更多...
苹果怎么调字体大小？详细教程在这，赶快get起来！

苹果怎么调字体大小？详细教程在这，赶快get起来！

在我们使用苹果手机时&#xff0c;可能会遇到需要调整字体大小的情况。合适的字体大小能够提高阅读体验和舒适度&#xff0c;使得手机使用更加便捷。然而&#xff0c;还有很多用户并不知道苹果怎么调字体大小。别着急&#xff01;本文将为您详细介绍操作方法&#xff0c;帮助您…
阅读更多...
PyQt5树形结构控件QTreeWidget操作

PyQt5树形结构控件QTreeWidget操作

QTreeWidget 类根据预设的模型提供树形显示控件。 QTreeWidget 使用类似于 QListView 类的方式提供一种典型的基于 item 的树形交互方法类&#xff0c;该类基于QT的“模型/视图”结构&#xff0c;提供了默认的模型来支撑 item 的显示&#xff0c;这些 item 类为 QTreeWidgetIt…
阅读更多...
Python3之logging输出写入日志

Python3之logging输出写入日志

Python3之logging模块浅析 目录 Python3之logging模块浅析 简单用法日志与控制台同时输出 一个同时输出到屏幕、文件的完成例子日志文件截取日志重复打印问题解决 问题分析解决方案 1.使用不同的日志对象2.及时清理&#xff08;logger.handlers.clear&#xff09;3.使用前先判…
阅读更多...
HashMap线程安全问题

HashMap线程安全问题

HashMap是线程不安全的&#xff0c;在多线程环境下对某个对象中HashMap类型的实例变量进行操作时&#xff0c;可能会产生各种不符合预期的问题。本文详细说明一下HashMap存在的几个线程安全问题。注&#xff1a;以下基于JDK1.8HashMap原理请走传送门通过简单例子来探索HashMap原…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023