注解的作用
程序员文章站
2022-05-03 22:25:56
1. 编译检查 Annotation具有“让编译器进行编译检查的作用”。 例如,@SuppressWarnings, @Deprecated和@Override都具有编译检查作用。 2. 在反射中使用Annotation 在反射的Class, Method, Field等函数中,有许多于Annota ......
- 编译检查
annotation具有“让编译器进行编译检查的作用”。
例如,@suppresswarnings, @deprecated和@override都具有编译检查作用。 - 在反射中使用annotation
在反射的class, method, field等函数中,有许多于annotation相关的接口。
这也意味着,我们可以在反射中解析并使用annotation。 - 根据annotation生成帮助文档
通过给annotation注解加上@documented标签,能使该annotation标签出现在javadoc中。 - 能够帮忙查看查看代码
通过@override, @deprecated等,我们能很方便的了解程序的大致结构。
另外,我们也可以通过自定义annotation来实现一些功能。
5.注解处理器
如果没有用来读取注解的方法和工作,那么注解也就不会比注释更有用处了。使用注解的过程中,很重要的一部分就是创建于使用注解处理器。java se5扩展了反射机制的api,以帮助程序员快速的构造自定义注解处理器。 - 在框架中的作用
在开发java程序,尤其是java ee应用的时候,总是免不了与各种配置文件打交道。以java ee中典型的s(pring)s(truts)h(ibernate)架构来说,spring、struts和hibernate这三个框架都有自己的xml格式的配置文件。这些配置文件需要与java源代码保存同步,否则的话就可能出现错误。而且这些错误有可能到了运行时刻才被发现。把同一份信息保存在两个地方,总是个坏的主意。理想的情况是在一个地方维护这些信息就好了。其它部分所需的信息则通过自动的方式来生成。jdk 5中引入了源代码中的注解(annotation)这一机制。注解使得java源代码中不但可以包含功能性的实现代码,还可以添加元数据。注解的功能类似于代码中的注释,所不同的是注解不是提供代码功能的说明,而是实现程序功能的重要组成部分。java注解已经在很多框架中得到了广泛的使用,用来简化程序中的配置。
因为注解大多都有自己的配置参数,而配置参数以名值对的方式出现,所以从某种角度来说,可以把注解看成是一个xml元素,该元素可以有不同的预定义的属性。而属性的值是可以在声明该元素的时候自行指定的。在代码中使用注解,就相当于把一部分元数据从xml文件移到了代码本身之中,在一个地方管理和维护。
上面两段话其实已经阐述了java注解的主要作用之一,就是跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring等框架中的基于注解配置。现在的框架很多都使用了这种方式来减少配置文件的数量。基本上秉持着这么一个原则,与具体场景相关的配置应该使用注解的方式与数据关联,与具体场景无关的配置放于配置文件中。在另一方面我们还可以在通过设置注解的@retention 级别在运行时使用反射对不同的注解进行处理。
怎么使用呢?
例子:先利用反射,获取到注解,然后把利用注解实例化该类的对象
下面有一个例子:(自己写的哦)
定义一个注解
@target(elementtype.type) @retention(retentionpolicy.runtime) @documented public @interface fruitprovider { /*供应商编号*/ public int id() default -1; /*供应商名称*/ public string name() default ""; /*供应商地址*/ public string address() default ""; }
对一个类使用注解
@fruitprovider(id = 1728, name = "why", address = "shenzhen") public class apple { private int appleid; private string appleprovidername; private string appleprovideraddress; public int getappleid() { return appleid; } public void setappleid(int appleid) { this.appleid = appleid; } public string getappleprovidername() { return appleprovidername; } public void setappleprovidername(string appleprovidername) { this.appleprovidername = appleprovidername; } public string getappleprovideraddress() { return appleprovideraddress; } public void setappleprovideraddress(string appleprovideraddress) { this.appleprovideraddress = appleprovideraddress; } }
注解处理器
public class fruitinfoutil { public static apple getaapple(class<?> clazz) throws exception{ fruitprovider fb = clazz.getannotation(fruitprovider.class);//通过反射获取处理注释 //通过newinstance()生成apple实例,利用反射的结果进行设置 apple ap = (apple)clazz.newinstance(); ap.setappleid(fb.id()); ap.setappleprovidername(fb.name()); ap.setappleprovideraddress(fb.address()); return ap; } }
public class main { public static void main(string[] args) throws exception{ apple a = fruitinfoutil.getaapple(apple.class); system.out.println("苹果商的id为:"+a.getappleid()); system.out.println("苹果商的名字为:"+a.getappleprovidername()); system.out.println("苹果商的地址为:"+a.getappleprovideraddress()); } }
这个实例就很好的说明,现在的框架很多都使用了这种方式来减少配置文件的数量。(因为配置就在代码里面了)。
部分来源:简书[alexirc]
上一篇: asp.net core 之中间件
下一篇: 工厂模式的一个简单实现