Java反射学习总结五(Annotation(注解)-基础篇)

Annotation(注解)简单介绍:

注解大家印象最深刻的可能就是JUnit做单元測试,和各种框架里的使用了。

本文主要简介一下注解的用法,下篇文章再深入的研究。

annotation并不直接影响代码语义。可是它可以被看作类似程序的工具或者类库。它会反过来对正在执行的程序语义有所影响。

annotation能够从源文件,class文件或者以在执行时反射的多种方式被读取

java注解系统自带有主要下面几个注解:

Override注解表示子类要重写(override)父类的相应方法

Deprecated注解表示方法是不建议被使用的

Suppress Warnings注解表示抑制警告

怎样自己定义注解:

仅仅须要使用@interface来定义一个注解,比如:

//使用@interface来声明一个注解(实际上是自己主动继承了java.lang.annotation.Annotation接口)
public @interface AnnotationTest {
	String value1() default "hello";  //为注解设置String类型的属性Value1,并使用defalutkeyword设置默认值
	EnumTest value2();		//设置枚举类型的value2
	String[] value3();		//设置数组类型的value3
}

怎样来使用注解呢,例如以下:

@AnnotationTest(value2 = EnumTest.age, value3={""})
public class AnnotationUsage {

	@AnnotationTest(value1 = "Test", value2 = EnumTest.name, value3={""})
	String test;

	@AnnotationTest(value1 = "Test", value2 = EnumTest.name, value3={""})
	public void method(){
		System.out.println("usage of Annotation");
	}
}

如上,注解能够标注在属性。方法。类上。

须要使用name=value这样的赋值方式为属性赋值,由于value1设置了默认属性,所以能够忽略,假设没有设置默认值则全部的属性都要一一赋值。

另一种特殊情况,假设注解里仅仅定义了一个属性,名字是value,那么能够直接赋值,不须要使用name=value这样的赋值方式。例如以下:

public @interface AnnotationTest {
	String value();
}

@AnnotationTest("test")
public void method(){
	System.out.println("usage of Annotation");
}

修饰注解的“注解”

注解也能够加入注解的“注解”去修饰,经常使用的有下面两个,一个是Retention。一个Target

Retention:

使用Retention必需要提供一个为java.lang.annotation.RetentionPolicy类型的的枚举

RetentionPolicy枚举有下面3个类型:

SOURCE:编译程序时处理完Annotation信息后就完毕任务

CLASS:编译程序将Annotation存储于class文件里,不能够由虚拟机读入

RUNTIME:编译程序将Annotation存储于class文件里。能够由虚拟机读入

用这三种Retention的Prolicy能够决定注解是从源文件。class文件或者以在执行时反射被读取

关于Retention的样例在最后

Target:

使用java.lang.annotation.Target能够定义注解被使用的位置

相同,在使用时要指定一个java.lang.annotation.ElementType的枚举值类型为他的“属性”

ElementType枚举的类型例如以下:

ANNOTATION_TYPE:适用于annotation

CONSTRUCTOR:适用于构造方法

FIELD:适用于field

LOCAL_VARIABLE:适用于局部变量

METHOD:适用于方法

PACKAGE:适用于package

PARAMETER:适用于method上的parameter

TYPE:适用于class,interface,enum

例如以下:定义一个注解MyTarget。设置Target类型为Method来修饰这个注解。这样这个注解仅仅能标注在method的方法上

@Target(ElementType.METHOD)
public @interface MyTarget {
	 String hello() default "hello";
}
@MyTarget  //这里则会报错,由于他标注在类上面了
public class MyTargetTest {
	@MyTarget   //标注在方法上不会报错
	public void doSomething(){
		System.out.println("hello world");
	}
}

使用反射调用注解

在下面的类中Class Constructor Field Method Package等类都实现了AnnotatedElement接口

在接口中有下面重要的方法:

getAnnotations(Class annotationType)获取一个指定的annotation类型

getAnnotations() 获取全部的Annotation

getDeclaredAnnotations() 获取声明过的全部Annotation

isAnnotationPresent(Class<? extends Annotation> annotationClass)这个annotation是否出现

通过这些方法,配合反射我们就能够在程序执行时拿到注解的内容了。样例例如以下:

@Retention(RetentionPolicy.RUNTIME)	//定义一个注解。使用Retention标注为RUNTIME
public @interface MyAnnotation {
	String hello() default "hello";
	String world();
}

该注解被标示为runtime类型,表示该注解最后能够保存在class文件里,并为java虚拟机在执行时读取到

@Retention(RetentionPolicy.CLASS)	//定义一个注解。Retention标注为RUNTIME
public @interface MyAnnotation2 {
	String hello() default "hello"; //设置默认值为hello
}

自己定义的还有一个注解Retention标示为class

public class MyTest {
	@SuppressWarnings("unchecked")  //java自带的注解Retention的policy为SOURCE
	@Deprecated		//java自带的注解Retention的policy为RUNTIME
	@MyAnnotation(Name="Dean", Age="25")	//自己定义的注解Retention的policy为RUNTIME
	@MyAnnotation2	//自己定义的注解Retention的policy为CLASS
	public void TestMethod() {
		System.out.println("this is a method");
	}
}

定义一个TestMethod方法。给他标示了4个注解。当中2个java自带的,2个我们自己定义的。注解的的Retention属性各不同样。

以下定义一个測试类来验证结果:

public static void main(String[] args) throws Exception {

		MyTest myTest = new MyTest();
		//通过反射得到TestMethod方法
		Class<MyTest> c = MyTest.class;
		Method method = c.getMethod("TestMethod", new Class[]{});

		//AnnotatedElement接口中的方法isAnnotationPresent(),推断传入的注解类型是否存在
		if (method.isAnnotationPresent(MyAnnotation.class)) {
			method.invoke(myTest, new Object[]{});
			//AnnotatedElement接口中的方法getAnnotation(),获取传入注解类型的注解
			MyAnnotation myAnnotation = method.getAnnotation(MyAnnotation.class);
			//拿到注解中的属性
			String name = myAnnotation.Name();
			String age = myAnnotation.Age();
			System.out.println("name:"+name +"   age:"+age);
		}

		System.out.println("-----------------------------------");

		//AnnotatedElement接口中的方法getAnnotations(),获取全部注解
		Annotation[] annotations = method.getAnnotations();
		//循环注解数组打印出注解类型的名字
		for (Annotation annotation : annotations) {
			System.out.println(annotation.annotationType().getName());
		}
	}

打印结果为:

this is a method

name:Dean   age:25

-----------------------------------

java.lang.Deprecated

gxy.text.annotation.MyAnnotation

切割线上:介绍了怎样使用AnnotatedElement接口中的方法和反射去调用注解

切割线下:证明了仅仅有定义了Retention的Policy为Runtime的注解才干够被反射读取出来

下一篇文章分析一下在JUnit中反射与注解的使用和原理

时间: 2024-10-28 20:03:06

Java反射学习总结五(Annotation(注解)-基础篇)的相关文章

Java反射学习总结终(使用反射和注解模拟JUnit单元测试框架)

本文是Java反射学习总结系列的最后一篇了,这里贴出之前文章的链接,有兴趣的可以打开看看. http://blog.csdn.net/a396901990/article/category/2302221 本文介绍了如何利用反射和注解去简单的模拟JUnit4单元测试框架,之所以选择JUnit4是因为4.0以后最大的改进就是使用了注解.需要注意的是这里并不是完全的模拟,只是简单实现了一下Runner类和JUnit注解相关的工作流程.所以本文的主要目的是介绍反射和注解的使用.废话不多说,直接进入正文

spring框架学习(五)注解

spring框架学习(五)注解 注解Annotation,是一种类似注释的机制,在代码中添加注解可以在之后某时间使用这些信息.跟注释不同的是,注释是给我们看的,java虚拟机不会编译,注解也是不编译的,但是我们可以通过反射机制去读取注解中的信息.注解使用关键字@interface,继承java.lang.annotition.Annotition spring框架为我们提供了注解功能. 使用注解编程,主要是为了替代xml文件,使开发更加快速.但是,xml文件的使用就是解决修改程序修改源代码,现在

Java反射学习总结四(动态代理使用实例和内部原理解析)

通过上一篇文章介绍的静态代理Java反射学习总结三(静态代理)中,大家可以发现在静态代理中每一个代理类只能为一个接口服务,这样一来必然会产生过多的代理,而且对于每个实例,如果需要添加不同代理就要去添加相应的代理类.解决这一问题最好的做法是可以通过一个代理类完成全部的代理功能或者说去动态的生成这个代理类,那么此时就必须使用动态代理完成. 动态代理知识点: Java动态代理类位于java.lang.reflect包下,主要有以下一个接口和一个类: 1.InvocationHandler接口:    

Java反射学习总结

广州疯狂软件教育Java培训,iOS培训分享Class类是Reflection API中核心的类,他位于java.lang.Class列出一些常用的方法.- getName() : 获得类的完整名字- getFields() : 获得类的public类型的属性- getDeclaredFields() : 获得类的所有属性- getMethods() : 获得类的public类型的方法- getDeclaredMethods() : 获得类的所有方法- getMethod(String name

Java反射理解(五)-- 方法反射的基本操作

Java反射理解(五)-- 方法反射的基本操作 方法的反射 1. 如何获取某个方法 方法的名称和方法的参数列表才能唯一决定某个方法 2. 方法反射的操作 method.invoke(对象,参数列表) 举例 具体操作请看下面举例: import java.lang.reflect.Method; class A{ public void print(){ System.out.println("helloworld"); } public void print(int a,int b){

MongoDB 学习笔记(一)基础篇

1.MongoDB 特点 面向集合存储,存储对象类型的数据方便 模式自由,不需要定义任何模式(schma) 动态查询 完全索引,包含内部对象 复制和故障恢复方便 高效的二进制数据存储 支持c# 平台驱动 2.体系结构 一台服务器可以创建多个Server 实例和数据库,(推荐一天server 机器创建一个实例), 数据库:MongoDB 中的一系列与磁盘有关的物理文件(数据文件,日志文件等). 数据逻辑结构:文档 (documnet) 集合(collection) 数据库(database). d

Android开发学习之路--Annotation注解简化view控件之初体验

一般我们在写android Activity的时候总是会在onCreate方法中加上setContentView方法来加载layout,通过findViewById来实现控件的绑定,每次写这么多代码总觉得很烦躁.近来看了下android中有Annotation来实现这方面的简化,对于java不是很了解,就简单的看了下.上次玩web的时候,springmvc也有很多的注解,不知道怎么实现的,这里其实基本上类似. Annotation注解这里主要还是讲讲怎么使用吧,单纯的原理会把人绕进去的,没办法,

Java反射学习:深入学习Java反射机制

一.Java反射的理解(反射是研究框架的基础之一) Java反射机制是在运行状态中,对于任意一个类,都能够知道这个类的所有属性和方法:对于任意一个对象,都能够调用它的任意一个方法和属性:这种动态获取的信息以及动态调用对象的方法的功能称为Java语言的反射机制. 二.逐步分析 参考:https://blog.csdn.net/u012585964/article/details/52011138 1.关于Class 1.Class是一个类,一个描述类的类(也就是描述类本身),封装了描述方法的Met

黑马程序员------Java反射学习总结(一)

-------------------------Java培训.Android培训,期待与您交流!----------------------------- 一.反射的概念 1) Java反射机制是在运行状态中,对于任意一个类,都能够知道这个类中的所有属性和方法:对于任意一个对象,都能够调用它的任意一个方法和属性:这种动态获取的信息以及动态调用对象的方法的功能称为java语言的反射机制. 2)一句话来讲,反射就是将Java类中的各个成分映射成相应的Java类. 3)即在Java中,描述事物的各种