自定义Java注解

一、常见Java注解

常见的java注解一般作用于类、属性或方法上。
作用于类的注解示例

package mytest.annotation;

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

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ActionPrefix {
    String value() default "";
}

作用于属性的注解示例

package mytest.annotation;

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

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ActionFiled {
    int value() default 3;
}

作用于方法上的注解示例

package mytest.annotation;

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

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ActionPath {
    String value();
}

@Target用来定义你的注解将应用于什么地方。
@Retention用来定义该注解在哪一个级别可用，在源代码中(SOURCE)、类文件中(CLASS)或者运行时(RUNTIME)。

二、注解解析

单有注解是没有用的，还需要对应的注解解析。示例是通过反射拿到对应Class。如果是spring项目的话，可以通过ApplicationContext获取bean，进而得到Class

package mytest.annotation;

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

public class ActionParse {

    public void printActionValue(String classPath) throws ClassNotFoundException {
        Class<?> cl = Class.forName(classPath);
        ActionPrefix actionPrefix = cl.getAnnotation(ActionPrefix.class);
        if (actionPrefix == null) {
            return;
        }
        System.out.println("action prefix is: " + actionPrefix.value());

        Field[] fields = cl.getDeclaredFields();
        for (Field field : fields) {
            ActionFiled actionFiled = field.getAnnotation(ActionFiled.class);
            if (actionFiled == null) {
                continue;
            }
            System.out.println("action field is: " + actionFiled.value());
        }
        Method[] methods = cl.getMethods();

        for (Method method : methods) {
            ActionPath actionPath = method.getAnnotation(ActionPath.class);
            if (actionPath == null) {
                continue;
            }
            System.out.println("action path is :" + actionPath.value());
        }
    }

    public static void main(String[] args) {
        try {
            new ActionParse().printActionValue("mytest.annotation.WebSocketAction");
        } catch (Exception ex) {

        }
    }
}