Java自定义注解开发

一、背景

　　最近在自己搞一个项目时，遇到可需要开发自定义注解的需求，对于没有怎么关注这些java新特性的来说，比较尴尬，索性就拿出一些时间，来进行研究下自定义注解开发的步骤以及使用方式。今天在这里记下，方便以后学习复习以及分享给有需要的小伙伴们~

二、注解基本概念

　　什么是注解？

　　　　注解就是某种注解类型的一个实例，我们可以用它在某个类上进行标注，这样编译器在编译我们的文件时，会根据我们自己设定的方法来编译类。

　　注解的分类有哪些？

　　

由上图可知：注解共分为：标记注解、标准元注解、一般注解三类。

注：Deprecated注解，除了多个删除线，并没有什么拦截功能。

　　标准元注解详解

　　　　标准元注解是自定义注解的注解，主要包含4个，都位于java.lang.annotation包中，我们创建自定义注解时会用到4个标准元注解。它们的名称以及含义如下：

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

　　　　　　2. @Inherited：是一个标记注解阐述了某个被标注的类型是被继承的。使用了@Inherited修饰的注解类型被用于一个class时该class的子类也有了该注解。

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

　　　　　　生命周期策略枚举

　　　　　　RetentionPolicy.RUNTIME 注解会在class字节码文件中存在，在运行时可以通过反射获取到。

　　　　　　RetentionPolicy.CLASS 默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得。

　　　　　　RetentionPolicy.SOURCE 注解仅存在于源码中，在class字节码文件中不包含。

　　　　　　4. @Target：说明了注解所修饰的对象范围：注解可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。

　　　　　　　修饰范围枚举

　　　　　　　　ElementType.CONSTRUCTOR  作用于构造器
　　　　　　　　ElementType.FIELD  作用于域/属性
　　　　　　　　ElementType.LOCAL_VARIABLE  用于描述局部变量
　　　　　　　　ElementType.METHOD  作用于方法
　　　　　　　　ElementType.PACKAGE   用于描述包
　　　　　　　　ElementType.PARAMETER   用于描述参数
　　　　　　　　ElementType.TYPE   用于描述类、接口(包括注解类型) 或enum声明，最常用

三、开发自定义注解demo

1.开发自定义类注解

复制 1 package com.hafiz.zhang.annotation;

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

/**
 * @author hafiz.Zhang
 * @Date 2016年5月18日 下午1:58:11
 * @Description 自定义类注解
 */
@Documented    //定义可以被文档工具文档化
@Retention(RetentionPolicy.RUNTIME)//声明周期为runtime，运行时可以通过反射拿到
@Target(ElementType.TYPE)//注解修饰范围为类、接口、枚举
public @interface ClassAnnotation {
    public String name() default "defaultService";
    public String version() default "1.1.0";
}

2.自定义方法注解

复制 1 package com.hafiz.zhang.annotation;

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

import com.hafiz.zhang.annotation.en.MethodTypeEnum;

/**
 * @author hafiz.Zhang
 * @Date 2016年5月18日 下午1:58:26
 * @Description 自定义方法注解
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MethodAnnotation {
    public String name() default "defaultName"; 
    public MethodTypeEnum type() default MethodTypeEnum.TYPE1;
}

3.自定义域注解

复制 1 package com.hafiz.zhang.annotation;

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

/**
 * @author hafiz.Zhang
 * @Date 2016年5月18日 下午1:58:37
 * @Description 自定义域注解
 */
@Documented
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface FieldAnnotation {
    public String name() default "defaultName";
    public String value() default "defaultValue";
    
}

4.方法类型枚举类

复制 1 package com.hafiz.zhang.annotation.en;

/**
 * @author hafiz.Zhang
 * @Date 2016年5月18日 下午1:59:02
 * @Description 方法类型枚举类
 */
public enum MethodTypeEnum {
    TYPE1,TYPE2
}

5.测试注解Bean

复制 1 package com.hafiz.zhang.annotation.bean;

import com.hafiz.zhang.annotation.ClassAnnotation;
import com.hafiz.zhang.annotation.FieldAnnotation;
import com.hafiz.zhang.annotation.MethodAnnotation;
import com.hafiz.zhang.annotation.en.MethodTypeEnum;

/**
 * @author hafiz.Zhang
 * @Date 2016年5月18日 上午11:59:37
 * @Description 测试使用的bean
 */
@ClassAnnotation(name="personBean", version="1.2.1")
public class Person {
    @FieldAnnotation(name="description", value="This is my personal annotation")
    private String description;

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }
    @MethodAnnotation(name="sayHello", type = MethodTypeEnum.TYPE2)
    public void sayHello() {
        System.out.println("Hello Annotation!");
    }
}

6.自定义类注解测试类

复制 1 package com.hafiz.zhang.annotation.test;

import com.hafiz.zhang.annotation.ClassAnnotation;
import com.hafiz.zhang.annotation.bean.Person;

/**
 * @author hafiz.Zhang
 * @Date 2016年5月18日 上午11:56:34
 * @Description 测试类注解
 */
public class TestClassAnnotation {
    
    private static Person person = new Person();
    
    public static void main(String[] args) {
        Class<?> clazz = person.getClass();
        //因为注解是作用于类上面的，所以可以通过isAnnotationPresent来判断是否是一个具有指定注解的类
        if(clazz.isAnnotationPresent(ClassAnnotation.class)) {
            System.out.println("This is a class with annotation ClassAnnotation!");
            //通过getAnnotation可以获取注解对象
            ClassAnnotation annotation = clazz.getAnnotation(ClassAnnotation.class);
            if(null != annotation) {
                System.out.println("BeanName = " + annotation.name());
                System.out.println("BeanVersion = " + annotation.version());
            }else{
                System.out.println("the annotation that we get is null");
            }
        }else{
            System.out.println("This is not the class that with ClassAnnotation");
        }
    }
}

运行结果：

7.自定义方法注解测试类

复制 1 package com.hafiz.zhang.annotation.test;

import java.lang.reflect.Method;

import com.hafiz.zhang.annotation.MethodAnnotation;
import com.hafiz.zhang.annotation.bean.Person;

/**
 * @author hafiz.Zhang
 * @Date 2016年5月18日 下午12:11:11
 * @Description 测试方法注解
 */
public class TestMethodAnnotation {
    
    private static Person person = new Person();
    
    public static void main(String[] args) throws Exception {
        Class<?> clazz = person.getClass();
        //因为是注解到method上的，所以首先要获取这个方法
        Method method = clazz.getDeclaredMethod("sayHello");
        if(method.isAnnotationPresent(MethodAnnotation.class)) {
            System.out.println("===This is a method with a annotation:MethodAnnotation===");
            //通过getAnnotation可以获取注解对象
            MethodAnnotation annotation = method.getAnnotation(MethodAnnotation.class);
            if(null != annotation) {
                System.out.println("MethodName = " + annotation.name());
                System.out.println("MethodType = " + annotation.type());
            }else{
                System.out.println("the annotation that we get is null");
            }
        }else{
            System.out.println("This is not the class that with MethodAnnotation");
        }
    }
}

运行结果：

8.自定义域注解测试类

复制 1 package com.hafiz.zhang.annotation.test;

import java.lang.reflect.Field;

import com.hafiz.zhang.annotation.FieldAnnotation;
import com.hafiz.zhang.annotation.bean.Person;

/**
 * @author hafiz.Zhang
 * @Date 2016年5月18日 下午12:17:49
 * @Description 测试域注解
 */
public class TestFieldAnnotation {
    
    private static Person person = new Person();
    
    public static void main(String[] args) throws Exception {
        Class<?> clazz = person.getClass();
        //因为是注解到Field上的，所以首先要获取这个字段
        Field field = clazz.getDeclaredField("description");
        //判断这个Field上是否有这个注解
        if(field.isAnnotationPresent(FieldAnnotation.class)) {
            System.out.println("===This is a field with annotation:FieldAnnotation!===");
            //如果有这个注解，则获取注解类
            FieldAnnotation annotation = field.getAnnotation(FieldAnnotation.class);
            if(null != annotation){
                System.out.println("before set the value is:" + person.getDescription());
                //通过反射给私有变量赋值
                field.setAccessible(true);
                field.set(person, annotation.value());
                System.out.println("after set the value is:" + person.getDescription());
            }else{
                System.out.println("the annotation that we get is null");
            }
        }else{
            System.out.println("This is not the class that with FieldAnnotation");
        }
    }
}

运行结果：

附：demo项目结构图

以上就是本人对自定义注解开发的理解以及开发测试了，如有错误希望大家能够批评指正！