java高级特性--注解,这也许是最简单易懂的文章了

     2022-03-27     463

关键词:

博主在初学注解的时候看到网上的介绍大部分都是直接介绍用法或者功能,没有实际的应用场景,篇幅又很长导致学习的时候难以理解其意图,而且学完就忘QAQ。本篇文章中我将结合实际的应用场景尽可能由浅入深,平缓的介绍java注解。

java注解是jdk1.5以后新出的特性,对于它的应用非常广泛,我们首先来看一下注解的应用,百度百科上这样说:

技术分享图片

我们可以看到,注解的作用有三方面:

编写doc文档:这个就我们很常用的 @return 以及 @author,加了这些注解以后,就可以用jdk帮我们自动生成对应的API文档了

编译检查:这个也很常见 @Override,而且功能很强大,我将会在以后的文章中介绍

进行代码分析:这是本篇文章的重点。这个和编译检查一样也是一个强大的功能,但相比与编译检查由于其用到了反射,在性能上存在一些问题

后台开发中的SSH三大框架,以及咱们安卓端的retrofit,ButterKnife,Lombok等框架和插件也是大量的用到了注解。这里我将通过手撸一个假的ButterKnife来具体演示注解有什么用,怎么用。

我们首先来看段代码

public class MainActivity extends AppCompatActivity {

@OnClick(R.id.test_btn)
void test(){
    test_tv.setText("恭喜您,绑定成功了!");
}

@FindViewByID(R.id.test_tv)
TextView test_tv;

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    ButterKnife.bindView(this);
}
}

这是一个最基本的activity,里面有2个控件,Button和TextView

技术分享图片

在我点击Button后TextView的文字被改变。而我所做的仅仅是ButterKnife.bindView(this)并添加2个注解而已,这样就实现了控件的绑定,省去了很多与业务无关的代码,是不是简洁了很多。

看了注解的功能是不是很想了解它是怎么做到的,接下来我就来看看它是什么,怎么用,怎么利用

什么是注解

官方把它叫做元数据,即一种描述数据的数据。所以,可以说注解就是源代码的元数据。用它来可以来描述、标记我们的源代码。

怎样定义一个注解

以下是我上文中定义的一个 @OnClick注解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface OnClick {

int value() default 0;

}
可见和定义一个类一样,只是将class改为 @interface,并且顶部通过几个原注解来说明这个注解的一些重要信息,具体如下:

J2SE5.0版本在 java.lang.annotation提供了四种元注解,专门注解其他的注解:

@Documented –注解是否将包含在JavaDoc中
@Retention –什么时候使用该注解
@Target? –注解用于什么地方
@Inherited – 是否允许子类继承该注解

@Documented–一个简单的Annotations标记注解,表示是否将注解信息添加在java文档中,一般不用管。

@Retention– 定义该注解的生命周期,很重要,必须指定,以下是3种生命周期的介绍

RetentionPolicy.SOURCE – 在编译阶段丢弃。这些注解在编译结束之后就不再
有任何意义,所以它们不会写入字节码。@Override, @SuppressWarnings都属
于这类注解。
RetentionPolicy.CLASS – 在类加载的时候丢弃。在字节码文件的处理中有用。
注解默认使用这种方式。
RetentionPolicy.RUNTIME– 始终不会丢弃,运行期也保留该注解,因此可以使
用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。

@Target – 表示该注解用于什么地方。如果不明确指出,该注解可以放在任何地方。以下是一些可用的参数。需要说明的是:属性的注解是兼容的,如果你想给7个属性都添加注解,仅仅排除一个属性,那么你需要在定义target包含所有的属性。

ElementType.TYPE:用于描述类、接口或enum声明
ElementType.FIELD:用于描述实例变量
ElementType.METHOD
ElementType.PARAMETER
ElementType.CONSTRUCTOR
ElementType.LOCAL_VARIABLE
ElementType.ANNOTATION_TYPE 另一个注释
ElementType.PACKAGE 用于记录java文件的package信息

@Inherited – 定义该注释和子类的关系

那么注解体里的内容有该怎样定义

Annotations只支持基本类型、String及枚举类型。注释中所有的属性被定义成方法,并允许提供默认值。

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@interface Book{
public enum Priority {LOW, MEDIUM, HIGH}
String author() default "Yash";
int price() default 20;
Status status() default Status.NOT_STARTED;
}

看看怎么用它

@Todo(priority = Todo.Priority.MEDIUM, author = "zsq", status = 
Todo.Status.STARTED)
public void incompleteMethod1() {

}

通过字段名 = 的形式给字段赋值,如果没赋值,则使用缺省值。如果注解中只有一个属性,可以直接命名为“value”,使用时无需再标明属性名,例如我定义的 @OnClick注解。

好了,花了那么多精力来认识他,该看看该怎么来利用它了

我们定义了自己的注解并将其应用在业务逻辑的方法上。现在我们需要写一个用户程序调用我们的注解。这里我们需要使用反射机制。如果你熟悉反射代码,就会知道反射可以提供类名、方法和实例变量对象。所有这些对象都有getAnnotation()这个方法用来返回注解信息。我们需要把这个对象转换为我们自定义的注释(使用 instanceOf()检查之后),同时也可以调用自定义注释里面的方法。

所有这些对象都有getAnnotation()!
所有这些对象都有getAnnotation()!
所有这些对象都有getAnnotation()!

重要的API说3遍,另外用到的几个方法也很重要,下面的代码会演示,更多的API使用参考可以去查阅JDK文档。

具体到我们本编文章的实例,调用注解的家伙就是我们刚刚在MainActivity里用到的 ButterKnife,我们通过设置监听的注解来看看它到底做了什么

public static final void bindView(final Activity activity){
    traversalMethod(activity);
    traversalField(activity);
}

在我们调用的ButterKnife.bindView(this)中我们拿到了MainActivity的实例,并且通过反射遍历里面所有的方法:

private static void traversalMethod(final Activity activity) {
    Method[] methodArray = getObjectMethodArray(activity);
    for (final Method method:methodArray){
        if(isAnnotationPresent(method)){

            int viewID = getViewID(method);

            setOnClickListenerForControl(activity, method, viewID);

        }
    }
}

private static Method[] getObjectMethodArray(Activity activity) {
    return activity.getClass().getMethods();
}

接着判断方法是否被我们注解:

private static boolean isAnnotationPresent(Method method) {
    return method.isAnnotationPresent(OnClick.class);
}

如果是我们用注解标注的方法则通过注解获取注解里保存的空间ID,并且通过MainActivity的实例为其设置点击监听,在监听内调用被注解标注的方法。

private static int getViewID(Method method) {
    return method.getAnnotation(OnClick.class).value();
}

private static void setOnClickListenerForControl(final Activity activity, final Method method, int viewID) {
    activity.findViewById(viewID).setOnClickListener(new View.OnClickListener() {
        @Override
        public void onClick(View view) {

            try {
                method.invoke(activity);
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            } catch (InvocationTargetException e) {
                e.printStackTrace();
            }
        }

    });
}

大功告成!是不是很简单

我们用反射获取注解的方式实现了ButterKnife的功能,但文章开头说过反射的存在性能上的不足。而实际上ButterKnife本身用的也不是反射,而是用的apt工具在编译时期就可以获取到所有的方法、字段、以及他们的注解,从而避免了使用反射,解决了性能的问题。接下来的文章我会讲解本文开头提到的第三点,也就是ButterKnife实际使用的方法,将我们自己的ButterKnife改为ButterKnife官方的实现方法。

以下github地址是本篇文章讲解用到的demo:
https://github.com/sally519/MyButterKnief

文章很长,希望看完的人能收获点东西
作者水平有限,如有遗漏和错误,欢迎指正!

java高级特性第6节注解(初步认识)

转自https://www.cnblogs.com/xdp-gacl/p/3622275.html 的博客一、认识注解  注解(Annotation)很重要,未来的开发模式都是基于注解的,JPA是基于注解的,Spring2.5以上都是基于注解的,Hibernate3.x以后也是基于注解的,现在的Struts2有一部分... 查看详情

java高级特性-注解:注解实现excel导出功能(代码片段)

注解是Java的一个高级特性,Spring更是以注解为基础,发展出一套“注解驱动编程”。这听起来高大上,但毕竟是框架的事,我们也能用好注解吗?的确,我们很少有机会自己写注解,导致我们搞不清楚注解是怎么回事,更别提... 查看详情

Java中最简单易懂的volatile关键字示例

】Java中最简单易懂的volatile关键字示例【英文标题】:SimplestandunderstandableexampleofvolatilekeywordinJava【发布时间】:2013-07-1820:33:26【问题描述】:我正在阅读Java中的volatile关键字并完全理解它的理论部分。但是,我正在寻找的是一... 查看详情

史上最简单的springcloud教程|第三篇:服务消费者(feign)

...Feign,只需要创建一个接口并注解。它具有可插拔的注解特性,可使用Feign注解和JAX-RS注解。Feign支持可插拔的编码器和解码器。Feign默认集成了Ribbon,并和E 查看详情

spring的自动装配及注解开发(“最易懂得spring学习”)(代码片段)

...xff1a;🍣今天我们来学习一下自动装配的集中方式以及注解开发\\textcolorgreen今天我们来学习一下自动装配的集中方式以及注解开发今天我们来学习一下自动装配的集中方式以及注解开发🍣🍣同时我们也了解一下使用ja... 查看详情

(最简单易懂的实现)pat甲级--stack(30)(代码片段)

文章目录题目题目分析代码详解栈的数据结构实现输入数据和问题解决处理整合代码进行提交更多PAT甲级题解–acking-you.gtihub.io题目OJ平台题目分析关键就是要我们实现以下这个操作:PeekMedian–returnthemedianvalueofalltheelementsinthe... 查看详情

rabbitmq高级特性之ttl存活时间/过期时间通俗易懂超详细内含案例(代码片段)

RabbitMq高级特性之TTL存活时间/过期时间每条消息设置过期时间整个Queue队列设置过期时间前提完成RabbitMq高级特性之消费端限流一、每条消息设置过期时间1.更改ProducerTest.java文件importlombok.extern.slf4j.Slf4j;importorg.junit.Test;importorg.juni... 查看详情

有没有简单易懂不枯燥的java入门教程?

...是因为大家没有找对合适的教程。我给大家找来了前腾讯高级Java工程师主讲的《Ja 查看详情

java系书籍,,,,,,,,,,,,,

...磨~~Java1.《Java核心技术卷1基础知识》2.《Java核心技术卷II高级特性》Java领域最有影响力和价值的著作之一。其中《卷1》主讲基础知识,全面讲解Java语言的核心概念、语法、重要特性和开发方法,是Java入门必备,重在理论,可... 查看详情

rabbitmq高级特性之死信队列通俗易懂超详细内含案例(代码片段)

RabbitMq高级特性之死信队列又称死信交换机DLX当消息成为Deadmessage后,会重新发送到另一个交换机,这个交换机就是DLX消息成为死信的情况公有三种:队列消息长度达到限制消费者拒接消费消息basicNack/basicReject,并且不把消息重新放回... 查看详情

java高级特性:clone()方法

目录源码深拷贝和浅拷贝对象串行化实现拷贝常见面试题源码publicclassObjcet{protectednativeObjectclone()throwsCloneNotSupportedException();}由源码可知。第一:Objcet类的clone()方法是一个native方法。native方法的执行效率一般远高于Java中的非native... 查看详情

rabbitmq高级特性之延迟队列通俗易懂超详细内含案例

RabbitMq高级特性之延迟队列消息进入队列后不能立即被消费,到达指定时间后才可被消费实现结合以下两种即可达到延迟队列RabbitMq高级特性之TTL过期时间RabbitMq高级特性之DLX死信队列延迟队列小结延迟队列指消息进入队列后,经过... 查看详情

js回调函数--简单易懂有实例

版权声明:本文为博主原创文章,未经博主允许不得转载   初学js的时候,被回调函数搞得很晕,现在回过头来总结一下什么是回调函数。  我们先来看看回调的英文定义:Acallbackisafunctionthatispassedasanargumenttoanotherfunction... 查看详情

java8新特性

现在,是时候把所有Java 8的重要特性收集整理成一篇单独的文章了,希望这篇文章能给你带来阅读上的乐趣。开始吧!目录结构介绍Java语言的新特性2.1 Lambdas表达式与Functional接口2.2 接口的默认与静态方法2.3 方法... 查看详情

3.java高级特性熟悉网络编程(简单原理)

Java高级特性–网络编程利用网络都能做些什么DNS:DomainNameSystem,域名解析系统DNS是一个分布式服务器系统,实现了域名和ip地址的隐射我们请求域名(www.baidu.com),会先进行DNS的解析,得到ip地址后,继续请... 查看详情

求最短路径长度--简单易懂

求任意两个节点之间的最短路径长度(只给出路径长度,不能求出路过的节点): 傻子也能看懂的弗洛伊德算法(转)求一个节点到其他节点的最短路径长度: 傻子也能看懂的迪杰斯特拉算法(转) 查看详情

[译]houdini:也许是你未曾听过的最振奋人心的css进化

...的专栏,未完待续……你是否曾经想要使用一些特别的CSS特性,却因为未曾得到所有浏览器的支持而选择放弃?又或者是,这些特性得到了所有浏览器的支持,但总会伴随着奇怪的bug,表现不一致甚至相互矛盾?如果这些事情都... 查看详情

高级特性三种工厂模式

简单工厂模式是属于创建型模式,又叫做静态工厂方法(StaticFactoryMethod)模式,但不属于23种GOF设计模式之一。简单工厂模式是由一个工厂对象决定创建出哪一种产品类的实例。简单工厂模式是工厂模式家族中最简单实用的模式... 查看详情