在Java中，注解(Annotation)引入始于Java5，用来描述Java代码的元信息，通常情况下注解不会直接影响代码的执行，尽管有些注解可以用来做到影响代码执行。

注解可以做什么

Java中的注解通常扮演以下角色

编译器指令构建时指令运行时指令

其中

Java内置了三种编译器指令，本文后面部分会重点介绍Java注解可以应用在构建时，即当你构建你的项目时。构建过程包括生成源码，编译源码，生成xml文件，打包编译的源码和文件到JAR包等。软件的构建通常使用诸如Apache Ant和Maven这种工具自动完成。这些构建工具会依照特定的注解扫描Java代码，然后根据这些注解生成源码或文件。通常情况下，注解并不会出现在编译后的代码中，但是如果想要出现也是可以的。Java支持运行时的注解，使用Java的反射我们可以访问到这些注解，运行时的注解的目的通常是提供给程序和第三方API一些指令。

注解基础

一个简单的Java注解类似与<code>@Entity。其中@的意思是告诉编译器这是一个注解。而Entity则是注解的名字。通常在文件中，写法如下

public @interface Entity { -- --> }

注解元素

Java注解可以使用元素来进行设置一些值，注解中的元素类似于属性或者参数。定义包含元素的注解示例代码

public @interface Entity { String tableName(); }

使用包含元素的注解示例代码

@Entity(tableName = "vehicles")

上述注解的元素名称为tableName，设置的值为vehicles。没有元素的注解不需要使用括号。

如果注解包含多个元素，使用方法如下

@Entity(tableName = "vehicles", primaryKey = "id")

如果注解只有一个元素，通常我们的写法是这样的

@InsertNew(value = "yes")

但是这种情况下，当且仅当元素名为value,我们也可以简写，即不需要填写元素名value，效果如下

@InsertNew("yes")

注解使用

注解可以用来修饰代码中的这些元素

类接口方法方法参数属性局部变量

一个完整的使用示例如下

@Entity

public class Vehicle {

@Persistent

protected String vehicleName = null;

@Getter

public String getVehicleName() {

return this.vehicleName;

}

public void setVehicleName(@Optional vehicleName) {

this.vehicleName = vehicleName;

}

public List addVehicleNameToList(List names) {

@Optional

List localNames = names;

if(localNames == null) {

localNames = new ArrayList();

}

localNames.add(getVehicleName());

return localNames;

}

}

内置的Java注解

Java中有三种内置注解，这些注解用来为编译器提供指令。它们是

@Deprecated@Override@SuppressWarnings

@Deprecated

可以用来标记类，方法，属性。如果上述三种元素不再使用，使用@Deprecated注解如果代码使用了@Deprecated注解的类，方法或属性，编译器会进行警告。

@Deprecated使用很简单，如下为注解一个弃用的类。

@Deprecated

public class MyComponent {

}

当我们使用@Deprecated注解后，建议配合使用对应的@deprecated JavaDoc符号，并解释说明为什么这个类，方法或属性被弃用，已经替代方案是什么。

@Deprecated

/**

@deprecated This class is full of bugs. Use MyNewComponent instead.

*/

public class MyComponent {

}

@Override

@Override注解用来修饰对父类进行重写的方法。如果一个并非重写父类的方法使用这个注解，编译器将提示错误。

实际上在子类中重写父类或接口的方法，@Overide并不是必须的。但是还是建议使用这个注解，在某些情况下，假设你修改了父类的方法的名字，那么之前重写的子类方法将不再属于重写，如果没有@Overide，你将不会察觉到这个子类的方法。有了这个注解修饰，编译器则会提示你这些信息。

使用Override注解的例子

public class MySuperClass {

public void doTheThing() {

System.out.println("Do the thing");

}

}

public class MySubClass extends MySuperClass{

@Override

public void doTheThing() {

System.out.println("Do it differently");

}

}

@SuppressWarnings

@SuppressWarnings用来抑制编译器生成警告信息。可以修饰的元素为类，方法，方法参数，属性，局部变量

使用场景：当我们一个方法调用了弃用的方法或者进行不安全的类型转换，编译器会生成警告。我们可以为这个方法增加@SuppressWarnings注解，来抑制编译器生成警告。

注意：使用@SuppressWarnings注解，采用就近原则，比如一个方法出现警告，我们尽量使用@SuppressWarnings注解这个方法，而不是注解方法所在的类。虽然两个都能抑制编译器生成警告，但是范围越小越好，因为范围大了，不利于我们发现该类下其他方法的警告信息。

使用示例

@SuppressWarnings public void methodWithWarning() {

}

创建自己的注解

在Java中，我们可以创建自己的注解，注解和类，接口文件一样定义在自己的文件里面。如下

@interface MyAnnotation {

String value();

String name();

int age();

String[] newNames();

}

上述代码定义了一个叫做MyAnnotation的注解，它有4个元素。再次强调一下，@interface这个关键字用来告诉java编译器这是一个注解。

仔细一看，你会发现，注解元素的定义很类似于接口的方法。这些元素有类型和名称。这些类型可以是

原始数据类型StringClassannotation枚举一维数组

如下为应用自定义的注解

@MyAnnotation(

value="123",code>

name="Jakob",code>

age=37,

newNames={ -- -->"Jenkov", "Peterson"}

)

public class MyClass {

}

注意，我们需要为所有的注解元素设置值，一个都不能少。

注解元素默认值