java实现自定义注解-CSDN博客

无论开发web还是后端，都会经常和spring打交道，而使用最频繁的当然是注解。我们在享受spring注解带来的方便的同时，是否想过能否实现自己的注解呢？我们通过java的原生态类就可以做到这点，我们主要关注java.lang.annotation。

以下是实现的代码，注解已经很详细了。这里我们主要考虑，自定义注解可以干什么？

我们可以利用自定义注解来无缝切换数据库，比如说定义一个@datasource的注解，然后做一个aop，在调用方法时，例如反射机制读取数据源的名称，然后做一个threadlocal来切换数据源，是不是很方便。关于数据源的切换，下一章介绍。

/**
 * 描述: 自定义注解
 * 版本号: 1.0
 * 日期: 2017/2/20 16:47
 * 作者: 屠苏
 *  <ul>@Target：表示该注解可以用于什么地方，可能的ElementType参数：</ul>
 *      <li>CONSTRUCTOR：构造器的声明</li>
 *      <li>LOCAL_VARIABLE：局部变量声明</li>
 *      <li>METHOD：方法声明</li>
 *      <li>PACKAGE：包声明 PARAMETER：参数声明</li>
 *      <li>TYPE：类、接口（包括注解类型）或enum声明</li>
 *
 *  <ul>@Retention：表示需要在什么级别保存该注解信息。可选的RetentionPolicy参数包括：</ul>
 *      <li>SOURCE：注解将被编译器丢弃</li>
 *      <li>CLASS：注解在class文件中可用，但会被JVM丢弃</li>
 *      <li>RUNTIME：JVM将在运行期间保留注解，因此可以通过反射机制读取注解的信息。(常用)</li>
 *
 *  <ul>@Document：将注解包含在Javadoc中</ul>
 *
 *  <ul>@Inherited：允许子类继承父类中的注解</ul>
 *
 *  <ul>注意：</ul>
 *  <li>注解可以设定初始值，使用default就可以实现。</li>
 *  <li>注解只有一个元素的时候，该元素名称必须是value，并且在使用该注解的时候可以省略”value=”。</li>
 *  <li>注解的值必须是确定的，且不能使用null作为值。</li>
 *  <li>注解可能的类型：所有基本类型、String、Class、enum、Annotation、以上类型的数组形式。</li>
 */
@Target({ElementType.METHOD, ElementType.TYPE, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface SelfNote {
    String id();
    String note() default "hello";
}

package com.dlb.annotation;

import java.lang.reflect.Field;
import java.lang.reflect.Method;

/**
 * 描述: 使用自定义注解
 * 版本号: 1.0
 * 日期: 2017/2/20 16:53
 * 作者: 屠苏
 */
@SelfNote(id = "no", note = "note")
public class Note {
    @SelfNote(id = "no1", note = "note1")
    private String name;

    @SelfNote(id = "no2", note = "note2")
    public void setName(String name) {
        this.name = name;
    }

    /**
     * main
     * @param args
     * @throws Exception
     */
    public static void main(String []args) throws Exception{
        String classReference = "com.dlb.annotation.Note";
        Class<?> cls = Class.forName(classReference);

        // 获取类
        boolean b = cls.isAnnotationPresent(SelfNote.class);

        if (b) {
            SelfNote annotation = cls.getAnnotation(SelfNote.class);
            System.out.println(annotation.id() + "," + annotation.note());
        }

        // 获取字段
        Field[] declaredFields = cls.getDeclaredFields();

        for (Field field : declaredFields) {
            boolean isFieldAn = field.isAnnotationPresent(SelfNote.class);

            if (isFieldAn) {
                SelfNote annotation = field.getAnnotation(SelfNote.class);

                System.out.println(annotation.id() + "," + annotation.note());
            }
        }

        // 获取方法
        Method[] methods = cls.getMethods();

        for (Method method : methods) {
            boolean is = method.isAnnotationPresent(SelfNote.class);

            if (is) {
                SelfNote annotation = method.getAnnotation(SelfNote.class);

                System.out.println(annotation.id() + "," + annotation.note());
            }
        }
    }
}