Java的注解和反射

1、注解按生命周期来划分可分为3类

1、RetentionPolicy.SOURCE：注解只保留在源文件，当Java文件编译成class文件的时候，注解被遗弃；
2、RetentionPolicy.CLASS：注解被保留到class文件，但jvm加载class文件时候被遗弃，这是默认的生命周期；
3、RetentionPolicy.RUNTIME：注解不仅被保存到class文件中，jvm加载class文件之后，仍然存在；

这3个生命周期分别对应于：Java源文件(.java文件) ---> .class文件 ---> 内存中的字节码。

1.1、那怎么来选择合适的注解生命周期呢？

首先要明确生命周期长度 SOURCE < CLASS < RUNTIME ，所以前者能作用的地方后者一定也能作用。一般如果需要在运行时去动态获取注解信息，那只能用 RUNTIME 注解；如果要在编译时进行一些预处理操作，比如生成一些辅助代码（如 ButterKnife），就用 CLASS注解；如果只是做一些检查性的操作，比如 @Override 和 @SuppressWarnings，则可选用 SOURCE 注解。

2、修饰对象范围

@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声明

3、下面一个自定义注解和反射的例子

先定义3个运行时注解：

// 适用类、接口（包括注解类型）或枚举
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface ClassInfo {
    String value();
}

// 适用field属性，也包括enum常量
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface FieldInfo {
    int[] value();
}

// 适用方法
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MethodInfo {
    String name() default "long";
    String data();
    int age() default 27;
}

再定义一个测试类来使用这些注解：

/**
 * 测试运行时注解
 */
@ClassInfo("Test Class")
public class TestRuntimeAnnotation {
 
    @FieldInfo(value = {1, 2})
    public String fieldInfo = "FiledInfo";
 
    @FieldInfo(value = {10086})
    public int i = 100;
 
    @MethodInfo(name = "BlueBird", data = "Big")
    public static String getMethodInfo() {
        return TestRuntimeAnnotation.class.getSimpleName();
    }
}

最后来看怎么在代码中获取注解信息：

/**
 * 测试运行时注解
 */
private void _testRuntimeAnnotation() {
    StringBuffer sb = new StringBuffer();
    Class<?> cls = TestRuntimeAnnotation.class;
    Constructor<?>[] constructors = cls.getConstructors();
    // 获取指定类型的注解
    sb.append("Class注解：").append("\n");
    ClassInfo classInfo = cls.getAnnotation(ClassInfo.class);
    if (classInfo != null) {
        sb.append(Modifier.toString(cls.getModifiers())).append(" ")
                .append(cls.getSimpleName()).append("\n");
        sb.append("注解值: ").append(classInfo.value()).append("\n\n");
    }
 
    sb.append("Field注解：").append("\n");
    Field[] fields = cls.getDeclaredFields();
    for (Field field : fields) {
        FieldInfo fieldInfo = field.getAnnotation(FieldInfo.class);
        if (fieldInfo != null) {
            sb.append(Modifier.toString(field.getModifiers())).append(" ")
                    .append(field.getType().getSimpleName()).append(" ")
                    .append(field.getName()).append("\n");
            sb.append("注解值: ").append(Arrays.toString(fieldInfo.value()))
            .append("\n\n");
        }
    }
 
    sb.append("Method注解：").append("\n");
    Method[] methods = cls.getDeclaredMethods();
    for (Method method : methods) {
        MethodInfo methodInfo = method.getAnnotation(MethodInfo.class);
        if (methodInfo != null) {
            sb.append(Modifier.toString(method.getModifiers())).append(" ")
                    .append(method.getReturnType().getSimpleName()).append(" ")
                    .append(method.getName()).append("\n");
            sb.append("注解值: ").append("\n");
            sb.append("name: ").append(methodInfo.name()).append("\n");
            sb.append("data: ").append(methodInfo.data()).append("\n");
            sb.append("age: ").append(methodInfo.age()).append("\n");
        }
    }
 
    System.out.print(sb.toString());
}

看一下输出情况，这里我直接显示在手机上：

4、其他

4.1、给实体对象属性的空值赋默认值的一个demo

private final String defaultStr = "";
private final Date defaultDate = new Date();
private final BigDecimal defaultDecimal = new BigDecimal(0);
private final Timestamp defaultTimestamp=new Timestamp(new Date().getTime());
//赋默认值
public void setDefaultValue(Object object) {
	try {
   		Class clazz = object.getClass();
   		Field[] fields = clazz.getDeclaredFields();
   		String primaryKey = EntityUtil
   			.getPrimaryKey(currentSession(), object.getClass());
   		for(int i=0;i<fields.length;i++){
   			Field field = fields[i];
   			String fieldName = field.getName();
           	Class fieldClass=field.getType();
           	field.setAccessible(true); //设置访问权限
			if(!fieldName.equals(primaryKey) && isFieldValueNull(fieldName,object)){
				if (fieldClass == Integer.class ) {
					field.set(object, defaultDecimal.intValue());
				}else if (fieldClass == Long.class) {
					field.set(object, defaultDecimal.longValue());
				}else if (fieldClass == Float.class) {
					field.set(object, defaultDecimal.doubleValue());
				}else if (fieldClass == BigDecimal.class) {
					field.set(object, defaultDecimal);
				} else if (fieldClass == Date.class) {
					field.set(object, defaultDate);
				} else if (fieldClass == String.class){
					field.set(object, defaultStr); // 设置值
				} else if (fieldClass == Timestamp.class){
					field.set(object, defaultTimestamp);
				}
			}else if(fieldName.equals(primaryKey) 
				&& isStringFieldValueNull
				(fieldName,object,fieldClass)){//MySQL，需要对对主键做特殊处理
           		field.set(object, null);
           	}
       	}
   	} catch (Exception e) {
   		e.printStackTrace();
		System.out.println(e.getMessage());
	}
}

//判断字段是否为空
private boolean isFieldValueNull(String fieldName, Object object) 
	throws ClassNotFoundException {
	boolean isNUll=false;
	try {
		String firstLetter = fieldName.substring(0, 1).toUpperCase();
		String getter = "get" + firstLetter + fieldName.substring(1);
		Method method = object.getClass().getMethod(getter, new Class[] {});
		Object value = method.invoke(object, new Object[] {});
		if(value==null){
			isNUll=true;
		}
		return isNUll;
	} catch (Exception e) {
		return isNUll;
	}
}

//判断主键是否为空值
private boolean isStringFieldValueNull(String fieldName
, Object object, Class fieldClass) throws ClassNotFoundException { 
   	boolean isNUll=false;
   	try {
   		String firstLetter = fieldName.substring(0, 1).toUpperCase();
   		String getter = "get" + firstLetter + fieldName.substring(1);
   		Method method = object.getClass().getMethod(getter, new Class[] {});
   		Object value = method.invoke(object, new Object[] {});
   		if(value==null ){
   			isNUll=true;
		}else{
			if (fieldClass == String.class && StringUtils.isBlank((String)value)) {
           		isNUll=true;
           	}
       	}
       	return isNUll;
   	} catch (Exception e) {
   		return isNUll;
	}
}