java注解前世今生

添加时间:2016-7-15 10:55:04 编辑:罗建东 阅读:405


前序:


很开心下了班以后坐在电脑前面写这篇文章。注解Annotation我们常常见到jdk中的@override、@Deprecated、@SuppressWarnings 还有我本人认为非常优秀的开源项目spring中的IOC的@controller、@autowired和AOP的@Around @Before @After还有hibernate等我就不都枚举了。既然用的地方这么多所以我们就还是有必要揭开它的面纱看看它到底是怎么玩的。

1、属性全解


Java中提供了四种元注解,专门负责注解其他的注解,分别如下:
@Retention     @Target     @Documented    @Inheried

先拿@override 的源码来作为一个切入点:
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

@Target:说明了Annotation所修饰的对象范围,取值在一个枚举ElementType中,查看源码(局限于1.7。since1.8以后又新增了2个)
public enum ElementType {
    TYPE,              用于描述类、接口(包括注解类型) 或enum声明
    FIELD,             成员变量、对象、属性(包括enum实例)
    METHOD,            方法声明
    PARAMETER,         参数声明
    CONSTRUCTOR,       构造器声明
    LOCAL_VARIABLE,    局部变量声明
    ANNOTATION_TYPE,   元注解,有兴趣的可以看看@Retention、@Target、@Documented、@Inheried的@Target(ElementType.ANNOTATION_TYPE)都是如此
    PACKAGE            包声明
}

@Retention:表示需要在什么级别保存该注释信息(生命周期)。可选的RetentionPoicy参数包括:
public enum RetentionPolicy {
    SOURCE,            停留在java源文件,编译器被丢掉
    CLASS,             停留在class文件中,但会被JVM丢弃(默认)
    RUNTIME            内存中的字节码,JVM将在运行时也保留注解,因此可以通过反射机制读取注解的信息,所以我们自己开发注解的话一般都是RUNTIME,这样的话就可以通过注解来搞搞
}

@Documented:一个简单的Annotations标记注解,表示是否将注解信息添加在java文档中。这个我们实际使用的会相对很少,因为我们大多会用在功能实现上。

@Inherited:指定Annotation具有继承性,上个例子:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface InheritedDemo {
}
//父类使用了Inherited注解
@InheritedDemo
public class Father {
}
//子类验证对于InheritedDemo注解是否有传递性
public class Child extends Father {
    public static void main(String[] args) {
    //输出为true
        System.out.println(Child.class.isAnnotationPresent(InheritedDemo.class));
    }
}

2、编写自己的注解


记得最早期的时候在一家金融公司有用到注解的一个场景是,定义类中的每个属性的名称、类型及描述,好吧我们就开始着手写代码吧:
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface FieldDesc {
    //定义数据类型枚举
    enum DataType{String,Integer,Long,Boolean,Double};
    //名称
    String name() ;
    //数据类型
    DataType dataType();
     //中文描述
    String desc()  default "";
}
public class AnnationStudent {
    @FieldDesc(name = "id", dataType = DataType.Integer, desc = "id")
    private int id;
    @FieldDesc(name = "name", dataType = DataType.String, desc = "名称")
    private String name;
    @FieldDesc(name = "age", dataType = DataType.Integer, desc = "年龄")
    private int age;
    @FieldDesc(name = "telNo", dataType = DataType.String, desc = "手机号码")
    private String telNo;
    public static void main(String[] args) {
        Field[] fieldList = AnnationStudent.class.getDeclaredFields();
        if (ArrayUtils.isNotEmpty(fieldList)) {
            for (Field field : fieldList) {
                Annotation[] annotationList = field.getAnnotations();
                if (ArrayUtils.isNotEmpty(annotationList))
                    for (Annotation annotation : annotationList) {
                        if (annotation instanceof FieldDesc) {
                            FieldDesc desc = (FieldDesc) annotation;
                            System.out.println(desc.name() + " ### " + desc.dataType() + " ### " + desc.desc());
                        }
                    }
            }
        }
    }
}

输出结果为: id ### Integer ### id name ### String ### 名称 age ### Integer ### 年龄 telNo ### String ### 手机号码


这应该是一个完整的注解过程了吧。还有一个小技巧就是当我们给注解的属性赋值时,如果里面有个value属性,我们使用注解时可以不指定名称,自动会指定到value赋值:
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {
   String value() default "";
   String name() default "";
}
@Test("dadawd")
public class TE { 编译通过,如果Test 没有叫value的属性时编译会报错 }

这点在spring中的注解里面很常见。

3、谈谈注解在类似hibernate等框架中的应用


也许不一定是hibernate,但它们定义pojo实体的实现思想是一样的:
@Entity
@Database(name="TestDB")
@Table(name="test_table")
public class TestEntity   {
    @Id
    @Column(name="ID")
    @GeneratedValue(strategy = GenerationType.AUTO)
    @Type(value=Types.BIGINT)
    private Long iD;
    @Column(name="Name")
    @Type(value=Types.String)
    private Long name;
    @Column(name="SourceType")
    @Type(value=Types.INTEGER)
    private Integer sourceType;
    public Long getiD() {
        return iD;
    }
    public void setiD(Long iD) {
        this.iD = iD;
    }
    public Long getName() {
        return name;
    }
    public void setName(Long name) {
        this.name = name;
    }
    public Integer getSourceType() {
        return sourceType;
    }
    public void setSourceType(Integer sourceType) {
        this.sourceType = sourceType;
    }
}

如何使用定义的@Database、@Table呢?
//获取数据库名 public String getDatabaseName() {
        Database db = clazz.getAnnotation(Database.class);
        if (db != null && db.name() != null)
            return db.name();
        throw new RuntimeException("The entity must configure Database annotation.");
    }
//获取表名 public String getTableName() {
        Table table = clazz.getAnnotation(Table.class);
        if (table != null && table.name() != null)
            return table.name();
        Entity entity = clazz.getAnnotation(Entity.class);
        if ( entity != null && (!entity.name().isEmpty()) )
            return entity.name();
        return clazz.getSimpleName();
    }

这就是注解的使用所在。