Java实现自定义注解

末蓝、 2022-12-05 15:26 168阅读 0赞

# **前言** #

上一篇文章介绍了注解的一些基本知识，这次来介绍下如何实现自定义注解及注解如何使用。

# **正文** #

注解是一种能被添加到java源代码中的元数据，方法、类、参数和包都可以用注解来修饰。注解可以看作是一种特殊的标记，可以用在方法、类、参数和包上，程序在编译或者运行时可以检测到这些标记而进行一些特殊的处理。

##  ##

声明一个注解要用到的东西

*  修饰符  
      访问修饰符必须为public,不写默认为pubic；
 *  关键字  
      关键字为@interface；
 *  注解名称  
      注解名称为自定义注解的名称，使用时还会用到；
 *  注解类型元素  
      注解类型元素是注解中内容，可以理解成自定义接口的实现部分；

<code>public @interface Info {
 String value() default "tracy";
 boolean isDelete();
 }
 </code>

使用元注解

JDK中有一些元注解，主要有@Target，@Retention,@Document,@Inherited用来修饰注解。  
**@Target**  
  表明该注解可以应用的java元素类型

<table> 
 <thead> 
 <tr> 
 <th style="vertical-align:middle;">Target类型</th> 
 <th style="vertical-align:middle;">描述</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td style="border-color:#dddddd;vertical-align:middle;">ElementType.TYPE</td> 
 <td style="border-color:#dddddd;vertical-align:middle;">应用于类、接口（包括注解类型）、枚举</td> 
 </tr> 
 <tr> 
 <td style="border-color:#dddddd;vertical-align:middle;">ElementType.FIELD</td> 
 <td style="border-color:#dddddd;vertical-align:middle;">应用于属性（包括枚举中的常量）</td> 
 </tr> 
 <tr> 
 <td style="border-color:#dddddd;vertical-align:middle;">ElementType.METHOD</td> 
 <td style="border-color:#dddddd;vertical-align:middle;">应用于方法</td> 
 </tr> 
 <tr> 
 <td style="border-color:#dddddd;vertical-align:middle;">ElementType.PARAMETER</td> 
 <td style="border-color:#dddddd;vertical-align:middle;">应用于方法的形参</td> 
 </tr> 
 <tr> 
 <td style="border-color:#dddddd;vertical-align:middle;">ElementType.CONSTRUCTOR</td> 
 <td style="border-color:#dddddd;vertical-align:middle;">应用于构造函数</td> 
 </tr> 
 <tr> 
 <td style="border-color:#dddddd;vertical-align:middle;">ElementType.LOCAL_VARIABLE</td> 
 <td style="border-color:#dddddd;vertical-align:middle;">应用于局部变量</td> 
 </tr> 
 <tr> 
 <td style="border-color:#dddddd;vertical-align:middle;">ElementType.ANNOTATION_TYPE</td> 
 <td style="border-color:#dddddd;vertical-align:middle;">应用于注解类型</td> 
 </tr> 
 <tr> 
 <td style="border-color:#dddddd;vertical-align:middle;">ElementType.PACKAGE</td> 
 <td style="border-color:#dddddd;vertical-align:middle;">应用于包</td> 
 </tr> 
 <tr> 
 <td style="border-color:#dddddd;vertical-align:middle;">ElementType.TYPE_PARAMETER</td> 
 <td style="border-color:#dddddd;vertical-align:middle;">1.8版本新增，应用于类型变量）</td> 
 </tr> 
 <tr> 
 <td style="border-color:#dddddd;vertical-align:middle;">ElementType.TYPE_USE</td> 
 <td style="border-color:#dddddd;vertical-align:middle;">1.8版本新增，应用于任何使用类型的语句中（例如声明语句、泛型和强制转换语句中的类型）</td> 
 </tr> 
 </tbody> 
</table>

**@Retention**  
  表明该注解的生命周期

<table> 
 <thead> 
 <tr> 
 <th style="vertical-align:middle;">生命周期类型</th> 
 <th style="vertical-align:middle;">描述</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td style="border-color:#dddddd;vertical-align:middle;">RetentionPolicy.SOURCE</td> 
 <td style="border-color:#dddddd;vertical-align:middle;">编译时被丢弃，不包含在类文件中</td> 
 </tr> 
 <tr> 
 <td style="border-color:#dddddd;vertical-align:middle;">RetentionPolicy.CLASS</td> 
 <td style="border-color:#dddddd;vertical-align:middle;">JVM加载时被丢弃，包含在类文件中，默认值</td> 
 </tr> 
 <tr> 
 <td style="border-color:#dddddd;vertical-align:middle;">RetentionPolicy.RUNTIME</td> 
 <td style="border-color:#dddddd;vertical-align:middle;">由JVM 加载，包含在类文件中，在运行时可以被获取到</td> 
 </tr> 
 </tbody> 
</table>

**@Document**  
  表明该注解标记的元素可以被Javadoc 或类似的工具文档化  
**@Inherited**  
  表明使用了@Inherited注解的注解，所标记的类的子类也会拥有这个注解

<code>@Target({ElementType.FIELD, ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
 public @interface Info {
 String value() default "tracy";
 boolean isDelete();
 }
 </code>

**配置注解**

定义了一个Person类

<code>@Data
 @Builder
 // 为Person类配置了刚刚定义的注解@Info
 @Info(isDelete = true)
 public class Person {
 
 /**
 * 姓名
 */
 private String name;
 
 /**
 * 年龄
 */
 private int age;
 
 /**
 * 是否有效
 */
 private boolean isDelete;
 }
 </code>

### **利用反射解析注解** ###

<code>
 public class AnnotationTest {
 public static void main(String[] args) {
 try {
 //获取Person的Class对象
 Person person = Person.builder().build();
 Class clazz = person.getClass();
 //判断person对象上是否有Info注解
 if (clazz.isAnnotationPresent(Info.class)) {
 System.out.println("Person类上配置了Info注解！");
 //获取该对象上Info类型的注解
 Info infoAnno = (Info) clazz.getAnnotation(Info.class);
 System.out.println("person.name :" + infoAnno.value() + ",person.isDelete:" + infoAnno.isDelete());
 } else {
 System.out.println("Person类上没有配置Info注解！");
 }
 } catch (Exception e) {
 e.printStackTrace();
 }
 }
 }
 
 </code>

*      运行结果：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p0MTU3MzI2MjU4Nzg_size_16_color_FFFFFF_t_70]  
        对于一个类或者接口来说，Class类(java.lang包下)中提供了一些方法用于反射注解，当然对于字段、方法来说反射注解的方式很类似。

<code>//返回指定的注解
 getAnnotation
 //判断当前元素是否被指定注解修饰
 isAnnotationPresent
 //返回所有的注解
 getAnnotations
 </code>

[https://blog.csdn.net/xsp\_happyboy/article/details/80987484][https_blog.csdn.net_xsp_happyboy_article_details_80987484]  
[https://blog.csdn.net/Dufresne311/article/details/83116020][https_blog.csdn.net_Dufresne311_article_details_83116020]  
[https://segmentfault.com/a/1190000018209300][https_segmentfault.com_a_1190000018209300]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p0MTU3MzI2MjU4Nzg_size_16_color_FFFFFF_t_70]: /images/20221123/8ff6ffc952424baa8d67ea28c879af20.png
[https_blog.csdn.net_xsp_happyboy_article_details_80987484]: https://blog.csdn.net/xsp_happyboy/article/details/80987484
[https_blog.csdn.net_Dufresne311_article_details_83116020]: https://blog.csdn.net/Dufresne311/article/details/83116020
[https_segmentfault.com_a_1190000018209300]: https://segmentfault.com/a/1190000018209300