注解

注解

注解（注释，标注，Annotation）的作用

如果要对于注解的作用进行分类，我们可以根据它所起的作用，大致可分为三类：

​ 编写文档：通过代码里标识的元数据生成文档。

​ 代码分析：通过代码里标识的元数据对代码进行分析。

​ 编译检查：通过代码里标识的元数据让编译器能实现基本的编译检查。

定制注释类型

我们可以自定义注解类型，如下例：

**public @interface** NewAnnotation { 

}

使用定制的注释类型

我们已经成功地创建好一个注释类型 NewAnnotation ，现在让我们来尝试使用它。

public class** AnnotationTest { 

​	@NewAnnotation 

**public static void** main(String[] args) { 

​	} 

}

添加变量

​ J2SE 5.0 里，我们了解到内置注释@SuppressWarnings() 是可以使用参数的，那么自定义注释能不能定义参数个数 和类型呢？答案是当然可以，但参数类型只允许为基本类型、String 、Class 、枚举类型、数组等，并且参数不能为空。我 们来扩展 NewAnnotation ，为之添加一个String 类型的参数，示例代码如下：

public @interface** NewAnnotation { 

String value();//在写注解的时候value参数中value=可以省略，其它参数名不能省 

}	

使用该注释的代码如下，该注释的使用有两种写法：

public class** AnnotationTest { 

​	@NewAnnotation("Just A Test") 

**public static void** main(String[] args) { 

​	sayHello*(); 

	} 

@NewAnnotation(value="sayHello") 

**public static void** sayHello(){ 

	} 

}

为变量赋默认值

public @interface** Greeting { 

**public enum** FontColor{ 

	*RED*,*GREEN*,*BLUE* 

} 

	String title(); 

	String content(); 

FontColor fontColor() **default** FontColor.*RED*; 

}

@Greeting(title="健康",content="你最近身体好吗 

	",fontColor=FontColor.*BLUE*) 

**public static void** sayHello(String name){ 

} 

内置注解

JavaSE中内置三个标准注解，定义在java.lang中：

@Override

​ 限定重写父类方法，若想要重写父类的一个方法时，需要使用该注解告知编译器我们正在重写一个方法。如此一 来，当父类的方法被删除或修改了，编译器会提示错误信息；或者该方法不是重写也会提示错误。

public interface Car { 

	void run(); 

}

class QQ implements Car{ 

	@Override 

	public void run() {} 

}

class Bmw implements Car{ 

	@Override 

	void run() {} 

}

@Deprecated

​ 标记已过时，当我们想要让编译器知道一个方法已经被弃用(deprecate)时，应该使用这个注解。Java推荐在 javadoc中提供信息，告知用户为什么这个方法被弃用了，以及替代方法是什么

/**

\* Deprecated -->该方法过时(有更好的解决方案) 

\* @author Administrator 

*/ 

public class TestDeprecated { 

@Deprecated 

public int test(){ 

	System.out.println("TestDeprecated.test()"); 

	return 0; 

}

public void test(int a){ 

	System.out.println("TestDeprecated.test(int)"); 

	} 

}

@SuppressWarnings

​ 抑制编译器警告，该注解仅仅告知编译器，忽略它们产生了特殊警告。如：在java泛型中使用原始类型。其保持性 策略(retention policy)是SOURCE，在编译器中将被丢弃。

/**

\* SuppressWarnings 压制警告 

\* @author Administrator 

*/ 

public class TestSuppressWarnings { 

	public static void main(String[] args) { 

	@SuppressWarnings("unused") 

	List<String> list =new ArrayList<String>(); 

}

	@SuppressWarnings("rawtypes") //没有定义范型

	public static List test(){ 

		return new ArrayList(); 

	} 

}

自定义注解

@interface:用来声明一个注解。注解类里的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名 称，返回值类型就是参数的类型。可以通过default来声明参数的默认值。

@interface Simple{ 

//这里定义了一个空的注解，它能干什么呢？我也不知道，但他能用。后面有补充 

}

使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细 节。在定义注解时，不能继承其他的注解或接口。

@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返 回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数 的默认值。

public @interface 注解名{定义体}

元注解

用来注解"注解"的注解

@Target

**用于描述注解的使用范围（即：被描述的注解可以用在什么地方）。**表示支持注解的程序元素的种类，一些可能的 值有TYPE, METHOD, CONSTRUCTOR, FIELD等等。如果Target元注解不存在，那么该注解就可以使用在任何程序

元素之上。取值(ElementType)有：

1.CONSTRUCTOR:用于描述构造器

2.FIELD:用于描述域

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

4.METHOD:用于描述方法

5.PACKAGE:用于描述包

6.PARAMETER:用于描述参数

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

//此注解只能用在方法上 

@Target(ElementType.METHOD) 

@interface TestMethod {} 

@Retention

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

类型保留时间的长短。取值(RetentionPoicy)有：

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

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

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

// 此注解可以用于注解类、接口(包括注解类型) 或enum声明 

@Target(ElementType.TYPE) 

//该注解运行时有效。注解处理器可以通过反射，获取到该注解的属性值，从而去做一些运行时的逻辑处理 

@Retention(RetentionPolicy.RUNTIME) 

@interface TestRn{ 

}

@Documented

​ 表示使用该注解的元素应被javadoc或类似工具文档化，它应用于类型声明，类型声明的注解会影响客户端对注解 元素的使用。如果一个类型声明添加了Documented注解，那么它的注解会成为被注解元素的公共API的一部分， @Documented是一个标记注解

//可以被例如javadoc此类的工具文档化 

@Documented 

@interface TestDoc{ 

}

@Inherited

​ 表示一个注解类型会被自动继承，如果用户在类声明的时候查询注解类型，同时类声明中也没有这个类型的注解， 那么注解类型会自动查询该类的父类，这个过程将会不停地重复，直到该类型的注解被找到为止，或是到达类结构 的顶层（Object）。

//被子类继承的注解 

@Inherited 

@interface TestInheri{}

注解参数**(即方法)**

注解里面的每一个方法实际上就是声明了一个配置参数

只能用public或默认(default)这两个访问权修饰 ，默认为default

注解体重点方法的返回值，作为注解参数，只支持以下数据类型：

基本数据类型（int,float,boolean,byte,double,char,long,short)； 

String类型； 

Class类型； 

enum类型； 

Annotation类型; 

以上所有类型的数组

对取名没有要求，如果只有一个参数成员,最好把参数名称设为"value",后加小括号。

注解中的方法不能存在参数

可以包含默认值，使用default来声明默认值

/*

\* 码农定义注解 

*/ 

@Target(ElementType.FIELD) 

@Retention(RetentionPolicy.RUNTIME) 

@Documented 

@interface Programmer{ 

String value() default "马云"; 

}

/**

\* 码农类型注解 

\* @author peida 

*/ 

@Target(ElementType.FIELD) 

@Retention(RetentionPolicy.RUNTIME) 

@Documented 

@interface ProgrammerType { 

/**

\* 类型枚举 程序猿 射鸡师 

*/ 

public enum CoderType{MONKEYS,LION,CHOOK}; 

/**

\* 颜色属性 

*/ 

CoderType type() default CoderType.MONKEYS; 

}

/**

\* 码农制造厂 

\* @author Administrator 

*/ 

@Target(ElementType.FIELD) 

@Retention(RetentionPolicy.RUNTIME) 

@Documented 

@interface ProgrammerProductor { 

/**

\* 厂家编号 

\* @return 

*/ 

public int id() default -1; 

/**

\* 厂家名称 

\* @return 

*/ 

public String name() default "shsxt"; 

/**

\* 厂家地址 

\* @return 

*/ 

public String address() default "上海"; 

}

/**

\* 注解使用 

*/

class Coder{ 

@Programmer("老裴") 

private String coderName; 

@ProgrammerType(type=CoderType.MONKEYS) 

private String coderType; 

@ProgrammerProductor(id=1,name="程序猿乐园",address="浦东新区") 

private String coderProductor; 

public String getCoderName() { 

return coderName; 

}

public void setCoderName(String coderName) { 

this.coderName = coderName; 

}

public String getCoderType() { 

return coderType; 

}

public void setCoderType(String coderType) { 

this.coderType = coderType; 

}

public String getCoderProductor() { 

return coderProductor; 

}

public void setCoderProductor(String coderProductor) { 

this.coderProductor = coderProductor; 

	} 

}