java中的注解

前言:

最近作项目时发现Spring框架运用了大量自定义注解,因此回过头来有必要深刻了解和整理关于注解的知识。

注解是java在1.5版本引入的新特性,随后一些开源组件也引入此项特性,如Spring,Hibernate,Mybatis。JPA规范更是全注解式

的。如下用到的示例代码均来自于<<Java编程思想第四版>>。

一.什么是注解

注解也被称为元数据。咱们能够在代码中添加信息,而后能够在须要的时候使用这些数据。经过在源代码级别保存注解,使得代码变得整洁便于维护。注解是语言级别的概念,享有编译期的类型检查保护。使用扩展的annotationAPI或者字节码工具类库,程序员拥有对源代码以及字节码强大的检查和操做能力。

二.定义注解

1.基本语法

import java.lang.annotation.*;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {}

没有元素的注解称为标记注解(marker  annotation),如以上定义的@Test,下面定义了一个包含两个元素的注解:

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

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

2.元注解

元注解负责注解其余注解。Java内置了四种元注解:

@Target	表示该注解能够用于什么地方。可能的ElementType参数包括: CONSTRUCTOR:构造器的声明 FIELD:域声明(包括enum实例) LOCAL_VARIABLE:局部变量声明 METHOD:方法声明 PACKAGE:包生明VM PARAMETER:参数声明 TYPE:类、接口(包括注解类型)或enum声明
@Retention	表示须要在生么级别保存该注解信息。可选的RetentionPolicy参数包括:  SOURCE:注解将被编译器丢弃。 CLASS:注解在class文件中可用,但会被VM丢弃。 RUNTIME: VM将在运行期也保留注解,所以能够经过反射机制读取注解的信息。
@Documented	将此注解包含在Javadoc中。
@Inherited	容许子类继承父类中的注解。

3.基本注解

Java同时内置了三种基本注解:

@Override 表示当前的方法定义将覆盖超类中的方法

@Deprecated 若是使用了注解为它的元素,编译器会发出警告信息

@SuppressWarnings 关闭编译器警告信息

4.注解中的元素

注解中的元素可用类型有:全部基本类型(int,float,boolean等),不容许包装类型,String,Class,enum,Annotation,以上类型的数组

默认值限制

1. 注解中的元素不能有不肯定的值。要么具备默认值,要么在使用注解时提供元素的值。
   

2. 对于非基本类型的元素,不管是在使用注解时，仍是在定义注解并设定元素默认值时,都不能为null。

注解不支持继承: 即不能使用关键字extends来继承某个@interface。

三.使用注解

 下面的PasswordUtils类中有三个方法使用了@UseCase

import java.util.List;

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();
  }
  @UseCase(id = 49, description =
  "New passwords can't equal previously used ones")
  public boolean checkForNewPassword(
    List<String> prevPasswords, String password) {
    return !prevPasswords.contains(password);
  }
}

四.注解处理器

下面是一个简单的注解处理器,它读取PassWordUtils类,并使用反射机制查找@UseCase标记。提供一组id值用于测试,它会列出找到的用例和缺失的用例。

import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

public class UseCaseTracker {
  public static void trackUseCases(List<Integer> 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);
    }
  }
  public static void main(String[] args) {
    List<Integer> useCases = new ArrayList<Integer>();
    Collections.addAll(useCases, 47, 48, 49, 50);
    trackUseCases(useCases, PasswordUtils.class);
  }
} 

/* Output:
Found Use Case:47 Passwords must contain at least one numeric
Found Use Case:48 no description
Found Use Case:49 New passwords can't equal previously used ones
Warning: Missing use case-50
*/