java注解Annotation常用知识及案例

概述

Java注解，在JDK5中推出的一种特性，通常添加到类、方法、变量中。Java虚拟机可以保留标注内容，在运行时获取到标注内容。在Spring AOP中，底层源码便大量使用了注解，通过定义的注解，当使用者在类上定义了诸如@Service的注解后，Spring在启动时扫描相应的包路径下的类上是否有注解，有注解则会判断是否时Service注解，如果是，则通过反射机制，创建相应的对象，交给Spring去管理。其底层使用的就是注解。

什么是注解

Java注解又称位Java标注，在JDK5中推出的一种特性，通常添加到类、方法、变量中。

在下图中我们可以看到，注解定义在 了java.lang.reflect.annotation包中。常用的注解便是@Documented、@Retention、@Target注解。在自定义注解中基本上都用得上。

常用注解

Target: 描述了注解修饰的对象范围，常用的包括:
METHOD:用于描述方法
PACKAGE:描述包
PARAMETER:描述方法变量
TYPE:描述类、接口或enum类型

Retention：表示注解保留时间长短。常用的包括:
SOURCE：源文件中有效，编译过程中忽略
CLASS：编译过程有效，运行时忽略
RUNTIME：运行时有效

Documented：表示这个注解被javadoc工具记录

案例

下面我们通过自定义一个注解，并且获取注解上的值，来简单演示注解的使用。

自定义注解

目录结构:

Info注解:

创建一个注解，可以使用工具上有的注解创建功能，或者将class关键字改为@interface关键字，即可创建一个注解。

//ElementType.FIELD作用于字段上
//ElementType.TYPE作用于类上
@Target({ElementType.FIELD, ElementType.TYPE})
//RetentionPolicy.RUNTIME表示运行时有效
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Info {

    String value() default "tracy";
    boolean isDelete();

}

Person类:

创建一个类，并加上常用的属性，

//加上注解
@Info(isDelete = true)
public class Person {

    private String name;
    private int age;
    private boolean isDelete;

    public String getName() {
        return name;
    }

    public int getAge() {
        return age;
    }

    public boolean isDelete() {
        return isDelete;
    }

    public void setName(String name) {
        this.name = name;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public void setDelete(boolean delete) {
        isDelete = delete;
    }
}

测试类及结果:

这里需要注意的一点时，Class对象的获取方法，通常来说Class对象有三种获取方法，不过在Spring的底层设计中，使用的是通过类路径获取Class对象的方法。即， Class clazz =Class.forName(“com.annotation.Person”);

 public static void main(String[] args) throws ClassNotFoundException {

        Class clazz = Class.forName("com.annotation.Person");

        System.out.println(clazz);
		
		//isAnnotationPresent用于判断是否存在某个注解
        if (clazz.isAnnotationPresent(Info.class)){

            System.out.println("Person类上配置了Info注解！");
            Info infoAnno = (Info) clazz.getAnnotation(Info.class);
            System.out.println("person.name :" + infoAnno.value() + ",person.isDelete:" + infoAnno.isDelete());

        }

    }

可以看到 tracy是默认值，isDelete是设置值也输出了

进阶案例

案例以定义一个注解，然后，如果类上有这个注解，则有一些输出进行。

注解类:

//定义注解作用于方法上
@Target(ElementType.METHOD)
//RetentionPolicy.RUNTIME，定义注解在运行时有效，一般使用这个
@Retention(RetentionPolicy.RUNTIME)
public @interface MyLog {
}

定义注解处理类。

@Aspect
@Component
public class LogAspect {

//PointCut表示这是一个切点，@annotation表示切点是一个注解    @Pointcut("@annotation(com.annotation.annotationCase.MyLog)")
    public void logPointCut(){};

    //通知，为切点方法名称
    @Around("logPointCut()")
    public void logAround(ProceedingJoinPoint joinPoint){

        // 获取方法名称
        String methodName = joinPoint.getSignature().getName();
        // 获取入参
        Object[] param = joinPoint.getArgs();

        StringBuilder sb = new StringBuilder();
        for(Object o : param){
            sb.append(o + "; ");
        }
        System.out.println("进入[" + methodName + "]方法,参数为:" + sb.toString());

        // 继续执行方法
        try {
            joinPoint.proceed();
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }
        System.out.println(methodName + "方法执行结束");

    }


}

测试类:

@RestController
@RequestMapping("testAnnotation")
public class testAnnotationController {

    @MyLog
    @GetMapping("/sourceC/{source_name}")
    public String sourceC(@PathVariable("source_name") String sourceName){
        return "你正在访问sourceC资源";
    }

}

测试结果: