JDK1.5新特性(七)……Annotations

概述

Annotations (Metadata) - This language feature lets you avoid writing boilerplate code under many circumstances by enabling tools to generate it from annotations in the source code. This leads to a "declarative" programming style where the programmer says what should be done and tools emit the code to do it. Also it eliminates the need for maintaining "side files" that must be kept up to date with changes in source files. Instead the information can be maintained inthe source file.

Annotation，即注解

所谓注解，顾名思义，就是为Java的类或者方法在添加一个带有提示功能的注释，与注释不同的是，它相当于一个接口，这个接口中定义了一些具有提示意义的方法，所以，注解的作用就是提示功能，且不影响原来代码的语法

我们也可以看到，注解的标识符为@interface，也就代表了，它是一个与接口类似的类，它的使用范围和访问性都与接口相似

标准的注解与使用

Java在lang包中提供的标准注解有以下三个

注释类型
Deprecated
Override
SuppressWarnings

Deprcated代表被注释的元素已经过时

Override代表被注释的元素是复写了父类的实现

SuppressWarning代表被注释的元素取消编译器警告

下面就是这个三个注解的应用

public class SimpleAnnotationTest {

    /**
     * @param args
     */
    @SuppressWarnings("Deprecation")//忽略编译器对show方法的过时警告
    public static void main(String[] args) {
        // TODO Auto-generated method stub

        show();
    }

    @Deprecated//注明此方法已过时
    public static void show(){
        System.out.println("hello");
    }

    @Override//复写了父类的toString方法
    public String toString() {
        // TODO Auto-generated method stub
        return super.toString();
    }
}

自定义注解

通过上面对注解有一些了解之后，我们发现，注解就相当于一个框架的提示，使得程序能够更好的按照框架来编写

为了更好的体现自己框架的一些特性，我们可以自定义注解

元注解

在定义注解之前，首先我们要了解一下什么是元注解

所谓元注解，就是注解的注解，也就是说有些注解是专门为注解提供注解的

比如，Override注解的定义如下

@Target(value=METHOD)

@Retention(value=SOURCE)

public @interface Override

其中Target与Rentention就是两种最常见的元注解

Target用来指明被注解的元素的范围，这里是方法元素

Retention用来指明被注解的元素保留时期，分别是源代码阶段(SOURCE)、字节码阶段(CLASS)、运行阶段(RUNTIME)

注解的格式

注解的标识符为@interface

注解中的成员与接口类似，比如String value();

我们可以为其制定缺省值，比如String value() default “red”；

如果注解中有一个名称为value的属性，且你只想设置value属性（即其他属性都采用默认值或者你只有一个value属性），那么可以省略value=部分，例如：@MyAnnotation("lhm")。

好了，那我们来定义自己的注解

/**
 * @author Shawn
 *
 */
//运行阶段的注解
@Retention(RetentionPolicy.RUNTIME)
//方法上的注解
@Target(ElementType.METHOD)
public @interface MyAnnotation {
    //此属性表示被注解的方法使用权限
    Limits limit() default Limits.USER;
}

这里的权限是自己定义的一个枚举

//权限
public enum Limits {
    ADMIN,//Admin权限
    USER;//user权限
}

注解的使用

注解的使用可以通过反射

利用反射获得注解的实例对象，通过这个对象，我们可以获取其中的属性值

public class AnnotationTest {

    /**
     * @param args
     * @throws NoSuchMethodException
     * @throws SecurityException
     * @throws InvocationTargetException
     * @throws IllegalAccessException
     * @throws IllegalArgumentException
     */
    public static void main(String[] args) throws SecurityException, NoSuchMethodException, IllegalArgumentException, IllegalAccessException, InvocationTargetException {

        //创建一个用户
        User me = new User(Limits.USER);

        //通过反射得到方法上注解的实例对象
        Method method = AnnotationTest.class.getMethod("show", null);
        MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);
        //判断注解中声明的权限
        if(annotation.limit() == Limits.USER){
            method.invoke(me, null);
        }
        else{
            System.out.println("Sorry,you don't have limits to invoke "+method.getName()+" method");
        }
    }
    //注释show方法的权限
    @MyAnnotation(limit=Limits.ADMIN)
    public static void show(){
        System.out.println("hello");
    }
}

上面的例子就实现了一个简单的权限机制，我们可以想象，这对框架的作用是非常大的，减少了很多不必要的代码

由于注解的强大，相信不是这么简单就可以说明白的，上面只是简单介绍了一下，关于注解的进一步分析，会在今后继续讨论。。