前言
本篇文章讲述java中注解的概念和注解的基础用法,文章中举例用到的注解、元注解只是一部分,平时工作中用到过,有错误或新的见解,请指出。
注解概念
注解你可以理解为是某个类、某个方法的标签,有了这个标签(注解),就具备了某一个功能,举个例子,我们有一个类实现一个接口中的方法,在继承的方法上面都会有@Override
的注解,就代表了这个方法是属于继承方法;或者在方法使用@Deprecated
注解,就表示该方法已经过期,调用的时候方法上会有中划线的提示。以上例子只是标识注解,还有更多的带有成员或者自定义的注解,往下慢慢看来了解吧。
注解的分类
- jdk中的注解
例:@Override、@Deprecated等
- 来自第三方的注解
例:Retrofit中的@GET、@POST,Spring中的@Autowired等
- 自定义注解
根据原则定义自己需求的注解
上面说的三种注解的分类,jdk中的注解,需要我们去查看api文档,逐个了解,这里不多做赘述,第三方的注解,也是属于自定义注解,是一些优秀的框架中定义的注解,我们在平时的工作中会经常用到,举例的Retrofit是Android中应用非常广泛的网络框架;而spring则是java后台常用的。最后一个自定义注解,就是我们今天主要要了解和学习的,看看怎样去定义一个注解。
自定义注解原则
使用@interface关键字定义注解
成员以无参无异常的方式声明
可以用default为成员设置默认值
添加元注解(下面会做单独的介绍)
示例:
1 |
|
注解中成员变量的规则要求
在注解中声明的成员变量是有类型限制的,合法的类型包括基本数据类型及String、Class、Annotation、Enumeration,一般我们常用到就是基本数据类型和String
如果注解中只有一个成员,则方法名必须要写成
value()
,在使用的时候就可以忽略掉方法名和赋值符号(就是=)
示例:定义
1 |
|
- 在注解中可以没有成员,没有成员的注解称为标识注解,就类似于jdk中的
@Override、@Deprecated
元注解:注解的注解
我们看到在定义自定义注解的时候,上面定义了一些@Target、@Inherited
等字段,它们有什么作用呢?看看下面的解释
@Target注解
Target注解可以规定在哪些地方使用
Target定义的成员类型是ElementType数组,Target中可以传入多个参数
1 |
|
- 参数的类型
1 | //使用的jdk8中的ElementType 在8之前没有TYPE_PARAMETER和TYPE_USE两个参数值 |
- 示例:
@Target({METHOD,TYPE})
表示可以作用于方法、类、接口等
@Retention注解
Retention指的是该注解的生命周期
参数类型
1 |
|
@Inherited注解
Inherited表示允许子类继承
属于标识注解
@Documented注解
生成javadoc时会包含注解的信息
属于标识注解
自定义注解用法:
1 |
|
下面我们就用一个简单的小demo来演示一下注解的具体使用
代码实例
定义只有一个成员的注解
1 | @Documented |
使用注解
1 |
|
在运行时解析注解
1 | public class myClass { |
输出结果
参考
本篇文章是根据慕课网java注解完全解析,总结出来的笔记,想更细致的了解注解的使用,可移步到慕课网去观看视频,另外还有一篇大神讲解的深入简出、通俗易懂,也可一并观摩。