深入理解Java注解类型(@Annotation)

实际上Java注解与普通修饰符(public、static、void等)的使用方式并没有多大区别,下面的例子是常见的注解:
public class AnnotationDemo {
    //@Test注解修饰方法A
    @Test
    public static void A(){
        System.out.println(“Test…..”);
    }

    //一个方法上可以拥有多个不同的注解
    @Deprecated
    @SuppressWarnings(“uncheck”)
    public static void B(){

    }
}
通过在方法上使用@Test注解后,在运行该方法时,测试框架会自动识别该方法并单独调用,@Test实际上是一种标记注解,起标记作用,运行时告诉测试框架该方法为测试方法。而对于@Deprecated和@SuppressWarnings(“uncheck”),则是Java本身内置的注解,在代码中,可以经常看见它们,但这并不是一件好事,毕竟当方法或是类上面有@Deprecated注解时,说明该方法或是类都已经过期不建议再用,@SuppressWarnings 则表示忽略指定警告,比如@SuppressWarnings(“uncheck”),这就是注解的最简单的使用方式,那么下面我们就来看看注解定义的基本语法

基本语法

声明注解与元注解

我们先来看看前面的Test注解是如何声明的:
//声明Test注解
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {

我们使用了@interface声明了Test注解,并使用@Target注解传入ElementType.METHOD参数来标明@Test只能用于方法上,@Retention(RetentionPolicy.RUNTIME)则用来表示该注解生存期是运行时,从代码上看注解的定义很像接口的定义,确实如此,毕竟在编译后也会生成Test.class文件。对于@Target和@Retention是由Java提供的元注解,所谓元注解就是标记其他注解的注解,下面分别介绍:
  • @Target 用来约束注解可以应用的地方(如方法、类或字段),其中ElementType是枚举类型,其定义如下,也代表可能的取值范围
public enum ElementType {
    /**标明该注解可以用于类、接口(包括注解类型)或enum声明*/
    TYPE,

    /** 标明该注解可以用于字段(域)声明,包括enum实例 */
    FIELD,

    /** 标明该注解可以用于方法声明 */
    METHOD,

    /** 标明该注解可以用于参数声明 */
    PARAMETER,

    /** 标明注解可以用于构造函数声明 */
    CONSTRUCTOR,

    /** 标明注解可以用于局部变量声明 */
    LOCAL_VARIABLE,

    /** 标明注解可以用于注解声明(应用于另一个注解上)*/
    ANNOTATION_TYPE,

    /** 标明注解可以用于包声明 */
    PACKAGE,

    /**
     * 标明注解可以用于类型参数声明(1.8新加入)
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * 类型使用声明(1.8新加入)
     * @since 1.8
     */
    TYPE_USE
}
  • @Retention用来约束注解的生命周期,分别有三个值,源码级别(source),类文件级别(class)或者运行时级别(runtime),其含有如下:
SOURCE:注解将被编译器丢弃(该类型的注解信息只会保留在源码里,源码经过编译后,注解信息会被丢弃,不会保留在编译好的class文件里)
CLASS:注解在class文件中可用,但会被VM丢弃(该类型的注解信息会保留在源码里和class文件里,在执行的时候,不会加载到虚拟机中),请注意,当注解未定义Retention值时,默认值是CLASS,如Java内置注解,@Override、@Deprecated、@SuppressWarnning等
RUNTIME:注解信息将在运行期(JVM)也保留,因此可以通过反射机制读取注解的信息(源码、class文件和执行的时候都有注解的信息),如SpringMvc中的@Controller、@Autowired、@RequestMapping等。

注解元素及其数据类型

通过上述对@Test注解的定义,我们了解了注解定义的过程,由于@Test内部没有定义其他元素,所以@Test也称为标记注解(marker annotation),但在自定义注解中,一般都会包含一些元素以表示某些值,方便处理器使用,这点在下面的例子将会看到:
/**
 * Created by wuzejian on 2017/5/18.
 * 对应数据表注解
 */
@Target(ElementType.TYPE)//只能应用于类上
@Retention(RetentionPolicy.RUNTIME)//保存到运行时
public @interface DBTable {
    String name() default “”;

}

上述定义一个名为DBTable的注解,该用于主要用于数据库表与Bean类的映射(稍后会有完整案例分析),与前面Test注解不同的是,我们声明一个String类型的name元素,其默认值为空字符,但是必须注意到对应任何元素的声明应采用方法的声明方式,同时可选择使用default提供默认值,@DBTable使用方式如下:
//在类上使用该注解
@DBTable(name = “MEMBER”)
public class Member {
    //…….
}
关于注解支持的元素数据类型除了上述的String,还支持如下数据类型
  • 所有基本类型(int,float,boolean,byte,double,char,long,short)
  • String
  • Class
  • enum
  • Annotation
  • 上述类型的数组
倘若使用了其他数据类型,编译器将会丢出一个编译错误,注意,声明注解元素时可以使用基本类型但不允许使用任何包装类型,同时还应该注意到注解也可以作为元素的类型,也就是嵌套注解,下面的代码演示了上述类型的使用过程:
package com.zejian.annotationdemo;

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

/**
 * Created by wuzejian on 2017/5/19.
 * 数据类型使用Demo
 */

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface Reference{
    boolean next() default false;
}

public @interface AnnotationElementDemo {
    //枚举类型
    enum Status {FIXED,NORMAL};

    //声明枚举
    Status status() default Status.FIXED;

    //布尔类型
    boolean showSupport() default false;

    //String类型
    String name()default “”;

    //class类型
    Class<?> testCase() default Void.class;

    //注解嵌套
    Reference reference() default @Reference(next=true);

    //数组类型
    long[] value();

}

编译器对默认值的限制

编译器对元素的默认值有些过分挑剔。首先,元素不能有不确定的值。也就是说,元素必须要么具有默认值,要么在使用注解时提供元素的值。其次,对于非基本类型的元素,无论是在源代码中声明,还是在注解接口中定义默认值,都不能以null作为值,这就是限制,没有什么利用可言,但造成一个元素的存在或缺失状态,因为每个注解的声明中,所有的元素都存在,并且都具有相应的值,为了绕开这个限制,只能定义一些特殊的值,例如空字符串或负数,表示某个元素不存在。

注解不支持继承

注解是不支持继承的,因此不能使用关键字extends来继承某个@interface,但注解在编译后,编译器会自动继承java.lang.annotation.Annotation接口,这里我们反编译前面定义的DBTable注解:
package com.zejian.annotationdemo;

import java.lang.annotation.Annotation;
//反编译后的代码
public interface DBTable extends Annotation
{
    public abstract String name();
}
虽然反编译后发现DBTable注解继承了Annotation接口,请记住,即使Java的接口可以实现多继承,但定义注解时依然无法使用extends关键字继承@interface。

Java内置注解与其它元注解

接着看看Java提供的内置注解,主要有3个,如下:
  • @Override:用于标明此方法覆盖了父类的方法,源码如下
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {

}

  • @Deprecated:用于标明已经过时的方法或类,源码如下,关于@Documented稍后分析:
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
public @interface Deprecated {
}
  • @SuppressWarnnings:用于有选择的关闭编译器对类、方法、成员变量、变量初始化的警告,其实现源码如下:
@Target({TYPEFIELDMETHODPARAMETERCONSTRUCTORLOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {
    String[] value();

}

注解与反射机制

前面经过反编译后,我们知道Java所有注解都继承了Annotation接口,也就是说 Java使用Annotation接口代表注解元素,该接口是所有Annotation类型的父接口。同时为了运行时能准确获取到注解的相关信息,Java在java.lang.reflect 反射包下新增了AnnotatedElement接口,它主要用于表示目前正在 VM 中运行的程序中已使用注解的元素,通过该接口提供的方法可以利用反射技术地读取注解的信息,如反射包的Constructor类、Field类、Method类、Package类和Class类都实现了AnnotatedElement接口。
  • Class:类的Class对象定义  
  • Constructor:代表类的构造器定义  
  • Field:代表类的成员变量定义
  • Method:代表类的方法定义  
  • Package:代表类的包定义
下面是AnnotatedElement中相关的API方法,以上5个类都实现以下的方法:
深入理解Java注解类型(@Annotation)
AnnotatedElement方法

应用

这个例子不是原博主的,是我自己在生产中遇到的例子,早年间做一个基于业务系统的DAL层, 就是和数据库打交道封装数据库的访问(redis, mysql, cassandra)。
假设有一个javaBean定义如下:
Device {
    int id;
    String appName;
    String appVersion;

}

而数据库里面存的是:
Device:
int id;
String app_name;
String app_version;
假如我们需要根据id查询app_name,那么DAL暴露如下接口:
String getAppNameById(int id);
这个时候我们当然会用mybatis写sql:
select * from Device where id = xxx;
但是出来的结果怎么和Bean对应起来呢?
需要用到如下对应关系:
app_name -> appName
app_version -> appVersion
所以就用到了注解获取field的命名,部分关键代码如下:
  //cassandraClient.java
    public void setDeviceFactoryInfo(
            DeviceFactoryInfoEntity deviceFactoryInfo) throws Exception {
        if (deviceFactoryInfo == null) {
            return;
        }
        if (deviceFactoryInfo.getDeviceId() == null) {
            throw new NullPointerException(“device id is null”);
        }
        Update update = QueryBuilder.update(“cloud”“device_factory_info”);
        Map<String, Method> methodMap =
                getMethodMapping(deviceFactoryInfo.getClass());
        for (Map.Entry<String, Method> entry : methodMap.entrySet()) {
            Object value = entry.getValue().invoke(deviceFactoryInfo);
            if (value != null) {
                update.with(QueryBuilder.set(entry.getKey(), value));
            }
        }
        update.where(QueryBuilder.eq(“device_id”,
                deviceFactoryInfo.getDeviceId()));
        if (logger.isDebugEnabled()) {
            logger.debug(“cassandra.update.cql:{}”, update.getQueryString());
        }
        try {
            deviceDao.execute(update);
        } catch (Exception e) {
            logger.error(“cassandra.update.failed:” + e.toString());
            throw e;
        }
    }

    public Map<String, Method> getMethodMapping(Class<?> clazz) {
        if (cachedName.containsKey(clazz)) {
            return cachedName.get(clazz);
        }

        Method[] methods = clazz.getMethods();
        Map<String, Method> methodMap = new HashMap<>();
        for (Method method : methods) {
            methodMap.put(method.getName(), method);
        }
        Map<String, Method> columnMap = new HashMap<>();
        Field[] fields = clazz.getDeclaredFields();
        for (Field field : fields) {
            Column column = field.getAnnotation(Column.class);
            if (column != null &&
                    field.getAnnotation(PartitionKey.class) == null) {
                String fieldName = field.getName();
                String methodName = “get” + fieldName.substring(01)
                        .toUpperCase() +
                        fieldName.substring(1, fieldName.length());
                columnMap.put(column.name(), methodMap.get(methodName));
            }
        }
        cachedName.put(clazz, columnMap);
        return columnMap;
    }
本站所有文章均来自互联网,如有侵权,请联系站长删除。极客文库 » 深入理解Java注解类型(@Annotation)
分享到:
赞(0)

评论抢沙发

评论前必须登录!