1、什么是java注解
注解,顾名思义,注解,就是对某一事物进行加入凝视说明,会存放一些信息。这些信息可能对以后某个时段来说是非常实用处的。 java提供了一套注解机制,使得我们能够对方法、类、參数、包、域以及变量等加入标准(即附上某些信息)。且在以后某个时段通过反射将标注的信息提取出来以供使用。
2、jdk提供的基本注解
a. @suppresswarnings 该注解的作用是阻止编译器发出某些警告信息。它能够有下面參数:
deprecation:过时的类或方法警告。
unchecked:运行了未检查的转换时警告。
fallthrough:当switch程序块直接通往下一种情况而没有break时的警告。
path:在类路径、源文件路径等中有不存在的路径时的警告。
serial:当在可序列化的类上缺少serialversionuid定义时的警告。
finally:不论什么finally子句不能完毕时的警告。
all:关于以上全部情况的警告。
b.@deprecated 该注解的作用是标记某个过时的类或方法。
c. @override 该注解用在方法前面,用来标识该方法是重写父类的某个方法。
3、元注解
a. @retention 它是被定义在一个注解类的前面,用来说明该注解的生命周期。它有下面參数:
retentionpolicy.source:指定注解仅仅保留在一个源文件其中。
retentionpolicy.class:指定注解仅仅保留在一个class文件里。
retentionpolicy.runtime:指定注解能够保留在程序执行期间。
b. @target 它是被定义在一个注解类的前面,用来说明该注解能够被声明在哪些元素前。
它有下面參数:
elementtype.type:说明该注解仅仅能被声明在一个类前。
elementtype.field:说明该注解仅仅能被声明在一个类的字段前。
elementtype.method:说明该注解仅仅能被声明在一个类的方法前。
elementtype.parameter:说明该注解仅仅能被声明在一个方法參数。
elementtype.constructor:说明该注解仅仅能声明在一个类的构造方法前。
elementtype.local_variable:说明该注解仅仅能声明在一个局部变量前。
elementtype.annotation_type:说明该注解仅仅能声明在一个注解类型前。
elementtype.package:说明该注解仅仅能声明在一个包名前。
4、注解的生命周期
一个注解能够有三个生命周期,它默认的生命周期是保留在一个class文件,但它也能够由一个@retetion的元注解指定它的生命周期。
a.java源文件 当在一个注解类前定义了一个@retetion(retentionpolicy.source)的注解,那么说明该注解仅仅保留在一个源文件其中。当编译器将源文件编译成class文件时,它不会将源文件里定义的注解保留在class文件里。
b. class文件里 当在一个注解类前定义了一个@retetion(retentionpolicy.class)的注解。那么说明该注解仅仅保留在一个class文件其中,当载入class文件到内存时,虚拟机会将注解去掉,从而在程序中不能訪问。
c. 程序执行期间 当在一个注解类前定义了一个@retetion(retentionpolicy.runtime)的注解,那么说明该注解在程序执行期间都会存在内存其中。此时,我们能够通过反射来获得定义在某个类上的全部注解。
5、注解的定义
一个简单的注解:
public @interface annotation01{
//定义公共的final静态属性.....
//定以公共的抽象方法......
}
a.注解能够有哪些成员 注解和接口相似。它仅仅能定义final静态属性和公共抽象方法。
b.注解的方法
1.方法前默认会加上public abstract
2.在声明方法时能够定义方法的默认返回值。 比如: stringcolor()default"blue"; string[]color()default{"blue","red",......}
3.方法的返回值能够有哪些类型 8种基本类型,string、class、枚举、注解及这些类型的数组。
c.使用注解(參照以下的注解使用)注解的使用分为三个过程。
定义注解-->声明注解-->得到注解
a.定义注解(參照上面的注解定义)
b.声明注解
1.在哪些元素上声明注解 假设定义注解时没有指定@target元注解来限制它的使用范围。那么该注解能够使用在elementtype枚举指定的不论什么一个元素前。
否则。仅仅能声明在@target元注解指定的元素前。 一般形式: @注解名()
2.对注解的方法的返回值进行赋值 对于注解中定义的每个没有默认返回值的方法。在声明注解时必须对它的每个方法的返回值进行赋值。
一般形式: @注解名(方法名=方法返回值。、、、、、、) 假设方法返回的是一个数组时。那么将方法返回值写在{}符号里 @注解名(方法名={返回值1,返回值2,、、、、、、},、、、、、、、)
3.对于仅仅含有value方法的注解,在声明注解时能够仅仅写返回值。
c.得到注解 对于生命周期为执行期间的注解。都能够通过反射获得该元素上的注解实例。
1、声明在一个类中的注解 能够通过该类class对象的getannotation或getannotations方法获得。
2、声明在一个字段中的注解 通过field对象的getannotation或getannotations方法获得
3、声明在一个方法中的注解 通过method对象的getannotation或getannotations方法获得
6、样例
以下讲的设计一个最简单的annotation样例,这一样例共用四个文件;
1、description.java
java代码
package lighter.javaeye.com;
import java.lang.annotation.documented;
import java.lang.annotation.elementtype;
import java.lang.annotation.retention;
import java.lang.annotation.retentionpolicy;
import java.lang.annotation.target;
@target(elementtype.type)
@retention(retentionpolicy.runtime)
@documented
public @interface description {
string value();
}
说明:全部的annotation会自己主动继承java.lang.annotation这一个接口,所以不能再去继承别的类或是接口.
最重要的一点,annotation类型里面的參数该怎么设定:
第一,仅仅能用public或默认(default)这两个訪问权修饰.比如,string value();这里把方法设为defaul默认类型.
第二,參数成员仅仅能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和string,enum,class,annotations等数据类型,以及这一些类型的数组.比如,string value();这里的參数成员就为string.
第三,假设仅仅有一个參数成员,最好把參数名称设为"value",后加小括号.例:上面的样例就仅仅有一个參数成员.
2、name.java
//注意这里的@target与@description里的不同,參数成员也不同
@target(elementtype.method)
public @interface name {
string originate();
string community();
3、javaeyer.java
@description("javaeye,做最优秀的软件开发交流社区")
public class javaeyer {
@name(originate="创始人:robbin",community="javaeye")
public string getname()
{
return null;
}
@name(originate="创始人:江南白衣",community="springside")
public string getname2()
return "借用两位的id一用,写这一个样例,请见谅!";
4、最后,写一个能够执行提取javaeyer信息的类testannotation
package lighter.javaeye.com;
import java.lang.reflect.method;
import java.util.hashset;
import java.util.set;
public class testannotation {
/**
* author lighter
* 说明:详细关天annotation的api的使用方法请參见javadoc文档
*/
public static void main(string[] args) throws exception {
string class_name = "lighter.javaeye.com.javaeyer";
class test = class.forname(class_name);
method[] method = test.getmethods();
boolean flag = test.isannotationpresent(description.class);
if(flag)
{
description des = (description)test.getannotation(description.class);
system.out.println("描写叙述:"+des.value());
system.out.println("-----------------");
}
//把javaeyer这一类有利用到@name的所有方法保存到set中去
set<method> set = new hashset<method>();
for(int i=0;i<method.length;i++)
boolean otherflag = method[i].isannotationpresent(name.class);
if(otherflag) set.add(method[i]);
for(method m: set)
name name = m.getannotation(name.class);
system.out.println(name.originate());
system.out.println("创建的社区:"+name.community());
}
5、执行结果:
描写叙述:javaeye,做最优秀的软件开发交流社区
-----------------
创始人:robbin
创建的社区:javaeye
创始人:江南白衣
创建的社区:springside