Java注解

Java注解

Spring中用到了Java注解，可Java注解究竟是怎么一回事呢？

什么是注解

注解用一个词来描述就是元数据，即一种描述数据的数据。比如我们经常使用@Override注解来标注被重写的方法，可是，即使我们不使用注解标注，程序也可以正确执行呀，那为什么还要注解呢。
事实上，@Override告诉编译器这个方法是一个重写方法(描述方法的元数据)，如果父类中不存在该方法，编译器便会报错，提示该方法没有重写父类中的方法。如果我不小心拼写错误，例如将toString()写成了toStrring(){double r}，而且我也没有使用@Override注解，那程序依然能编译运行。但运行结果会和我期望的大不相同。现在我们了解了什么是注解，并且使用注解有助于阅读程序。
在项目配置方面，注解会于代码相连。假如你想为应用设置很多的常量或参数，这种情况下，XML是一个很好的选择，因为它不会同特定的代码相连。如果你想把某个方法声明为服务，那么使用Annotation会更好一些，因为这种情况下需要注解和方法紧密耦合起来，开发人员也必须认识到这点。

Java SE5内置的三种标准注解

@Override重写
@Deprecated为它的元素编译发出警告，表示这是不赞成使用，被弃用的代码
@SuppressWarning关闭不当编译警告信息

创建新注解

Java提供了4种注解，负责创建新注解

• @Documented 将注解包含在JavaDoc中
• @Retention 表示需要在什么级别保存该注解信息。可选的RetentionPolicy参数包括：
  SOURCE：注解将被编译器丢弃
  CLASS：注解在class文件中可用，但会被VM丢弃
  RUNTIME：VM将在运行期间保留注解，因此可以通过反射机制读取注解的信息。
• @Target 注解用于什么地方
  可能的ElementType参数有：
  CONSTRUCTOR：构造器的声明
  FIELD：域声明（包括enum实例）
  LOCAL_VARIABLE：局部变量声明
  METHOD：方法声明
  PACKAGE：包声明
  PARAMETER：参数声明
  TYPE：类、接口（包括注解类型）或enum声明
• @Inherited 允许子类继承该注解

Example

• 定义一个注解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface UseCase {
      public String id();
      public String description() default "no description";
 }

在注解中一般会有一些元素以表示某些值。注解的元素看起来就像接口的方法，唯一的区别在于可以为其制定默认值。没有元素的注解称为标记注解
注解的可用的类型包括以下几种：所有基本类型、String、Class、enum、Annotation、以上类型的数组形式。元素不能有不确定的值，即要么有默认值，要么在使用注解的时候提供元素的值。而且元素不能使用null作为默认值。注解在只有一个元素且该元素的名称是value的情况下，在使用注解的时候可以省略“value=”，直接写需要的值即可。

• 使用注解

public class PasswordUtils {
     @UseCase(id = 47, description = "Passwords must contain at least one numeric")
     public boolean validatePassword(String password) {
         return (password.matches("\\w*\\d\\w*"));
     }
 
     @UseCase(id = 48)
     public String encryptPassword(String password) {
         return new StringBuilder(password).reverse().toString();
     }
 }

• 对注解进行处理

public static void main(String[] args) {
     List useCases = new ArrayList();
     Collections.addAll(useCases, 47, 48, 49, 50);
     trackUseCases(useCases, PasswordUtils.class);
 }
 public static void trackUseCases(List useCases, Class cl) {
     for (Method m : cl.getDeclaredMethods()) {
         UseCase uc = m.getAnnotation(UseCase.class);
         if (uc != null) {
             System.out.println("Found Use Case:" + uc.id() + " "
                         + uc.description());
             useCases.remove(new Integer(uc.id()));
         }
     }
     for (int i : useCases) {
         System.out.println("Warning: Missing use case-" + i);
     }
 }

 ----------------------------------
运行结果
Found Use Case:47 Passwords must contain at least one numeric
Found Use Case:48 no description
Warning: Missing use case-49
Warning: Missing use case-50

参考文献

java中注解的使用与实例(一)
Java中的注解是如何工作的？