5分钟搞懂java注解@Annotation的具体使用

Love The Way You Lie 2023-06-25 07:54 34阅读 0赞

首先一句话结论：注解就是一种通过在类、方法、或者属性等上使用类似@xxx的方式进行“打标签”，然后可以通过反射机制对标签的内容进行解析并进行相应处理的手段。

注解是java中的一个重要知识点，从java5后开始引入，尤其在spring框架中大量使用。比较常用的有@controller、@service等等各种，本文将从注解的实现原理出发，通过一些demo代码的实现，进行分析。

**一、 注解定义方式**

直接上代码，看看spring中@Service注解的定义就知道了：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 </td> 
 <td> <code>@Target</code><code>({ElementType.TYPE})</code> <code>@Retention</code><code>(RetentionPolicy.RUNTIME)</code> <code>@Documented</code> <code>@Component</code> <code>public</code> <code>@interface</code> <code>Service { </code> &nbsp; <code>&nbsp;</code><code>String value() </code><code>default</code> <code>""</code><code>;</code> <code>&nbsp;</code>&nbsp; <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

可以看到注解的定义和接口定义很像，但是多了@字符，注解的定义上有以下约定：

*  只能定义属性名，不能定义方法
 *  属性的可见性只有public和default，不写则默认后者
 *  属性的类型只能支持：基本数据类型、string、class、enum、Annotation类型及以上类型的数组
 *  可以加上defult关键字指明默认值，当某字段不指明默认值时，必须在进行注解标注的时候进行此字段值的指定。
 *  当使用value作为属性名称时，可以不显式指定value=“xxx”，如可以直接使用@Service("xxxService")

**二、元注解**

所谓元注解就是java中默认实现的专门对注解进行注解的注解。元注解的总数就5个，下面我们以上面讲到的@Service注解为例子各个击破：

**1.@Target**

此注解用于表示当前注解的使用范围，@Target(\{ElementType.TYPE\})就代表着@Service这个注解是专门用来注解到类、接口、或者枚举类型上面的，当在方法上面加这个注解时，就会报错。可以看到注解位置是一个枚举类型，完整定义如下

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 </td> 
 <td> <code>public</code> <code>enum</code> <code>ElementType { </code> <code>&nbsp;&nbsp;</code><code>/** Class, interface (including annotation type), or enum declaration */</code> <code>&nbsp;&nbsp;</code><code>TYPE,</code> &nbsp; <code>&nbsp;&nbsp;</code><code>/** Field declaration (includes enum constants) */</code> <code>&nbsp;&nbsp;</code><code>FIELD,</code> &nbsp; <code>&nbsp;&nbsp;</code><code>/** Method declaration */</code> <code>&nbsp;&nbsp;</code><code>METHOD,</code> &nbsp; <code>&nbsp;&nbsp;</code><code>/** Formal parameter declaration */</code> <code>&nbsp;&nbsp;</code><code>PARAMETER,</code> &nbsp; <code>&nbsp;&nbsp;</code><code>/** Constructor declaration */</code> <code>&nbsp;&nbsp;</code><code>CONSTRUCTOR,</code> &nbsp; <code>&nbsp;&nbsp;</code><code>/** Local variable declaration */</code> <code>&nbsp;&nbsp;</code><code>LOCAL_VARIABLE,</code> &nbsp; <code>&nbsp;&nbsp;</code><code>/** Annotation type declaration */</code> <code>&nbsp;&nbsp;</code><code>ANNOTATION_TYPE,</code> &nbsp; <code>&nbsp;&nbsp;</code><code>/** Package declaration */</code> <code>&nbsp;&nbsp;</code><code>PACKAGE,</code> &nbsp; <code>&nbsp;&nbsp;</code><code>/**</code> <code>&nbsp;&nbsp;&nbsp;</code><code>* Type parameter declaration</code> <code>&nbsp;&nbsp;&nbsp;</code><code>*</code> <code>&nbsp;&nbsp;&nbsp;</code><code>* @since 1.8</code> <code>&nbsp;&nbsp;&nbsp;</code><code>*/</code> <code>&nbsp;&nbsp;</code><code>TYPE_PARAMETER,</code> &nbsp; <code>&nbsp;&nbsp;</code><code>/**</code> <code>&nbsp;&nbsp;&nbsp;</code><code>* Use of a type</code> <code>&nbsp;&nbsp;&nbsp;</code><code>*</code> <code>&nbsp;&nbsp;&nbsp;</code><code>* @since 1.8</code> <code>&nbsp;&nbsp;&nbsp;</code><code>*/</code> <code>&nbsp;&nbsp;</code><code>TYPE_USE</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

**2.@Retention**

此注解用于表示当前注解的生命周期，说人话就是这个注解作用会保留到什么时候，如@Retention(RetentionPolicy.RUNTIME)就表示在程序运行期间依然有效，此时就可以通过反射拿到注解的信息，完整的枚举定义如下

**3.@Documented**

当被此注解所注解时，使用javadoc工具生成文档就会带有注解信息。

**4.@Inherited**

此注解与继承有关，当A注解添加此注解后，将A注解添加到某类上，此类的子类就会继承A注解。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> <code>@Inherited</code> <code>public</code> <code>@interface</code> <code>A{ </code> <code>}</code> &nbsp; <code>@A</code> <code>public</code> <code>class</code> <code>Parent{}</code> &nbsp; <code>public</code> <code>class</code> <code>Son entends Parant{}</code><code>//Son类继承了父类的A注解</code> </td> 
 </tr> 
 </tbody> 
</table>

**5.@Repeatable**

此注解顾名思义是拥有可以重复注解的能力。想象这样一个场景，我们需要定时执行某个任务，需要在每周一和周三执行，并且这个时间是可以灵活调整的，此时这个元注解就能派上用场：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 </td> 
 <td> <code>@Repeatable</code><code>(Schedules.</code><code>class</code><code>)</code> <code>public</code> <code>@interface</code> <code>Schedule { </code> <code>&nbsp;&nbsp;</code><code>String date();</code> <code>}</code> &nbsp; <code>public</code> <code>@interface</code> <code>Schedules { </code> <code>&nbsp;&nbsp;</code><code>Schedule[] value();</code> <code>}</code> &nbsp; <code>@Schedule</code><code>(date = </code><code>"周一"</code><code>)</code> <code>@Schedule</code><code>(date = </code><code>"周三"</code><code>)</code> <code>public</code> <code>class</code> <code>Executor { </code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

注意看到此元注解后面括号里内容，在这指定的类叫做容器注解，意思是保存这多个注解的容器，故我们创建一个@Schedules注解作为@Schedule的容器注解，容器注解必须含有一个名字为value，返回类型为需放入此容器的注解数组的属性。

**三、自定义实现一个注解**

下面我们以web项目中非常常见的鉴权场景为例自己实现一个自定义注解。

首先我们定义系统的使用人员身份，有超级管理员、管理员、访客三种身份。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 </td> 
 <td> <code>public</code> <code>enum</code> <code>IdentityEnums { </code> &nbsp; <code>&nbsp;&nbsp;</code><code>SUPER_ADMIN,</code> <code>&nbsp;&nbsp;</code><code>ADMIN,</code> <code>&nbsp;&nbsp;</code><code>VISIVOR</code> &nbsp; <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

接下来我们定义一个权限注解：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> <code>@Target</code><code>({ElementType.TYPE,ElementType.METHOD})</code> <code>@Documented</code> <code>@Retention</code><code>(RetentionPolicy.RUNTIME)</code> <code>public</code> <code>@interface</code> <code>Authorization { </code> &nbsp; <code>&nbsp;&nbsp;</code><code>IdentityEnums[] value();</code> <code>&nbsp;&nbsp;</code>&nbsp; <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

然后使用拦截器的方式，对所有页面进行统一的鉴权管理，此处只展示一些关键代码:

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 </td> 
 <td> <code>public</code> <code>class</code> <code>AuthInterceptor </code><code>implements</code> <code>HandlerInterceptor { </code> &nbsp; <code>&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;</code><code>public</code> <code>boolean</code> <code>preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) </code><code>throws</code> <code>Exception { </code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code> <code>(handler </code><code>instanceof</code> <code>HandlerMethod)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>{ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>IdentityEnums user = getIdentityFromRequset(request);</code><code>//这里从request里获取账号信息并判断身份，自己实现</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Authorization auth =((HandlerMethod) handler).getMethodAnnotation(Authorization.</code><code>class</code><code>);</code><code>//获取方法上面的注解</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code> <code>(!Arrays.asList(auth.value()).contains(user)){ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>false</code><code>;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>true</code><code>;</code> <code>&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

最后在spring配置文件中对拦截器进行配置开启拦截器：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 </td> 
 <td> <code>&lt;!-- 拦截器 --&gt;</code> <code>&nbsp;</code><code>&lt;</code><code>mvc:interceptors</code><code>&gt;</code> <code>&nbsp;</code><code>&lt;</code><code>mvc:interceptor</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;!-- 匹配的是url路径， 如果不配置或/**,将拦截所有的Controller --&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;</code><code>mvc:mapping</code> <code>path</code><code>=</code><code>"/**"</code> <code>/&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;!-- 拦截器类 --&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;</code><code>bean</code> <code>&nbsp;&nbsp;</code><code>class</code><code>=</code><code>"com.xx.xx.AuthInterceptor"</code><code>&gt;&lt;/</code><code>bean</code><code>&gt;</code> <code>&nbsp;</code><code>&lt;/</code><code>mvc:interceptor</code><code>&gt;</code> <code>&nbsp;</code><code>&lt;/</code><code>mvc:interceptors</code><code>&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

在实际使用中，我们将在方法上面添加此自定义注解，当身份权限符合时，才能对页面进行访问，使用方式如下：  
@ResponseBody

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 </td> 
 <td> <code>@RequestMapping</code><code>(value = </code><code>"/management"</code><code>)</code> <code>@Authorization</code><code>({IdentityEnums.ADMIN,IdentityEnums.SUPER_ADMIN})</code> <code>public</code> <code>String management(HttpServletRequest request, HttpServletResponse response)</code> <code>{ </code> <code>&nbsp;&nbsp;</code><code>log.info(</code><code>"has permission!"</code><code>);</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>