注解(Annotation) 学习笔记(尚硅谷康师傅版)
注解(Annotation)
一、注解(Annotation)概述
从JDK 5.0开始, Java 增加了对元数据(MetaData)的支持, 也就是Annotation(注解)
Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行被读取, 并执行相应的处理。通过使用 Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。
Annotation 可以像修饰符一样被使用, 可用于修饰包,类,构造器, 方法, 成员变量, 参数,局部变量的声明, 这些信息被保存在 Annotation的 “name=value” 对中。
在JavaSE中,注解的使用目的比较简单,例如标记过时的功能,忽略警告等。
在JavaEE/Android中注解占据了更重要的角色,例如用来配置应用程序的任何切面,代替JavaEE旧版中所遗留的繁冗代码和XML配置等。
未来的开发模式都是基于注解的,JPA是基于注解的,Spring2.5以上都是基于注解的,Hibernate3.x以后也是基于注解的,现在的Struts2有一部分也是基于注解的了,注解是一种趋势,一定程度上可以说:框架 = 注解 + 反射 + 设计模式。
二、常见的Annotation示例
1.生成文档相关的注解
使用 Annotation 时要在其前面增加 @ 符号, 并把该Annotation当成一个修饰符使用。用于修饰它支持的程序元素
@author 标明开发该类模块的作者,多个作者之间使用,分割
@version 标明该类模块的版本
@see 参考转向,也就是相关主题
@since 从哪个版本开始增加的
@param 对方法中某参数的说明,如果没有参数就不能写
@return 对方法返回值的说明,如果方法的返回值类型是void就不能写
@exception 对方法可能抛出的异常进行说明 ,如果方法没有用throws显式抛出的异常就不能写
其中@param @return 和 @exception 这三个标记都是只用于方法的。@param的格式要求:@param 形参名 形参类型 形参说明@return 的格式要求:@return 返回值类型 返回值说明@exception的格式要求:@exception 异常类型 异常说明@param和@exception可以并列多个
简单的例子
//以下内容在创建类时自动生成,但需要提前设置。
/*** @author 作者名* @version 1.0.0* @ClassName AnnoTest.java* @Description* @createTime 创建该类时间*/
public class AnnotationTest {//以下内容是可选的,自己生成的。/*** @title* @description* @author admin* @updateTime 2020/11/9 16:22* @throws*/public static void main(String[] args) {}
}
关于以上IDEA文档注解的设置,点击
2.在编译时进行格式检查(JDK内置的三个基本注解)
@Override: 限定重写父类方法, 该注解只能用于方法
@Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为
所修饰的结构危险或存在更好的选择
@SuppressWarnings: 抑制编译器警告
public class AnnotationTest {public static void main(String[] args) {@SuppressWarnings("unused")int a = 10;}@Deprecatedpublic static void print(){System.out.println("过时的方法");}@Overridepublic String toString() {return "重写的toString方法()"; }
}
3.跟踪代码依赖性,实现替代配置文件功能
这部分内容需要学习完SpringMVC才能看明白
@WebServlet("/login")
public class LoginServlet extends HttpServlet {private static final long serialVersionUID = 1L;protected void doGet(HttpServletRequest request, HttpServletResponse response) throwsServletException, IOException { }protected void doPost(HttpServletRequest request, HttpServletResponse response) throwsServletException, IOException {doGet(request, response);}
}
<!--上面代码加了@WebServlet("/login")注解,所以在web.xml中以下代码可以省略--><servlet> <servlet-name>LoginServlet</servlet-name> <servlet-class>com.servlet.LoginServlet</servlet-class>
</servlet>
<servlet-mapping> <servlet-name>LoginServlet</servlet-name> <url-pattern>/login</url-pattern>
</servlet-mapping>
三、自定义Annotation
定义新的 Annotation 类型使用 @interface 关键字
自定义注解自动继承了java.lang.annotation.Annotation接口
Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组。
可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始值可使用 default 关键字
如果只有一个参数成员,建议使用参数名为value
如果定义的注解含有配置参数,那么使用时必须指定参数值,除非它有默认值。格式是“参数名 = 参数值”,如果只有一个参数成员,且名称为value,可以省略“value=”
没有成员定义的 Annotation 称为标记; 包含成员变量的 Annotation 称为元数据 Annotation
注意:自定义注解必须配上注解的信息处理流程才有意义。
四、JDK中的元注解
介绍
JDK 的 元Annotation 用于修饰 其他 Annotation 定义
JDK5.0提供了4个标准的meta-annotation类型,分别是:
- Retention
- Target
- Document
- Inherited
1.@Retention
1.1 介绍
@Retention: 只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 的 生命周期, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用@Rentention 时必须为该 value 成员变量指定值:
**RetentionPolicy.SOURCE:**在源文件中有效(即.java源文件保留),编译器直接丢弃这种策略的注释
RetentionPolicy.CLASS:在class文件中有效(即.class文件保留) , 当运行 Java 程序时, JVM 不会保留注解。 这是默认值
**RetentionPolicy.RUNTIME:**在运行时有效(即运行时保留),当运行Java程序时, JVM会保留注释。程序可以通过反射获取该注释
1.2 @Override源码
2.@Target
2.1 介绍
@Target 用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于修饰哪些程序元素。 即该注解可以在那些元素上面声明。
@Target 也包含一个名为 value 的成员变量。下面是几个常用属性:
CONSTRUCTOR:用于描述构造器
FIELD:用于描述域
LOCAL_VARIABLE:用于描述局部变量
METHOD:用于描述方法
PACKAGE:用于描述包
PARAMETER:用于描述参数
TYPE:用于描述类、接口(包括注解类型)或enum声明
不用可以去记住,知道中文意思即可。使用时直接输入ElementType. 或 输入该属性名 就有提示
2.2 用法
声明
使用
因为声明时,只声明能在方法上用,所以在类上用的时候就报错了。
3.@Document
@Document:用于指定被该元 Annotation 修饰的 Annotation 类将被javadoc 工具提取成文档。**默认情况下,javadoc是不包括注解的。 **
注意:定义为Documented的注解必须设置Retention值为RUNTIME。
javadoc文档简单理解就是我们平时看的那些API的文档
4.@Inherited
@Inherited:被它修饰的 Annotation 将具有继承性。如果某个类使用了被@Inherited 修饰的 Annotation, 则其子类将自动具有该注解。
五、利用反射获取注解信息(在反射部分涉及)
JDK 5.0 在 java.lang.reflect 包下新增了 AnnotatedElement 接口, 该接口代表程序中可以接受注解的程序元素
当一个 Annotation 类型被定义为运行时 Annotation 后, 该注才是运行时可见, 当 class 文件被载入时保存在 class 文件中的 Annotation 才会被虚拟机读取
程序可以调用 AnnotatedElement对象的如下方法来访问 Annotation 信息
六、JDK 8中注解的新特性
Java 8对注解处理提供了两点改进:可重复的注解及可用于类型的注解。此外,
反射也得到了加强,在Java8中能够得到方法参数的名称。这会简化标注在方法
参数上的注解。
1.可重复注解
2.类型注解
JDK1.8之后,关于元注解@Target的参数类型ElementType枚举值多了两个:TYPE_PARAMETER,TYPE_USE。
在Java 8之前,注解只能是在声明的地方所使用,Java8开始,注解可以应用在任何地方。
ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中(如:泛型声明)。
ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中。
TYPE_PARAMETER
//自定义注解
@Target({ElementType.TYPE_PARAMETER})
@interface TypeDefine{}//自定义注解的使用
public class TestTypeDefine<@TypeDefine() U> {private U u;public <@TypeDefine() T> void test(T t){} }
TYPE_USE
//自定义注解
@Target(ElementType.TYPE_USE)
@interface MyAnnotation {
}//自定义注解的使用
@MyAnnotation
public class AnnotationTest<U> {@MyAnnotation
private String name;
public static void main(String[] args) {AnnotationTest<@MyAnnotation String> t = null;
int a = (@MyAnnotation int) 2L;
@MyAnnotation
int b = 10;
}
public static <@MyAnnotation T> void method(T t) { }
public static void test(@MyAnnotation String arg) throws @MyAnnotation Exception { } }
学习笔记习自:尚硅谷
注解(Annotation) 学习笔记(尚硅谷康师傅版)相关推荐
- javaWeb学习笔记(尚硅谷旧版+新版)
HTML基础 目录 HTML基础 HTML书写规范 HTML标签 简介 特殊字符 a标签 列表标签 img标签 table标签 跨行跨列表格 iframe标签 表单标签 关于GET和POST请求 ...
- MySQL学习笔记——尚硅谷李玉婷经典版MySQL基础笔记(一)
MySQL学习笔记--尚硅谷李玉婷经典版MySQL基础笔记(一) MySQL学习笔记目录 MySQL学习笔记--尚硅谷李玉婷经典版MySQL基础笔记(一) 一.基础知识 1.MySQL的语法规范 2. ...
- maven学习笔记——尚硅谷
文章目录 maven学习笔记--尚硅谷 第一章 Maven概述 第一节 为什么要学习Maven 1.Maven 作为依赖管理工具 1.1 jar 包的规模 1.2 jar 包的来源 1.3 jar 包 ...
- Rabbitmq学习笔记(尚硅谷2021)
Rabbitmq学习笔记 (尚硅谷) 1.MQ 的概念 1.1 什么是 MQ? 1.2 为什么要用 MQ? 削峰 解耦 异步 1.3 MQ 的分类 ActiveMQ Kafka RocketMQ Ra ...
- 【HBase学习笔记-尚硅谷-Java API shell命令 谷粒微博案例】
HBase学习笔记 HBase 一.HBase简介 1.HBase介绍 2.HBase的逻辑结构和物理结构 3.数据模型 4.基本架构 二.快速入门 1.配置HBase 2.命令 三.API 1.获取 ...
- Java学习笔记 | 尚硅谷项目三详解
该笔记基于B站视频:尚硅谷Java入门视频教程 目录 1,目标 2,需求说明 2.1,功能实现 2.1,菜单显示 2.2,添加功能 2.3,删除功能 2.3,查看团队成员 3,软件设计结构 4,具体实 ...
- Springboot学习笔记 | 尚硅谷雷神
一.springboot入门 1.导入依赖 导入springboot版本仲裁中心 <parent><groupId>org.springframework.boot</g ...
- Elasticsearch7学习笔记(尚硅谷)
文章目录 一.ElasticSearch概述 1.ElasticSearch是什么 2.全文搜索引擎 3.ElasticSearch 和 Solr 3.1 概述 3.2 比较总结 二.Elastics ...
- [Java]Maven学习笔记(尚硅谷2022)
文章目录
最新文章
- Akka的Actor编程
- 思科3550 IOS
- 《零基础看得懂的C语言入门教程 》——(九)C语言二维数组与循环嵌套
- day3-文件操作之基本操作
- java 管理系统 注释_员工管理系统--带注释--oracle系统--java项目
- 软件测试需要哪些c语言基础知识,测试人员都需要了解哪些redis知识?
- 如何批量打印图片文件
- SetTimer函数的使用
- vcm服务器如何修改端口,录音棚里的电动“机器人”-YAMAHA DM1000VCM控制模块设置教程...
- html制作dnf,DNF教你如何不花一分钱制作90顶级史诗
- 操作系统——经典同步问题
- 童心未泯?LEGO积木iPod touch外壳,自己拼积木!
- php里用钢笔画曲线,ps钢笔工具怎么抠图
- 卷积、空洞卷积、反卷积与空洞反卷积的计算公式(全)
- python网易云音乐下载,可选择歌曲,下载路径
- R语言之LDA算法应用
- FTP传输大文件丢包损坏严重,怎么解决?
- 高项_第十章项目沟通管理
- (附源码)spring boot大学生综合素质测评系统 毕业设计 162308
- 系统调用功能号与execve函数详解