java中的注解详解和自定义注解
一、java中的注解详解
1、什么是注解
用一个词就可以描述注解,那就是元数据,即一种描述数据的数据。所以,可以说注解就是源代码的元数据。比如,下面这段代码:
@Override public String toString() { return "This is String Representation of current object."; }
上面的代码中,我重写了toString()方法并使用了@Override注解。但是,即使我不使用@Override注解标记代码,程序也能够正常执行。那么,该注解表示什么?这么写有什么好处吗?事实 上,@Override告诉编译器这个方法是一个重写方法(描述方法的元数据),如果父类中不存在该方法,编译器便会报错,提示该方法没有重写父类中的方法。如果我不小心拼写错误,例如将toString()写成 了 toStrring(){double r},而且我也没有使用@Override注解,那程序依然能编译运行。但运行结果会和我期望的大不相同。现在我们了解了什么是注解,并且使用注解有助于阅读程序。
Annotation是一种应用于类、方法、参数、变量、构造器及包声明中的特殊修饰符。它是一种由JSR-175标准选择用来描述元数据的一种工具。
2、为什么要使用注解
使用Annotation之前(甚至在使用之后),XML被广泛的应用于描述元数据。不知何时开始一些应用开发人员和架构师发现XML的维护越来越糟糕了。他们希望使用一些和代码紧耦合的东西,而不是像 XML那样和代码是松耦合的(在某些情况下甚至是完全分离的)代码描述。
假如你想为应用设置很多的常量或参数,这种情况下,XML是一个很好的选择,因为它不会同特定的代码相连。如果你想把某个方法声明为服务,那么使用Annotation会更好一些,因为这种情况下需 要注解和方法紧密耦合起来,开发人员也必须认识到这点。
另一个很重要的因素是Annotation定义了一种标准的描述元数据的方式。在这之前,开发人员通常使用他们自己的方式定义元数据。例如,使用标记interfaces,注释,transient关键字等等。每个程序 员按照自己的方式定义元数据,而不像Annotation这种标准的方式。
3、注解的基本语法
jdk1.5版本内置了三种标准的注解:
J2SE5.0版本在 java.lang.annotation提供了四种元注解,专门注解其他的注解:
(1)、@Target:
表示该注解可以用于什么地方,可能的ElementType参数有: CONSTRUCTOR
:构造器的声明 FIELD
:域声明(包括enum
实例) LOCAL_VARIABLE
:局部变量声明 METHOD
:方法声明 PACKAGE
:包声明 PARAMETER
:参数声明 TYPE
:类、接口(包括注解类型)或enum
声明
(2)、@Retention:
表示需要在什么级别保存该注解信息。可选的RetentionPolicy参数包括: SOURCE
:注解将被编译器丢弃 CLASS
:注解在class文件中可用,但会被VM丢弃 RUNTIME
:VM将在运行期间保留注解,因此可以通过反射机制读取注解的信息
(3)、@Document: 将注解包含在Javadoc中
(4)、@Inherited: 允许子类继承父类中的注解
二、自定义注解
1、利用元注解定义自己的注解
@Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) public @interface ReqValue { String values() default ""; }
这里,我们定义了一个注解,其中有一个属性,从元注解可看出此注解作用于属性。
2、定义一个类,并利用此注解
public class User { @ReqValue(values = "张三") private String userName; @ReqValue(values = "123") private String password; public String getUserName() { return userName; } public void setUserName(String userName) { this.userName = userName; } public String getPassword() { return password; } public void setPassword(String password) { this.password = password; } }
在这里,我们在User的属性上利用自定义的注解为其赋值。而这个值怎么获取到呢,下面第三步
3、我们写一个测试方法
@Test public void reqValueTest() { Class<User> userClass = User.class; //获得User类的所有属性信息 Field[] fields = userClass.getDeclaredFields(); //获得类中所有属性的注解信息 for (Field field : fields) { if (field.isAnnotationPresent(ReqValue.class)) { // 如果属性中包含ReqValue注解 ReqValue reqValue = field.getAnnotation(ReqValue.class);// 获取属性中的ReqValue注解 System.out.println(field.getName() + "值为:" + reqValue.values());// 取值 } } }
结合反射,便可以轻易的得到注解的内容,从而让注解生效。
运行结果:
userName值为:张三
password值为:123
当然这里,我们只是演示一下注解怎么用,并没有发挥出注解的强大功能。小伙伴们可以根据自己的实际情况灵活的使用注解。
以上就是关于java中注解的简单介绍,希望能给读到的每个人提供帮助,如有有纰漏,欢迎指正。