Annotation

最新推荐文章于 2025-07-10 10:20:49 发布

DryKillLogic

最新推荐文章于 2025-07-10 10:20:49 发布

阅读量564

点赞数

分类专栏： J2se 文章标签： deprecated string annotations interface java javadoc

J2se 专栏收录该内容

19 篇文章

订阅专栏

Annotation( 注释 ) 是 JDK5.0 及以后版本引入的。它可以用于创建文档，跟踪代码中的依赖性，甚至执行基本编译时检查。注释是以 ‘@ 注释名 ’ 在代码中存在的，根据注释参数的个数，我们可以将注释分为：标记注释、单值注释、完整注释三类。它们都不会直接影响到程序的语义，只是作为注释（标识）存在，我们可以通过反射机制编程实现对这些元数据的访问。另外，你可以在编译时选择代码里的注释是否只存在于源代码级，或者它也能在 class 文件中出现。

元数据的作用
如果要对于元数据的作用进行分类，目前还没有明确的定义，不过我们可以根据它所起的作用，大致可分为三类：
编写文档：通过代码里标识的元数据生成文档。
代码分析：通过代码里标识的元数据对代码进行分析。
编译检查：通过代码里标识的元数据让编译器能实现基本的编译检查。

基本内置注释

@Override

Java代码

package com.iwtxokhtd.annotation;
/**
* 测试Override注解
* @author Administrator
*
*/
public class OverrideDemoTest {
//@Override
public String tostring(){
return "测试注释" ;
}
}

package com.iwtxokhtd.annotation;
/**
 * 测试Override注解
 * @author Administrator
 *
 */
public class OverrideDemoTest {

	//@Override
	public String tostring(){
		return "测试注释";
	}
}

@Deprecated的作用是对不应该在使用的方法添加注释，当编程人员使用这些方法时，将会在编译时显示提示信息，它与 javadoc 里的 @deprecated 标记有相同的功能，准确的说，它还不如 javadoc @deprecated ，因为它不支持参数，使用 @Deprecated 的示例代码示例如下：

Java代码

package com.iwtxokhtd.annotation;
/**
* 测试Deprecated注解
* @author Administrator
*
*/
public class DeprecatedDemoTest {
public static void main(String[] args) {
//使用DeprecatedClass里声明被过时的方法
DeprecatedClass.DeprecatedMethod();
}
}
class DeprecatedClass{
@Deprecated
public static void DeprecatedMethod() {
}
}

package com.iwtxokhtd.annotation;
/**
 * 测试Deprecated注解
 * @author Administrator
 *
 */
public class DeprecatedDemoTest {
	 public static void main(String[] args) {
		//使用DeprecatedClass里声明被过时的方法
		 DeprecatedClass.DeprecatedMethod();
	 }
}
class DeprecatedClass{
	@Deprecated
	public static void DeprecatedMethod() {     
	  } 
}

@SuppressWarnings,其参数有：

deprecation，使用了过时的类或方法时的警告

unchecked，执行了未检查的转换时的警告

fallthrough，当 Switch 程序块直接通往下一种情况而没有 Break 时的警告

path ，在类路径、源文件路径等中有不存在的路径时的警告

serial ，当在可序列化的类上缺少 serialVersionUID 定义时的警告

finally ，任何 finally 子句不能正常完成时的警告

all ，关于以上所有情况的警告

Java代码

package com.iwtxokhtd.annotation;
import java.util.ArrayList;
import java.util.List;
public class SuppressWarningsDemoTest {
public static List list= new ArrayList();
@SuppressWarnings ( "unchecked" )
public void add(String data){
list.add(data);
}
}

package com.iwtxokhtd.annotation;

import java.util.ArrayList;
import java.util.List;

public class SuppressWarningsDemoTest {

	public static List list=new ArrayList();
	@SuppressWarnings("unchecked")
	public void add(String data){
		list.add(data);
	}
}

(2) 自定义注释

它类似于新创建一个接口类文件，但为了区分，我们需要将它声明为 @interface, 如下例：

Java代码

public @interface NewAnnotation {
}

public @interface NewAnnotation {
}

使用自定义的注释类型

Java代码

public class AnnotationTest {
@NewAnnotation
public static void main(String[] args) {
}
}

public class AnnotationTest {
    @NewAnnotation 
    public static void main(String[] args) {
    }
}

为自定义注释添加变量

Java代码

public @interface NewAnnotation {
String value();
}

public @interface NewAnnotation { 
     String value(); 
}

Java代码

public class AnnotationTest {
@NewAnnotation ( "main method" )
public static void main(String[] args) {
saying();
}
@NewAnnotation (value = "say method" )
public static void saying() {
}
}

public class AnnotationTest { 
     @NewAnnotation("main method") 
    public static void main(String[] args) { 
        saying(); 
    } 
    @NewAnnotation(value = "say method") 
     public static void saying() {
     }
}

定义一个枚举类型，然后将参数设置为该枚举类型，并赋予默认值

Java代码

public @interface Greeting {
public enum FontColor{
BLUE,RED,GREEN
};
String name();
FontColor fontColor() default FontColor.RED;}
}

public @interface Greeting {   
public enum FontColor{
	   BLUE,RED,GREEN
	};
	String name();
	FontColor fontColor() default FontColor.RED;}  
}

这里有两种选择，其实变数也就是在赋予默认值的参数上，我们可以选择使用该默认值，也可以重新设置一个值来替换默认值

Java代码

@NewAnnonation ( "main method" )
public static void main(String[] args) {
saying();
sayHelloWithDefaultFontColor();
sayHelloWithRedFontColor();
}
@NewAnnonation ( "say method" )
public static void saying(){
}
//此时的fontColor为默认的RED
@Greeting (name= "defaultfontcolor" )
public static void sayHelloWithDefaultFontColor() {
}
//现在将fontColor改为BLUE
@Greeting (name= "notdefault" ,fontColor=Greeting.FontColor.BLUE)
public static void sayHelloWithRedFontColor() {
}

@NewAnnonation("main method")
	public static void main(String[] args) {
    	    saying();   
    	    sayHelloWithDefaultFontColor();   
    	    sayHelloWithRedFontColor();   

	}
    @NewAnnonation("say method")
    public static  void saying(){
    	
    }
    //此时的fontColor为默认的RED
    @Greeting(name="defaultfontcolor")
    public static void sayHelloWithDefaultFontColor() {   
        
    }
    //现在将fontColor改为BLUE
    @Greeting(name="notdefault",fontColor=Greeting.FontColor.BLUE)
    public static void sayHelloWithRedFontColor() {   
           
}

(3) 注释的高级应用

限制注释的使用范围

用 @Target 指定 ElementType 属性

Java代码

package java.lang.annotation;
public enum ElementType {
TYPE,
// 用于类，接口，枚举但不能是注释
FIELD,
// 字段上，包括枚举值
METHOD,
// 方法，不包括构造方法
PARAMETER,
// 方法的参数
CONSTRUCTOR,
//构造方法
LOCAL_VARIABLE,
// 本地变量或catch语句
ANNOTATION_TYPE,
// 注释类型(无数据)
PACKAGE
// Java包
}

 package java.lang.annotation;   
public enum ElementType {   
  TYPE,   
  // 用于类，接口，枚举但不能是注释
  FIELD,   
  // 字段上，包括枚举值  
  METHOD,   
  // 方法，不包括构造方法
  PARAMETER,   
  // 方法的参数
  CONSTRUCTOR,   
  //构造方法
  LOCAL_VARIABLE,   
  // 本地变量或catch语句 
  ANNOTATION_TYPE,   
  // 注释类型(无数据)  
  PACKAGE   
  // Java包  
}

注解保持性策略

Java代码

//限制注解使用范围
@Target ({ElementType.METHOD,ElementType.CONSTRUCTOR})
public @interface Greeting {
//使用枚举类型
public enum FontColor{
BLUE,RED,GREEN
};
String name();
FontColor fontColor() default FontColor.RED;
}

//限制注解使用范围
@Target({ElementType.METHOD,ElementType.CONSTRUCTOR})
public @interface Greeting {

	//使用枚举类型
	public enum FontColor{
	   BLUE,RED,GREEN
	};
	String name();
	FontColor fontColor() default FontColor.RED;
}

在 Java 编译器编译时，它会识别在源代码里添加的注释是否还会保留，这就是 RetentionPolicy 。下面是 Java 定义的 RetentionPolicy 枚举：

编译器的处理有三种策略：

将注释保留在编译后的类文件中，并在第一次加载类时读取它

将注释保留在编译后的类文件中，但是在运行时忽略它

按照规定使用注释，但是并不将它保留到编译后的类文件中

Java代码

package java.lang.annotation;
public enum RetentionPolicy {
SOURCE,
// 此类型会被编译器丢弃
CLASS,
// 此类型注释会保留在class文件中，但JVM会忽略它
RUNTIME
// 此类型注释会保留在class文件中，JVM会读取它
}

package java.lang.annotation;   
public enum RetentionPolicy {   
  SOURCE,   
  // 此类型会被编译器丢弃  
  CLASS,   
  // 此类型注释会保留在class文件中，但JVM会忽略它  
  RUNTIME   
  // 此类型注释会保留在class文件中，JVM会读取它   
}

Java代码

//让保持性策略为运行时态，即将注解编码到class文件中，让虚拟机读取
@Retention (RetentionPolicy.RUNTIME)
public @interface Greeting {
//使用枚举类型
public enum FontColor{
BLUE,RED,GREEN
};
String name();
FontColor fontColor() default FontColor.RED;
}

//让保持性策略为运行时态，即将注解编码到class文件中，让虚拟机读取
@Retention(RetentionPolicy.RUNTIME)
public @interface Greeting {

	//使用枚举类型
	public enum FontColor{
	   BLUE,RED,GREEN
	};
	String name();
	FontColor fontColor() default FontColor.RED;
}

文档化功能

Java 提供的 Documented 元注释跟 Javadoc 的作用是差不多的，其实它存在的好处是开发人员可以定制 Javadoc 不支持的文档属性，并在开发中应用。它的使用跟前两个也是一样的，简单代码示例如下：

Java代码

//让它定制文档化功能
//使用此注解时必须设置RetentionPolicy为RUNTIME
@Documented
public @interface Greeting {
//使用枚举类型
public enum FontColor{
BLUE,RED,GREEN
};
String name();
FontColor fontColor() default FontColor.RED;
}

//让它定制文档化功能
//使用此注解时必须设置RetentionPolicy为RUNTIME
@Documented
public @interface Greeting {

	//使用枚举类型
	public enum FontColor{
	   BLUE,RED,GREEN
	};
	String name();
	FontColor fontColor() default FontColor.RED;
}

标注继承

Java代码

//让它允许继承，可作用到子类
@Inherited
public @interface Greeting {
//使用枚举类型
public enum FontColor{
BLUE,RED,GREEN
};
String name();
FontColor fontColor() default FontColor.RED;
}

//让它允许继承，可作用到子类
@Inherited
public @interface Greeting {

	//使用枚举类型
	public enum FontColor{
	   BLUE,RED,GREEN
	};
	String name();
	FontColor fontColor() default FontColor.RED;
}

(4) 读取注解信息

属于重点，在系统中用到注解权限时非常有用，可以精确控制权限的粒度

Java代码

package com.iwtxokhtd.annotation;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
//读取注解信息
public class ReadAnnotationInfoTest {
public static void main(String[] args) throws Exception {
//测试AnnotationTest类，得到此类的类对象
Class c=Class.forName( "com.iwtxokhtd.annotation.AnnotationTest" );
//获取该类所有声明的方法
Method []methods=c.getDeclaredMethods();
//声明注解集合
Annotation[] annotations;
//遍历所有的方法得到各方法上面的注解信息
for (Method method:methods){
//获取每个方法上面所声明的所有注解信息
annotations=method.getDeclaredAnnotations();
//再遍历所有的注解，打印其基本信息
for (Annotation an:annotations){
System.out.println( "方法名为：" +method.getName()+ " 其上面的注解为：" +an.annotationType().getSimpleName());
Method []meths=an.annotationType().getDeclaredMethods();
//遍历每个注解的所有变量
for (Method meth:meths){
System.out.println( "注解的变量名为：" +meth.getName());
}
}
}
}
}

转自：http://iwtxokhtd.javaeye.com/blog/359939