Java中注解

  参考:http://yuxingxing1988.iteye.com/blog/1605748


1.什么是注解

  就是对某一事物进行添加注释说明,会存放一些信息,这些信息可能对以后某个时段来说是很有用处的。 

  java提供了一套机制,使得我们可以对方法、类、参数、包、域以及变量等添加标准(即附上某些信息)。且在以后某个时段通过反射将标注的信息提取出来以供使用。 


2.为什么要使用自定义注解

  Java从1.5版本以后默认内置三个标注: 
    @Override:只能用在方法之上的,用来告诉别人这一个方法是改写父类的。 
    @Deprecated:建议别人不要使用旧的API的时候用的,编译的时候会用产生警告信息,可以设定在程序里的所有的元素上. 
    @SuppressWarnings:这一个类型可以来暂时把一些警告信息消息关闭. 
  但是,仅仅这三个标注是不能满足我们开发时一些需求的。所以java允许我们自定义注解来使用。 


3.如何自定义注解 

  自定义步骤大致分为两步: 
  1>通过@interface关键字(注意,不是interface,是@interace)声明注解名称,以及注解的成员属性或者叫做注解的参数。 
  2>使用java内置的四个元注解对这个自定义标注的功能和范围进行一些限制 

4.什么是元注解 
  元注解,就是定义注解的注解,也就是说这些元注解是的作用就是专门用来约束其它注解的注解。请区别上面那三个注解,他们也是通过元注解定义而来的。 
  元注解有哪些呢,主要有四个@Target@Retention@Documented@Inherited

    

@Target

表示该注解可以用于什么地方,可能的ElementType参数有:

CONSTRUCTOR:构造器的声明

FIELD:域声明(包括enum实例)

LOCAL_VARIABLE:局部变量声明

METHOD:方法声明

PACKAGE:包声明

PARAMETER:参数声明

TYPE:类、接口(包括注解类型)或enum声明

@Retention

表示需要在什么级别保存该注解信息。可选的RetentionPolicy参数包括:

SOURCE:注解将被编译器丢弃

CLASS:注解在class文件中可用,但会被VM丢弃

RUNTIME:VM将在运行期间保留注解,因此可以通过反射机制读取注解的信息。

@Document

将注解包含在Javadoc中

@Inherited

允许子类继承父类中的注解


注解的应用图

  


自定义注解

  

		//自定义一个类级别的标注Description 
		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               //将此注解包含在javadoc中 
		public @interface Description { 
			String value(); 
		} 
		
		//再定义个方法级别的注解Name 
		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与@Description里的不同,参数成员也不同 
		@Target(ElementType.METHOD) 
		@Retention(RetentionPolicy.RUNTIME) 
		@Documented 
		public @interface Name { 
			String originate(); 
			String community(); 
		} 
		
		//然后使用以上两个注解 
		@Description(value="javaeye,做最棒的软件开发交流社区") 
		public class JavaEyer { 
			@Name(originate="创始人:robbin",community="javaEye") 
			public String getName() 
			{ 
				return null; 
			} 
			@Name(originate="创始人:江南白衣",community="springside") 
			public String getName2() 
			{ 
				return "借用两位的id一用,写这一个例子,请见谅!"; 
			} 
		} 
		
		//说明:其中标注“@Description(value="javaeye,做最棒的软件开发交流社区")”,
		//可以写成“@Description("javaeye,做最棒的软件开发交流社区") ”,结果也是一样的。
		//因为Description标注定义的时候其参数(或者说属性)为value。
		//而value比较特殊,它在被指定参数的时候可以不用显示的写出来。
		//当然如果定义的时候参数名不是value而是其它的比如des,那么使用注解的时候,必须显示写出参数名,
		//然后再赋值:@Description(Des=”xxx”) 
		//提取出注解的信息 
		
		import java.lang.reflect.Method; 
		import java.util.HashSet; 
		import java.util.Set; 
		public class TestAnnotation { 
		/** 
		* 说明:具体关天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()); 
			} 
		} 



  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值