浅谈Java中的注解

2016-03-13 本文已影响1597人 Neulana

概述

注解（也被称为元数据）为我们在代码中添加信息提供了一种形式化的方法，使我们可以在稍后某个时刻非常方便地使用这些数据。仔细读这句话，我们可以得到几个关键词“形式化”、“稍后使用”。形式化使得代码变得更加干净易读。注解会在编译期接收类型检查。
注解的语法比较简单，以“@”符号开始，JAVA SE5内置了三种，定义在java.lang中的注解：

@Override，表示当前方法覆盖了父类中同名的方法，如果在这个注解下的方法在父类中没有出现过，就证明是程序员不小心写错代码了，这时由于有这个注解，编译器就会提示此处的代码有错。
@Deprecated，如果程序员使用了注解为它的元素，那么编译器会发出警告信息。比如在不断更新的JDK中，有的元素会在将来的JDK版本中删除，IDE就会自动替你添加这个注解，起警告的作用，告诉你最好是不要这么用，但是你强行要这么用的话还是能够通过编译。
@SuppressWarnings，关闭不当的编译器警告信息。要注意的是SuppressWarnings和前两个注释不一样。这个注释有一个属性。当然，还可以抑制其它警告，如:
@SuppressWarnings (value={"unchecked", "fallthrough"})

定义注解

Java还另外提供了四种注解，专门负责新注解的创建。注解的定义看起来很像接口发的定义，仔细观察：

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

除了@符号外，@Test的定义很像一个空的接口。定义注解时，需要一些元注解（meta-annotation），如@Target和@Retention，@Target用来定义你的注解将用在什么地方，是方法前还是域前，或者类前。@Retention用来定义该注解在哪一个级别可用，在源代码中（SOURCE)，类文件中（CLASS）或者运行时（RUNTIME)。

四种元注解分别是@Target，@Retention，@Documented，@Inherited。

Target注解

表示注解可用于什么地方。可能的ElementType参数包括：

CONSTRUCTOR：构造器的声明
FIELD：域声明（包括enum的声明）
LOCAL_VARIABLE：局部变量的声明
METHOD：方法声明
PACKAGE：包声明
PARAMETER：参数声明
TYPE：类、接口（包括注解类型）或enum声明

Retention注解

RetentionPolicy.SOURCE —— 这种类型的Annotations只在源代码级别保留,编译时就会被忽略。
RetentionPolicy.CLASS —— 这种类型的Annotations编译时被保留,在class文件中存在,但JVM将会忽略。
RetentionPolicy.RUNTIME —— 这种类型的Annotations将被JVM保留,所以他们能在运行时被JVM或其他使用反射机制的代码所读取和使用。

Documented注解

Documented 注解表明这个注解应该被 javadoc工具记录。默认情况下,javadoc是不包括注解的，但如果声明注解时指定了 @Documented，则它会被 javadoc 之类的工具处理, 所以注解类型信息也会被包括在生成的文档中，标注此类接口、方法、字段已经被废止。

Inherited注解

允许子类继承父类中的注解。

编写注解处理器

谁用注解的过程中，很重要的一个部分就是创建与使用注解处理器。下面通过一个完整的例子来说明怎么定义与使用注解处理器。
注释类

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{
     int id();
     String description() default "no description";
}

使用注释

public class PasswordUtils {
    @UseCase(id=1,description = "Passwords must contain at least one numeric")
    public boolean validatePassword(String password){
        return (password.matches("\\w*\\d\\w*"));
    }
    @UseCase(id=2)
    public String encryptPassword(String password){
        return new StringBuilder(password).reverse().toString();
    }
    @UseCase(id=3,description = "New passwords can't equal previously used ones")
    public boolean checkForNewPassword(List<String> prevPasswords,String password){
        return !prevPasswords.contains(password);
    }
}

注释处理器

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,1,2,3,4);
        trackUseCases(useCases,PasswordUtils.class);
    }
}

结果打印输出

注解的元素在使用时表现为名-值对的形式，并需要置于@UseCase声明之后的括号内。在encryptPassword()方法的注解中，并没有给出description元素的值，因此，在UseCase的注解处理器分析处理这个类时会使用该元素的默认值。这个程序用到了两个反射的方法getDeclaredMethods()和getAnnotation()，它们都属于AnnotatedElement接口（Class、Method与Field等类都实现了该接口。

结尾

通过以上例子我们可以看到，注解通常是跟反射机制一起使用的，我在看反射的时候还在想呢，这个反射到底有什么用，你看这儿不是用着了吗，所以知识都是有用的，只是你“暂时”还不知道怎么用罢了。