注解使用

Posted 2020-09-27

现在注解的使用是很多框架都喜欢使用的，首先了解一下元注解

元注解（meta-annotation）：

元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解：

[email protected],[email protected],[email protected],[email protected]

这些类型和它们所支持的类在java.lang.annotation包中可以找到。下面我们看一下每个元注解的作用和相应分参数的使用说明。

@Target：

@Target说明了Annotation所修饰的对象范围：Annotation可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。

作用：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）

取值(ElementType)有：

1.CONSTRUCTOR:用于描述构造器

2.FIELD:用于描述域

3.LOCAL_VARIABLE:用于描述局部变量

4.METHOD:用于描述方法

5.PACKAGE:用于描述包

6.PARAMETER:用于描述参数

7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

@Retention：

@Retention定义了该Annotation被保留的时间长短：某些Annotation仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。

作用：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效）

取值（RetentionPoicy）有：

1.SOURCE:在源文件中有效（即源文件保留）

2.CLASS:在class文件中有效（即class保留）

3.RUNTIME:在运行时有效（即运行时保留）

Retention meta-annotation类型有唯一的value作为成员，它的取值来自java.lang.annotation.RetentionPolicy的枚举类型值。

@Documented:

@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。

@Inherited：

@Inherited 元注解是一个标记注解，@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类。

注意：@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation，方法并不从它所重载的方法继承annotation。

当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME，则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时，反射代码检查将展开工作：检查class和其父类，直到发现指定的annotation类型被发现，或者到达类继承结构的顶层。

下面是自己写的一个例子

首先写一个注解@interface

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;

/**
 *
 * @auther QiaoZhenwu
 * @date 2017年7月11日 上午10:31:33
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@Documented
public @interface Service {

//	public Class<?> getCls();//代表注释位置是否要加属性信息  例：@Service(getCls = User.class)	private User user;
}

然后写一个注解的执行器

import java.beans.PropertyDescriptor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;

import com.alibaba.fastjson.JSON;

/**
 *
 * @auther QiaoZhenwu
 * @date 2017年7月11日 上午10:41:10
 */
public class ServiceActuator {

	public static void getAllBean(Object obj){
		Class<? extends Object> cls = obj.getClass();
		
		// 得到自定义的属性
		Field[] fields = cls.getDeclaredFields();
		try {
			for (Field f : fields) {
				// 循环判断是否有UploadFile的自动注入field
				Service uf = f.getAnnotation(Service.class);
				if (uf != null) {
					// 假如此属性被注解为UploadFile
					// 得到需要注入的实例class
					System.out.println(f.getType().getName());
					
//					Class c = Class.forName(f.getType().getName());
//					Object o = c.newInstance();
//					Field[] fs = c.getDeclaredFields();
//					for(Field fi : fs){
//						String fiName = fi.getName();
//						String setMethod = "set" + fiName.substring(0, 1).toUpperCase() + fiName.substring(1);
//						Method m = c.getDeclaredMethod(setMethod, new Class[]{fi.getType()});
//						m.invoke(o, fiName + "-java");//调用set方法，并设置值
	            	  //获取属性
	            	   PropertyDescriptor pd = new PropertyDescriptor(f.getName(), cls);
	                   Method getMethod = pd.getReadMethod();// 获得get方法
	                   Object ob = getMethod.invoke(obj);// 执行get方法返回一个Object
	                   System.out.println(f.getName() + ":" + f.getType().getName() + " = " + JSON.toJSONString(ob));
	                   
	                   Class c = f.getType();
	                   Field[] fs = c.getDeclaredFields();
	                   //判断属性是否含有属性
	                   if(fs.length > 0){
	                	   for(Field fi : fs){
		                	   PropertyDescriptor pd1 = new PropertyDescriptor(fi.getName(), c);
		                	   Method getMethod1 = pd1.getReadMethod();// 获得get方法
		                	   Object ob2 = getMethod1.invoke(ob);// 执行get方法返回一个Object
		                	   System.out.println(fi.getName() + ":" + fi.getType().getName() + " = " + ob2);
		                   }
	                   }
//					}
				}
			}
		}catch(Exception e){
			
		}
	}

再写两个测试的entity

/**
 *
 * @auther QiaoZhenwu
 * @date 2017年7月11日 上午11:36:46
 */
public class Image {

	private String name;
	
	private String path;

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public String getPath() {
		return path;
	}

	public void setPath(String path) {
		this.path = path;
	}
	
}

/**
 *
 * @auther QiaoZhenwu
 * @date 2017年7月11日 上午10:55:18
 */
public class User {

	private String name;
	
	private String age;

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public String getAge() {
		return age;
	}

	public void setAge(String age) {
		this.age = age;
	}
	
}

测试类

/**
 *
 * @auther QiaoZhenwu
 * @date 2017年7月11日 上午10:54:18
 */
public class TestMain {

	@Service
	private User user;

	public User getUser() {
		return user;
	}

	public void setUser(User user) {
		this.user = user;
	}

	@Service
	private Image image;

	public Image getImage() {
		return image;
	}

	public void setImage(Image image) {
		this.image = image;
	}

	public static void main(String[] args) {
		TestMain t = new TestMain();
		User u = new User();
		u.setAge("age=18");
		u.setName("name=xw");
		t.setUser(u);
		Image i = new Image();
		i.setName("name=image.jpg");
		i.setPath("test.image.jpg");
		t.setImage(i);
		ServiceActuator.getAllBean(t);
	}
}

本文出自 “my dream fly on the sky” 博客，请务必保留此出处http://7915791.blog.51cto.com/7905791/1946394