java基础之-自定义注解一

2018-06-23 本文已影响0人司马小小明

（分类信息来自百度搜索）

运行机制分类：
- 源注解代码中注解编译后class中没有
- 编译时注解再class中存在的
- 运行时注解运行时起作用的注解
按来源分
- JDK自带注解
- 三方注解最常见
- 自定义注解
元注解
- 注解的注解

今天来看看Java的自定义注解，看Java自定义注解前先看看jdk中的三个注解：@Override @Deprecated @SuppressWarnings
@Override：表示当前类覆盖了父类的方法。@Deprecated：当前方法过时不再推荐使用 @SuppressWarnings：忽略警告。
回归正题看看自定义注解：
java通过@interface 实现注解.来看看下面的自定义注解。

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

/**
 * @Target是这个注解的作用范围 ElementType.METHOD这个是方法级别的
 * 此外还有：CONSTRUCTOR（构造方法声明）,FIELD（字段声明）,LOCAL VARIABLE（局部变量声明）,
 * METHOD（方法声明）,PACKAGE（包声明）,PARAMETER（参数声明）,TYPE（类接口）
 */
@Target(ElementType.METHOD)
/**
 * @Retention是它的生命周期
 * 取值：SOURCE（只在源码显示，编译时丢弃）,CLASS（编译时记录到class中，运行时忽略）,
 * RUNTIME（运行时存在，可以通过反射读取）
 */
@Retention(RetentionPolicy.RUNTIME)
public @interface ShowMessage {
    /**
     * value是注解的成员变量（当只有一个成员变量时必须用value） 可以使用 default指定默认值。
     * 成员变量的类型限定必须是：基本的数据类型以及String，Class，Annotation,Enumeration
     * @return
     */
    String value() default "";
}

这样就定义完一个注解了。可是定义完了怎么用呢？
下来提供两种解析自定义的注解的方式：1.java 反射解析自定义注解。2.使用Spring AOP 的Aspectj 解析自定义注解。
话不多说直接上代码说明都在代码注释里

java 反射解析自定义注解

package com.annotation.impl;

import com.annotation.annotation.ShowMessage;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class AnnotationUtile {
    private static Logger logger= LoggerFactory.getLogger(AnnotationUtile.class);
    //使用上面自定义的注解
    @ShowMessage("this is test")
    private void test(){
        logger.debug("测试信息");
    }
}

我这里使用JUNIT测试解析定义注解

package com.annotation.impl;

import com.annotation.annotation.ShowMessage;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.lang.reflect.Method;

public class TestMain {
    private static Logger logger= LoggerFactory.getLogger(TestMain.class);

    @Test
    public void  annotation(){
        try {
            //反射获取使用注解的类
            Class c = Class.forName("com.annotation.impl.AnnotationUtile");
            /**
             * 这里我定义的是方法级注解，这里取对应的方法
             */
            Method[] methods=c.getDeclaredMethods();
            for (Method method:methods){
                /**
                 * isAnnotationPresent() 判断是否使用注解
                 * 判断AnnotationUtile是否有ShowMessage注解
                 */
                Boolean ble = method.isAnnotationPresent(com.annotation.annotation.ShowMessage.class);
                if (ble){
                    //获取注解的实例
                    ShowMessage showMessage = method.getAnnotation(ShowMessage.class);
                    //获取注解成员变量并打印
                    logger.debug(showMessage.value());

                }
            }

        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
    }
}

运行结果如下：

Connected to the target VM, address: '127.0.0.1:60534', transport: 'socket'
19:02:21.837 [main] DEBUG com.annotation.impl.TestMain - this is test
Disconnected from the target VM, address: '127.0.0.1:60534', transport: 'socket'

Process finished with exit code 0

一会看世界杯了剩下的稍后再补充。计划注解再写两篇一篇是Spring AOP 的Aspectj 解析自定义注解。另一篇是个综合应用(一个可扩展的校验注解：实现再特定业务下校验功能)

java基础之-自定义注解一

猜你喜欢

热点阅读