Java注解库_java自定义注解实现

一. 什么是注解(Annotation)

Java注解是什么，以下是引用自维基百科的内容

Java注解又称Java标注，是JDK5.0版本开始支持加入源代码的特殊语法元数据。

Java语言中的类、方法、变量、参数和包等都可以被标注。和Javadoc不同，Java标注可以通过反射获取标注内容。在编译器生成类文件时，标注可以被嵌入到字节码中。Java虚拟机可以保留标注内容，在运行时可以获取到标注内容。 当然它也支持自定义Java标注。

二. 注解体系图

元注解：java.lang.annotation中提供了元注解，可以使用这些注解来定义自己的注解。主要使用的是Target和Retention注解

注解处理类：既然上面定义了注解，那得有办法拿到我们定义的注解啊。java.lang.reflect.AnnotationElement接口则提供了该功能。注解的处理是通过java反射来处理的。如下，反射相关的类Class, Method, Field都实现了AnnotationElement接口。

反射处理:

AnnotationElement接口方法:

因此，只要我们通过反射拿到Class, Method, Field类，就能够通过getAnnotation(Class)拿到我们想要的注解并取值。

三. 常用元注解

Target：描述了注解修饰的对象范围，取值在java.lang.annotation.ElementType定义，常用的包括：

METHOD：用于描述方法

PACKAGE：用于描述包

PARAMETER：用于描述方法变量

TYPE：用于描述类、接口或enum类型

Retention: 表示注解保留时间长短。取值在java.lang.annotation.RetentionPolicy中，取值为：

SOURCE：在源文件中有效，编译过程中会被忽略

CLASS：随源文件一起编译在class文件中，运行时忽略

RUNTIME：在运行时有效

只有定义为RetentionPolicy.RUNTIME时，我们才能通过注解反射获取到注解。

所以，假设我们要自定义一个注解，它用在字段上，并且可以通过反射获取到，功能是用来描述字段的长度和作用。

四. 示例-反射获取注解

先定义一个注解：

通过反射获取注解

应用场景一：自定义注解+拦截器 实现登录校验

接下来，我们使用springboot拦截器实现这样一个功能，如果方法上加了@LoginRequired，则提示用户该接口需要登录才能访问，否则不需要登录。

首先定义一个LoginRequired注解

然后写两个简单的接口，访问sourceA，sourceB资源

实现spring的HandlerInterceptor 类先实现拦截器，但不拦截，只是简单打印日志，如下：

实现spring类WebMvcConfigurer，创建配置类把拦截器添加到拦截器链中

在sourceB方法上添加我们的登录注解

简单实现登录拦截逻辑

运行成功，访问sourceB时需要登录了，访问sourceA则不用登录.

应用场景二：自定义注解+AOP 实现日志打印

先导入切面需要的依赖包

定义一个注解@MyLog

定义一个切面类，见如下代码注释理解：

在步骤二中的IndexController写一个sourceC进行测试，加上我们的自定义注解：