如何理解Java注解编程
本篇内容主要讲解“如何理解Java注解编程”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“如何理解Java注解编程”吧!
创新互联秉承实现全网价值营销的理念,以专业定制企业官网,做网站、网站设计,微信小程序定制开发,网页设计制作,成都做手机网站,网络营销推广帮助传统企业实现“互联网+”转型升级专业定制企业官网,公司注重人才、技术和管理,汇聚了一批优秀的互联网技术人才,对客户都以感恩的心态奉献自己的专业和所长。
注解是什么
实现格式
从代码来看我们知道注解的实现格式是:
public @interface MyAnnotation{ 属性列表; }
所以我们有了第一直觉,注解可能是一个接口。通过查询资料得知(可以通过反编译软件),实际上 @interface 是自定义接口对 annotation 接口的继承,@interface 实际是一个语法糖。
import java.lang.annotation.Annotation; public interface MyAnnotation extends Annotation{ 属性列表; }
使用位置
类、方法、成员变量、形参位置。
分类
不同角度,我们对注解能有不同的分类,但知道了注解的实现原理后就会明白,实际上用法和实现方法都是一回事。
来源
1. JDK注解:一般都是在编译时起用作的注解,比如我们最为熟悉的 @Override。
2. 第三方框架注解
3. 自定义注解
运行机制(保留策略)
@Retention({保留策略}) public @interface MyAnnotation{ 属性列表; }
1.源码(SOURCE)注解:注解只在源码中存在,编译成.class文件就不存在了,也就是说只能起到 “看” 的作用。
2.编译(CLASS)注解:注解在源码和.class文件中都存在(JDK自带注解都属于编译时注解),一般用来作语法校验。
3.运行(RUNTIME)注解:在运行阶段还起作用,甚至会影响运行逻辑的注解(@Autowired属于运行时注解),第三方框架和自定注解一般采用 runtime 的保留策略,能实现依赖注入、切面编程等功能。
元注解
实际在上面,我们已经看到一个元注解了(@Retention)。元注解就是加在注解上描述注解的注解。 一共有5个。
1. @Documented
在生成javadoc的时候就会把@Documented注解给显示出来。
2. @Target(关键)
限定作用位置,Method、Class等等。
9. @Inherited
被 @Inherited 注解的注解修饰了一个父类,如果他的子类没有被其他注解修饰,则它的子类也继承了父类的注解。
10. @Retention(关键)
上文的保留策略注解,影响注解作用。
6. @Repeatable (不重要)
@Repeatable 注解是用于声明其它类型注解的元注解,来表示这个声明的注解是可重复的。@Repeatable的值是另一个注解,其可以通过这个另一个注解的值来包含这个可重复的注解。
如何使用
我们先来了解一下注解粗浅的使用。最简单的,
使用自定义注解就是分为三步:定义注解、使用注解、读取注解。
摘自:https://www.zhihu.com/question/47449512/answer/658228092
我们只要牢牢地把握住这三步,就能掌握注解的使用。
定义注解
因为,注解的基本作用是根据注解中的值,判断该如何执行被注解代码块。所以,在定义注解时,除了要根据功能加元注解外,还要根据业务意义,编写合适的方法名称。
比如,如果我们要编写一个锁注解:
@Documented @Retention(RUNTIME) @Target({TYPE, METHOD}) public @interface Lock { //输锁名称 String lockName(); //被锁值 String key(); //锁级别 int level(); //异常 String exception() default ""; }
在一个注解中,能够返回的类型有:基本数据类型、String、enum、Class、其他注解以及前几者的一维数组。
注意: 如果没有 default,那么使用时就必须要入参。
使用注解
注解在该注解的地方,入参必入参的参数。
Tips:如果注解中只有一个函数,虽然使用时候不需要加函数名称就可以直接入参,但个人建议对于自定义注解,在入参时,还是将函数名称写全,增强代码可读性。
读取注解
我们先想一想,如果是我们自己实现一个注解读取的方法,我们该怎么来实现呢?
目前我想到的无非就是两个:
1. 在字符串或字节码文件中找注解:这个判断可不好写啊,而且复杂字符串处理不了。
2. 通过反射获得类、方法、成员变量上的注解。
明眼人就能看出来 2 比 1 靠谱多了,而且还容易实现。
最简单的一种读取方式:
public static void main(String[] args) throws NoSuchMethodException { ClassmodelClazz = Module.class; Method method = modelClazz.getMethod("lock", null); Lock annotationLock = method.getAnnotation(Lock.class); //获取注解在 lock 方法上的 value String lockName = annotationLock.lockName(); }
这也是框架注解的基本实现原理,因为要获取注解的具体代码块,所以一般需要扫描包。
对于切面编程,引入依赖 aspectj 后,那我们就有了更简单的调用方法:
//切面代码节选 public Object around(ProceedingJoinPoint pjp) throws Throwable { MethodSignature signature = (MethodSignature) pjp.getSignature(); Lock lock = signature.getMethod().getAnnotation(Lock.class); lock.lockName(); }
具体关于切面编程与 joinpoint 的知识,可以参考:
https://blog.csdn.net/qq_15037231/article/details/80624064
注解的作用
至此我们可以总结出注解的作用。
* 编程提示
保留策略为源码的注解,一般为提示性注解,比如 @deprecated。
* 用于切面,减少重复代码
保留策略为运行的注解,0入侵改变函数的运行效果,一般用于重复性功能,比如日志输出、数据格式校验等。
* 简化配置信息,项目结构
主要是对于 springboot 这个框架的作用。因为注解可以取值,所以在设置默认配置信息的同时,也支持输入配置信息。
* 格式校验
一般为代码的语法检验,存在与 jdk 的注解包中,比如 @Override。
到此,相信大家对“如何理解Java注解编程”有了更深的了解,不妨来实际操作一番吧!这里是创新互联网站,更多相关内容可以进入相关频道进行查询,关注我们,继续学习!
名称栏目:如何理解Java注解编程
本文地址:http://azwzsj.com/article/iiehcc.html