java自定义注解

介绍

自定义注解可以帮我们把一些常用的工具类定制成注解，在使用的时候，只用在类名、方法名或者想要的地方使用 @XXX 就好了。

开始

图片：
创建一个注解类，注意不是 class，也不是 interface，而是 @interface，创建的时候选择的是Annotation 注解类型。

@Retention(value = RetentionPolicy.RUNTIME)
@Inherited
@Target(ElementType.TYPE)
@Documented
public @interface JDBCConfig {
     String ip();
     int port() default 3306;
     String database();
     String encoding();
     String loginName();
     String password();
}

这里在注解类上面还有几个注解，就是用来定义注解类的注解，我们一个一个来看看：

注解	含义
@Retention（value = RetentionPolicy.RUNTIME）	表示这是一个运行时注解，即运行起来之后，才获取注解中的相关信息，而不像基本注解如@Override 那种不用运行，在编译时eclipse就可以进行相关工作的编译时注解。
@Inherited	表示这个注解可以被子类继承
@Documented	表示当执行javadoc的时候，本注解会生成相关文档
@Target(ElementType.TYPE)	表示这个注解可以用用在类/接口上

测试

注解类已经创建好了，我们在类上加上 @JDBCConfig 注解试试，

@JDBCConfig(ip = "127.0.0.1", database = "test", encoding = "UTF-8", loginName = "root", password = "admin")
public class DBUtil {
    static {
        try {
            Class.forName("com.mysql.jdbc.Driver");
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
    }
}

注解里 value 赋值就相当于给了注解类里属性赋值。
不过目前只是以注解的方式提供这些属性，并没有解析，接下来解析：
首先通过 反射 获得类上的注解对象。
拿到对象之后就可以取到各个属性的值了。

JDBCConfig config = DBUtil.class.getAnnotation(JDBCConfig.class);
 
        String ip = config.ip();
        int port = config.port();
        String database = config.database();
        String encoding = config.encoding();
        String loginName = config.loginName();
        String password = config.password();

元注解

这里重点讲解下 元注解 。
元注解 meta annotation 用于注解 自定义注解 的注解。
元注解有以下几种：

1. @Target
2. @Retention
3. @Inherited
4. @Documented
5. @Repeatable (java1.8 新增)

我们一个一个介绍一下：

@Target

@Target 表示这个注解使用的范围，是只能放在类上？还是既可以放在方法上，又可以放在属性上？
我们点进 @Target 源码中看看：

public @interface Target {
    /**
     * Returns an array of the kinds of elements an annotation type
     * can be applied to.
     * @return an array of the kinds of elements an annotation type
     * can be applied to
     */
    ElementType[] value();
}

可以看出取值是一个数组，表明value可以取一个值，也可以取多个值。当取多值时，需用英文逗号隔开。
继续去 ElementType[] 枚举中看看

 @author  Joshua Bloch
 * @since 1.5
 * @jls 9.6.4.1 @Target
 * @jls 4.1 The Kinds of Types and Values
 */
public enum ElementType {
    /** Class, interface (including annotation type), or enum declaration */
    TYPE,

    /** Field declaration (includes enum constants) */
    FIELD,

    /** Method declaration */
    METHOD,

    /** Formal parameter declaration */
    PARAMETER,

    /** Constructor declaration */
    CONSTRUCTOR,

    /** Local variable declaration */
    LOCAL_VARIABLE,

    /** Annotation type declaration */
    ANNOTATION_TYPE,

    /** Package declaration */
    PACKAGE,

    /**
     * Type parameter declaration
     *
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * Use of a type
     *
     * @since 1.8
     */
    TYPE_USE
}

value	含义
TYPE	表明此注解可以用在类或接口上
FIELD	表明此注解可以用在域上
METHOD	表明此注解可以用在方法上
PARAMETER	表明此注解可以用在参数上
CONSTRUCTOR	表明此注解可以用在构造方法上
LOCAL_VARIABLE	表明此注解可以用在局部变量上
ANNOTATION_TYPE	表明此注解可以用在注解类型上 PACKAGE用于记录java文件的package文件信息，不使用在一般的类中，而用在固定文件package-info.java中。注意命名一定是“package-info”。 由于package- info.java并不是一个合法的类，使用eclipse创建类的方式会提示不合法，所以需要以创建 文件的方式来创建package-info.java。
TYPE_PARAMETER	类型参数声明（JDK1.8新增）
TYPE_USE	类型使用声明 （JDK1.8新增）

@Retention

@Retention 表示生命周期，自定义注解@JDBCConfig 上的值是 RetentionPolicy.RUNTIME, 表示可以在运行的时候依然可以使用。
@Retention可选的值有3个：

值	含义
RetentionPolicy.SOURCE	注解只在源代码中存在，编译成class之后，就没了。@Override 就是这种注解。
RetentionPolicy.CLASS	注解在java文件编程成.class文件后，依然存在，但是运行起来后就没了。@Retention的默认值，即当没有显式指定@Retention的时候，就会是这种类型。
RetentionPolicy.RUNTIME	注解在运行起来之后依然存在，程序可以通过反射获取这些信息

我们之前写的自定义注解@JDBCConfig 就是最后一种。

@Inherited

@Inherited 表示该注解具有继承性。如例，设计一个DBUtil的子类，其getConnection2方法，可以获取到父类DBUtil上的注解信息。

@Documented

@Documented 表时在用javadoc命令生成API文档后，DBUtil的文档里会出现该注解说明。

结尾

关于自定义注解的学习就到这里，希望能帮到大家，谢谢观看。