java语言注解基础概念详解

 更新时间:2017年12月26日 08:39:15   作者:hypmxy  
这篇文章主要介绍了java语言注解基础概念详解,具有一定借鉴价值,需要的朋友可以参考下。

1、RetentionPolicy.SOURCE:注解只保留在源文件,当Java文件编译成class文件的时候,注解被遗弃;

2、RetentionPolicy.CLASS:注解被保留到class文件,但jvm加载class文件时候被遗弃,这是默认的生命周期;

3、RetentionPolicy.RUNTIME:注解不仅被保存到class文件中,jvm加载class文件之后,仍然存在;

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

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

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

下面来介绍下运行时注解的简单运用。

获取注解

你需要通过反射来获取运行时注解,可以从Package、Class、Field、Method...上面获取,基本方法都一样,几个常见的方法如下:

/** 
 * 获取指定类型的注解 
 */
public <A extends Annotation> A getAnnotation(Class<A> annotationType);
/** 
 * 获取所有注解,如果有的话 
 */
public Annotation[] getAnnotations();
/** 
 * 获取所有注解,忽略继承的注解 
 */
public Annotation[] getDeclaredAnnotations();
/** 
 * 指定注解是否存在该元素上,如果有则返回true,否则false 
 */
public Boolean isAnnotationPresent(Class<? extends Annotation> annotationType);
/** 
 * 获取Method中参数的所有注解 
 */
public Annotation[][] getParameterAnnotations();

要使用这些函数必须先通过反射获取到对应的元素:Class、Field、Method等。

自定义注解

来看下自定义注解的简单使用方式,这里先定义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; 
} 

这3个注解分别适用于不同的元素,并都带有不同的属性,在使用注解是需要设置这些属性值。

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

/** 
 * 测试运行时注解 
 */
@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());
}

所做的操作都是通过反射获取对应元素,再获取元素上面的注解,最后得到注解的属性值。

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

总结

以上就是本文关于java语言注解基础概念详解的全部内容,希望对大家有所帮助。感兴趣的朋友可以继续参阅本站其他相关专题,如有不足之处,欢迎留言指出。感谢朋友们对本站的支持!

相关文章

  • 区分Java的方法覆盖与变量覆盖

    区分Java的方法覆盖与变量覆盖

    作为初学者2个比较容易出错的定义,方法覆盖和变量覆盖。下面我们一起来看看作者如何去探讨Java的方法覆盖和变量覆盖。
    2015-09-09
  • java实现验证码类生成中文验证码

    java实现验证码类生成中文验证码

    java实现的汉字输入验证码,主要包含两个类,一个是生成验证码,一个是判断验证码输入是否正确,实现原理非常简单,将汉字和干扰线生成图片并将汉字保存到session,前台获取每次生成验证码图片并用文本框值和session值比较,功能就怎么简单
    2014-01-01
  • jQuery.event.trigger()的简单解释

    jQuery.event.trigger()的简单解释

    今天小编就为大家分享一篇关于jQuery.event.trigger()的简单解释,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2018-10-10
  • 浅谈对象与Map相互转化

    浅谈对象与Map相互转化

    这篇文章主要介绍了利用BeanMap进行对象与Map的相互转换,在文中列举了完整代码,需要的朋友可以参考下。
    2017-09-09
  • java Struts2框架下实现文件上传功能

    java Struts2框架下实现文件上传功能

    这篇文章主要为大家详细介绍了java Struts2框架下实现文件上传功能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-10-10
  • 详解使用Spring3 实现用户登录以及权限认证

    详解使用Spring3 实现用户登录以及权限认证

    这篇文章主要介绍了详解使用Spring3 实现用户登录以及权限认证,这里整理了详细的代码,有需要的小伙伴可以参考下。
    2017-03-03
  • java常用工具类 UUID、Map工具类

    java常用工具类 UUID、Map工具类

    这篇文章主要为大家详细介绍了Java常用工具类,包括UUID工具类、Map工具类,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-05-05
  • java  使用URLDecoder和URLEncoder对中文进行处理

    java 使用URLDecoder和URLEncoder对中文进行处理

    这篇文章主要介绍了java 使用URLDecoder和URLEncoder对中文进行处理的相关资料,需要的朋友可以参考下
    2017-02-02
  • 浅谈Java读写注册表的方式Preferences与jRegistry

    浅谈Java读写注册表的方式Preferences与jRegistry

    这篇文章主要介绍了浅谈Java读写注册表的方式Preferences与jRegistry,分享了相关代码示例,小编觉得还是挺不错的,具有一定借鉴价值,需要的朋友可以参考下
    2018-02-02
  • 深入理解Mybatis二级缓存

    深入理解Mybatis二级缓存

    与一级缓存相比,二级缓存范围更大了一些,可以被多个SqlSession所共用。下面通过本文带领大家一起学习mybatis二级缓存知识,一起看看吧
    2016-12-12

最新评论