1. 注解基本概念
注解,什么是注解?
打开百度搜索
好,看不懂
没关系
一步一步慢慢来
先不管注解,注释这个概念应该就很熟悉了,文档注释,单行注释,多行注释
注释是对一段程序,一个方法,一个类进行描述,是给我们程序员看的,都知道,注解是不会被编译的,会被忽略
注解,同样的道理,其实就是用来说明代码的,但是注解是 给计算机看的,是会被编译的
因此:
注解概念:jdk1.5之后出现,是对程序进行说明,并且会被编辑,给计算机看的
来看看toString 方法
Override 这个单词并不陌生java基础—重写、重载 ,没错 重写,子类重写父类的方法
如果我们 把这个方法改一下
可以看到注解 报错了 错误信息:
方法不是重写父类的方法
就像我们之前说的函数式接口 java8 (jdk 1.8) 新特性——Lambda
@FunctionalInterface 注解一样
所以注解的其中一个功能就出来了: 用来校验,编译检查
注解的格式:@+名称
2. JDK 中的内置注解
java提供了5个基本的注解:
这五个注解的介绍百度百科已经说的很清楚了,这边直接引用
限定父类重写方法:@Override
当子类重写父类方法时,子类可以加上这个注解,那这有什么什么用?这可以确保子类确实重写了父类的方法,避免出现低级错误
2. 标示已过时:@Deprecated
这个注解用于表示某个程序元素类,方法等已过时,当其他程序使用已过时的类,方法时编译器会给出警告(删除线,这个见了不少了吧)。
3.抑制编译器警告:@SuppressWarnings
被该注解修饰的元素以及该元素的所有子元素取消显示编译器警告,例如修饰一个类,那他的字段,方法都是显示警告
4.“堆污染”警告与@SafeVarargs
想理解这个就要明白什么是堆污染,堆污染是什么?
其实很好理解,就是把不带泛型的对象赋给一个带泛型的对象,为什么不行?很简单,因为不带泛型的话,默认会给泛型设定为object,意思就是什么类型都可以往里面塞,那你一个不带泛型的怎么可能给一个带泛型塞呢。
例如运行如下代码:
List list = new ArrayList(); list.add(20);
List<String> ls = list; System.out.println(ls.get(0));
则会抛出堆污染异常Exception in thread \"main\" java.lang.ClassCastException: java.lang.Integer cannot be cast to java.lang.String at Test.Test1.main(Test1.java:29)
注意:可变参数更容易引发堆污染异常,因为java不允许创建泛型数组,可变参数恰恰是数组。
抑制这个警告的方法有三个:
1.@SafeVarargs修饰引发该警告的方法或构造器
2.使用@suppressWarnings(\"unchecked\")
3.编译时使用-Xlint:varargs
5.函数式接口与@Functionallnterface
什么是函数式?如果接口中只有一个抽象方法(可以包含多个默认方法或多个static方法)
接口体内只能声明常量字段和抽象方法,并且被隐式声明为public,static,final。
接口里面不能有私有的方法或变量。
这个注解有什么用?这个注解保证这个接口只有一个抽象方法,注意这个只能修饰接口
认识认识,有个印象
3.注解的功能
-
首先一个就是前边的 用来编译检查功能
-
其次,注解还有编写文档的功能
什么?编写文档,一脸懵逼,别急,看看就知道了
jdk 文档,应该程序员人手都有一份,没有的伙伴 公众号内回复【文档】 获取
其实这些文档就是通过注解生成的
事实胜于雄辩
我们先建一个类
桌面新建一个文件夹 api ,把这个类拷贝进去
cmd 然后进行javadoc 命令
可以看到生成了一堆文件,
双击打开index.html
是不是发现新大陆!!
-
再者,就是代码分析【这个就是最重要的了,Spring Aop 自定义注解都是这个用的这个功能,当然主要原理还是反射】 java进阶—反射
4. 注解本质
前边 说了,注解语法格式:@+名称
那么,是不是只要我们 @ +随便一个名字是不是就是注解呢?@OpLog
@UserLog
你当然可以这样定义,但并不是按照这种格式写了,编译器就能认,它背后是有进行一些操作的,也就是说让编译器认你写的这个是注解
照猫画虎,我们来看官方是怎么处理的
点开注解原码
格式:
元注解 public @interface 注解名称 { }
@interface 是什么意思
现在我随便写了一个类
public @interface MyAnnotation { }
进行反编译
可以看到 @interface 注解的本质就是 interface ,只不过继承了 lang 包的一个类 java.lang.annotation.Annotation
看看api ,Api 公众号内 回复 【文档】 获取
5. 注解属性
我们都知道,接口中可以定义抽象方法,这边叫做注解的属性
属性的返回值类型是有要求的
-
八大基本类型
-
枚举
-
String 类型
-
注解
-
Class
-
以上类型的数组
注意: 返回值类型不能是 void 跟 类 类型
可以看到报错了
使用注解,并且对属性赋值就很简单了,前边说了,注解可以在一个类,一个方法上进行标记
可以看到这是我们刚刚定义的属性,属性名 = 值 就行了 , 值要跟类型对应上,并且有几个属性,就要写几个,不然会报错
6. 值获取
注解值获取得通过反射获取,前提是注解上有保留策略,也就是必须要有元注解,这边先不管是什么东西,为了演示获取值我们先加上
运行结果
7.元注解
最后来看元注解
我们知道注解是用来描述程序的
@Retention 这个注解 ,现在把它看做一个程序【只不过这个程序是注解程序】, 那么在它上面的注解是用来描述这个 @Retention 注解程序的
因此:元注解的概念就出来了
元注解:描述注解的注解
按住alt点击target,可以看到target 注解上面又有元注解,套娃
那么元注解有哪些,JDK给我们定义好了
@Target : 表示注解能够作用在什么位置【类,方法 等等】
@Retention: 描述注解被保留的阶段【java代码的三个阶段】
@Document 描述注解是否抽取到Api文档中
@Inherited: 注解是否被子类继承 【加上这个标记,子类会自动继承父类中的注解】
@Repeatable:java8新增的注解,用于开发重复注解
类型注解;这个也是java8新增的注解,可以用在任何用到类型的地方【其实也就是target 的枚举增加的枚举类值】
-
@Target :
点开原码,我们可以看到,target 只有一个属性,这个属性是枚举数组,
点开ElementType 就可以看到这就是一个枚举
因此,元注解 @Target 就可以这样写
可以看到枚举类中不只有一个 TYPE 属性,有这个多,我们先注重以下三种就行了,java8 新加的类型注解后面再提
-
ElementType.TYPE: 表示这个注解只能作用在类上
可以看到成员变量跟方法上都报错
-
ElementType.METHOD :可以作用于方法上
-
ElementType.FIELD:可以作用于成员变量
这两个就不分别单独演示了,跟在类上单独一个意思
我们全都加上看看
可以看到成员变量跟方法上都可以使用这个注解
2. @Retention
同样有一个枚举属性
只有三个,这就是java代码三个阶段了 ,从上到下分别表示,源代码(.java), .class ,以及运行时阶段 ,我们自定义 一般都是 采用 RUNTIME
source: 字节码文件都不存在被描述的注解
class: 被描述的注解,会保留到class字节码文件,不会被JVM读取
runtime: 被描述的注解,会保留class字节码文件, 会被JVM读取
3. @Document :就使用前边的javadoc 命令,被注解的注解可以保存在java API文档中
4. @Inherited :就是子类也能获取父类 定义的 注解 属性的值
父类:
/** * @author java资讯 * @since 2011-11-24 */ @MyAnnotation(name = \"父类的zhangsan\") public class TestApi { }
子类:
package com.test1.api; public class Test2 extends TestApi{ public static void main(String[] args) { MyAnnotation annotation = Test2.class.getAnnotation(MyAnnotation.class); System.out.println(annotation.name()); } }
5. @Repeatable:可以重复使用一个注解
这个刚好也是前面没提到的 class 类型
没加之前
现在我们先定义一个容器注解,也就是注解 属性 是 注解数组
@Target(ElementType.TYPE) @Documented @Inherited @Retention(RetentionPolicy.RUNTIME) public @interface MyAnnotation2 { MyAnnotation[] value(); }
接着 加上
可以看到可以使用重复注解了
@MyAnnotation(name = \"zhangsan 1 \") @MyAnnotation(name = \"zhangsan 2\") public class TestApi { public static void main(String[] args) { MyAnnotation[] annotationsByType = TestApi.class.getAnnotationsByType(MyAnnotation.class); for (MyAnnotation an : annotationsByType) { System.out.println(an.name()); } } }
6. 类型注解
java8 新加的,在target 枚举属性中新加的枚举值,这两个
一般都是使用 TYPE_USER 就够了,表示注解可以使用在任何地方
比如:lombok 中的@ NonNull注解
我们就可以使用在参数前面
以上就是注解全部内容了,最后最后最后!!!别忘了,公众号回复【文档】 获取api ,感谢阅读
来源:https://www.cnblogs.com/zeroll/p/16996261.html
本站部分图文来源于网络,如有侵权请联系删除。