JAVA annotation入门基础
一. 最常见的annotation
•@override:用在方法之上,用来告诉别人这一个方法是改写父类的
•@deprecated:建议别人不要使用旧的api的时候用的,编译的时候会用产生警告信息,可以设定在程序里的所有的元素上.
•@suppresswarnings:暂时把一些警告信息消息关闭
•@entity:表示该类是可持久化的类
二. 设计一个自己的annotation
先看代码再讲话
1. 只有一个参数的annotation实现
package chb.test.annotation;
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 myannotation1 {
string value();
}
2. 有两个参数的annotation实现
package chb.test.annotation;
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.method)
@retention(retentionpolicy.runtime)
@documented
public @interface myannotation2 {
string description();
boolean isannotation();
}
3. annotation实验类
package chb.test.annotation;
@myannotation1("this is annotation1")
public class annotationdemo {
@myannotation2(description="this is annotation2",isannotation=true)
public void sayhello(){
system.out.println("hello world!");
}
}
4.annotation测试说明类
package chb.test.annotation;
import java.lang.reflect.method;
import org.junit.test;
public class testannotation {
@test
public void test() throws classnotfoundexception, securityexception, nosuchmethodexception{
class<?> cls = class.forname("chb.test.annotation.annotationdemo");
boolean flag = cls.isannotationpresent(myannotation1.class);
if(flag){
system.out.println("判断类是annotation");
myannotation1 annotation1 = cls.getannotation(myannotation1.class);
system.out.println(annotation1.value());
}
method method = cls.getmethod("sayhello");
flag = method.isannotationpresent(myannotation2.class) ;
if(flag){
system.out.println("判断方法也是annotation");
myannotation2 annotation2 = method.getannotation(myannotation2.class);
system.out.println(annotation2.description()+"/t"+annotation2.isannotation());
}
}
}
实验结果,控制台打出如下信息:
判断类是annotation
this is annotation1
判断方法也是annotation
this is annotation2 true
三.简介及说明
1. myannotation1中的@target(elementtype.type)
@target里面的elementtype是用来指定annotation类型可以用在哪些元素上的.例如:
type(类型)、field(属性)、method(方法)、parameter(参数)、constructor(构造函数)、local_variable(局部变量),、package(包),其中的type(类型)是指可以用在class,interface,enum和annotation类型上。
2. myannotation1中的@retention(retentionpolicy.runtime)
retentionpolicy 共有三种策略,分别为:
•source:这个annotation类型的信息只会保留在程序源码里,源码如果经过了编译之后,annotation的数据就会消失,并不会保留在编译好的.class文件里面
•class:这个annotation类型的信息保留在程序源码里,同时也会保留在编译好的.class文件里面,在执行的时候,并不会把这些信息加载到jvm中。注:默认策略为class类型
•runtime:表示在源码、编译好的.class文件中保留信息,在执行的时候会把这一些信息加载到jvm中去的
3. myannotation1中的@documented
目的就是将这一annotation的信息显示在java api文档上,如果没有增加@documented的话,java api文档上不会显示相关annotation信息
4. myannotation1中的@interface
关键字,表示该类为annotation定义
5. myannotation1中的 string value();
表示有一个成员参数,名字为value,访问权为默认(default)修饰符,注意以下两点:
•访问权只能用public和默认(default)修饰
•参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和string,enum,class,annotations等数据类型,以及这一些类型的数组
6.annotationdemo中的@myannotation1("this is annotation1")
因为myannotation1只有一个参数,因此可以直接在括号中写上value值。注:如果annotation只有一个参数,则建议最好将该参数名称定义为value
7.testannotation中的cls.isannotationpresent(myannotation1.class)
判断该类是否使用了myannotation1的注释
8. testannotation中的myannotation1 annotation1 = cls.getannotation(myannotation1.class)
返回该类针对myannotation1的注释
9. testannotation中的method.isannotationpresent(myannotation2.class)
判断该方法是否使用了myannotation2的注释