关于注解那些事情

最近突然看到其他人写的代码实现了自定义注解，好奇心被激活了。所以查了很多资料，然后写了一个简单的自定义注解，在写的过程中我发现了调用自定义注解的麻烦，所以我希望把我的代码贴出来，然后希望各位大牛们能够帮我简化调用过程。

自定义的注解实现，主要是通过创建注解类，添加元注解，使用反射调用这几步。

其中反射的调用比较活，所以要更具实际情况来进行编写代码。

下面就介绍一下我写的自定义注解吧。

元注解：元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解：
　　　　1.@Target,
　　　　2.@Retention,
　　　　3.@Documented,
　　　　4.@Inherited
　　这些类型和它们所支持的类在java.lang.annotation包中可以找到。下面我们看一下每个元注解的作用和相应分参数的使用说明。

　@Target：

　　　@Target说明了Annotation所修饰的对象范围：Annotation可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。

　　作用：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）

　　取值(ElementType)有：

　　　　1.CONSTRUCTOR:用于描述构造器
　　　　2.FIELD:用于描述域
　　　　3.LOCAL_VARIABLE:用于描述局部变量
　　　　4.METHOD:用于描述方法
　　　　5.PACKAGE:用于描述包
　　　　6.PARAMETER:用于描述参数
　　　　7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

@Retention：

　　@Retention定义了该Annotation被保留的时间长短：某些Annotation仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。

　　作用：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效）

　　取值（RetentionPoicy）有：

　　　　1.SOURCE:在源文件中有效（即源文件保留）
　　　　2.CLASS:在class文件中有效（即class保留）
　　　　3.RUNTIME:在运行时有效（即运行时保留）

@Documented:

　　@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。

　@Inherited：

　　@Inherited 元注解是一个标记注解，@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类。

　　注意：@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation，方法并不从它所重载的方法继承annotation。

　　当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME，则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时，反射代码检查将展开工作：检查class和其父类，直到发现指定的annotation类型被发现，或者到达类继承结构的顶层。

编写代码：

注解类：

@Target({ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface UserName {

    String name() default "";
}

JavaBean：

package com.demo.model;

import Annotation.UserName;
import org.springframework.stereotype.Component;

import javax.persistence.*;
import java.io.Serializable;
import java.util.Date;

/*@Entity
@Table(name = "user")*/
@Component
public class User implements Serializable {

/*    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)*/
    private int userId;
    private int userCode;
    private int userNmber;
    @UserName(name="梨花")
    private String userName;
    private int userPhone;
    private String userIdCard;
    @Temporal(TemporalType.TIMESTAMP)
    private Date regDate;
    private String regCannal;
    private String regPic1;
    private String regPic2;



    public int getUserId() {
        return userId;
    }

    public void setUserId(int userId) {
        this.userId = userId;
    }

    public int getUserCode() {
        return userCode;
    }

    public void setUserCode(int userCode) {
        this.userCode = userCode;
    }

    public int getUserNmber() {
        return userNmber;
    }

    public void setUserNmber(int userNmber) {
        this.userNmber = userNmber;
    }


    public String getUserName() {
        return userName;
    }

    @UserName(name="梨花")
    public void setUserName(String userName) {
        this.userName = userName;
    }

    public int getUserPhone() {
        return userPhone;
    }

    public void setUserPhone(int userPhone) {
        this.userPhone = userPhone;
    }

    public String getUserIdCard() {
        return userIdCard;
    }

    public void setUserIdCard(String userIdCard) {
        this.userIdCard = userIdCard;
    }

    public Date getRegDate() {
        return regDate;
    }

    public void setRegDate(Date regDate) {
        this.regDate = regDate;
    }

    public String getRegCannal() {
        return regCannal;
    }

    public void setRegCannal(String regCannal) {
        this.regCannal = regCannal;
    }

    public String getRegPic1() {
        return regPic1;
    }

    public void setRegPic1(String regPic1) {
        this.regPic1 = regPic1;
    }

    public String getRegPic2() {
        return regPic2;
    }

    public void setRegPic2(String regPic2) {
        this.regPic2 = regPic2;
    }

    @Override
    public String toString() {
        return "User{" +
                "userId=" + userId +
                ", userCode=" + userCode +
                ", userNmber=" + userNmber +
                ", userName='" + userName + '\'' +
                ", userPhone=" + userPhone +
                ", userIdCard='" + userIdCard + '\'' +
                ", regDate=" + regDate +
                ", regCannal='" + regCannal + '\'' +
                ", regPic1='" + regPic1 + '\'' +
                ", regPic2='" + regPic2 + '\'' +
                '}';
    }
}

注解解析类：

public class ParseAnnotion<T> {

    /**
     * 解析注解UserName
     *
     * @param annoClass*/

    public T parseUserName(Class<T> annoClass){
      Class<T> cls= annoClass;
        try {
            Object o=cls.newInstance();
            if(cls!=null){
               Field[] fields=cls.getDeclaredFields();
               //写
               for(Field field:fields){
                   UserName userName=field.getAnnotation(UserName.class);
                   if(userName!=null){
                       PropertyDescriptor descriptor=new PropertyDescriptor(field.getName(),cls);
                       Method method=descriptor.getWriteMethod();
                       method.invoke(o,userName.name());
                   }
               }

               return (T) o;
            }
        } catch (InstantiationException e) {
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        } catch (IntrospectionException e) {
            e.printStackTrace();
        } catch (InvocationTargetException e) {
            e.printStackTrace();
        }
          return null;

    }
}

main方法：

ParseAnnotion<User> userParseAnnotion=new ParseAnnotion<User>();
User user=userParseAnnotion.parseUserName(User.class);
System.out.println(user.getUserName());

这个注解的功能简单的实现了获取属性的注解上的值的功能。

来源：oschina

链接：https://my.oschina.net/u/2695029/blog/1607393

标签

Java注解