Java 中的注解详解及示例代码

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

注解可以做什么

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

1. 编译器指令
2. 构建时指令
3. 运行时指令
   

其中

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

注解基础

一个简单的java注解类似与@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")

注解使用

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

1. 类
2. 接口
3. 方法
4. 方法参数
5. 属性
6. 局部变量
   

一个完整的使用示例如下

@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中有三种内置注解，这些注解用来为编译器提供指令。它们是

1. @deprecated
2. @override
3. @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编译器这是一个注解。

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

1. 原始数据类型
2. string
3. class
4. annotation
5. 枚举
6. 一维数组
   

如下为应用自定义的注解

@myannotation(
  value="123",
  name="jakob",
  age=37,
  newnames={"jenkov", "peterson"}
)
public class myclass {


}

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

注解元素默认值

对于注解中的元素，我们可以为其设置默认值，使用方法为

@interface myannotation {
  string  value() default "";
  string  name();
  int   age();
  string[] newnames();
}

上述代码，我们设置了value元素的默认值为空字符串。当我们在使用时，可以不设置value的值，即让value使用空字符串默认值。 使用示例代码

@myannotation(
  name="jakob",
  age=37,
  newnames={"jenkov", "peterson"}
)
public class myclass {

}

@retention

@retention是用来修饰注解的注解，使用这个注解，我们可以做到

控制注解是否写入class文件
控制class文件中的注解是否在运行时可见

控制很简单，使用使用以下三种策略之一即可。

retentionpolicy.source 表明注解仅存在源码之中，不存在.class文件，更不能运行时可见。常见的注解为@override, @suppresswarnings。
retentionpolicy.class 这是默认的注解保留策略。这种策略下，注解将存在与.class文件，但是不能被运行时访问。通常这种注解策略用来处于一些字节码级别的操作。
retentionpolicy.runtime 这种策略下可以被运行时访问到。通常情况下，我们都会结合反射来做一些事情。

@retention的使用示例

import java.lang.annotation.retention;
import java.lang.annotation.retentionpolicy;

@retention(retentionpolicy.runtime)
@interface myannotation {
  string  value() default "";
}

@target

使用@target注解，我们可以设定自定义注解可以修饰哪些java元素。简单示例

import java.lang.annotation.elementtype;
import java.lang.annotation.target;

@target({elementtype.method})
public @interface myannotation {
  string  value();
}

上述的代码说明myannotation注解只能修饰方法。

@target可以选择的参数值有如下这些

1. elementtype.annotation_type（注：修饰注解）
2. elementtype.constructor
3. elementtype.field
4. elementtype.local_variable
5. elementtype.method
6. elementtype.package
7. elementtype.parameter
8. elementtype.type（注：任何类型，即上面的的类型都可以修饰）
   

@inherited

如果你想让一个类和它的子类都包含某个注解，就可以使用@inherited来修饰这个注解。

java.lang.annotation.inherited

@inherited
public @interface myannotation {

}
1
2
@myannotation
public class mysuperclass { ... }
1
public class mysubclass extends mysuperclass { ... }

上述代码的大致意思是

1.使用@inherited修饰注解myannotation
2.使用myannotation注解mysuperclass
3.实现一个类mysubclass继承自mysuperclass

通过以上几步，mysubclass也拥有了myannotation注解。

关于java中的注解，一些基本的概念就是这些。

以上 就是关于java 中的注解资料整理，后续继续补充相关资料，谢谢大家对本站的支持！