Java魔法堂:自定义和解析注解

简介:

一、前言                            

  注解(Annotation)作为元数据的载体,为程序代码本身提供额外的信息,使用过MyBatis等ORM框架的朋友对 @Insert 的注解应该不陌生了,这是MyBatis自定义的注解,显然我们也可以按需求自定义一些注解,然后对其进行解析获取元数据,进而实现通过代码生成代码的操作。

 

二、自定义注解                         

 只需通过 关键字@interface 即可自定义注解

复制代码
// 标识注解(就是无属性的注解)
public @interface AnnotationWithoutProperty{
}

// 带value属性的注解
public @interface AnnotationWithVal{
  String value();
}

// 带myVal属性的注解
public @interface AnnotationWithMyVal{
  String[] myValue();
}

// 带value和myVal属性的注解
public @interface AnnotationWith2Val{
  String value();
  String[] myValue();
}

// 带缺省值的myVal属性的注解
public @interface AnnotationWithDefaultVal{
  String myVal() default "hello world!";
}
复制代码

使用方式如下:

复制代码
@AnnotationWithoutProperty
@AnnotationWithVal("hello world") // value属性赋值时,不用显式写出属性名
@AnnotationWithMyVal(myValue={"hello", "world"}) // 其他属性赋值时,必须显示写出属性名
@AnnotationWith2Val(value="hello world", myVal={"hello", "world"})
@AnnotationWithDefaultVal // 属性拥有缺省值时,不必显示设置属性值
@AnnotationWithDefaultVal("new value")
public void test(){}
复制代码

 

三、注解的注解                              

  注解的注解就是为注解本身提供额外的信息,从而约束或增强注解的能力。其中包含有 @Documented 、 @Inherited 、 @Target 、 Retention 4种注解。

   @Target注解 :用于约束被描述的注解的使用范围,当被描述的注解超出使用范围则编译失败。

// 约束@MyAnnotation的作用范围是函数和构造函数
@Target(ElementType.METHOD, ElementType.CONSTRUCTOR)
public @interface MyAnnotation{}

   @Retention注解 :用于约束被描述的注解的作用范围,注解的作用范围有三个,分别为

        1.  RetentionPolicy.SOURCE ,作用范围为源码,就是仅存在于java文件中,当执行 javac 命令时将会去除该注解。

        2.  RetentionPolicy.CLASS ,作用范围为二进制码,就是存在于class文件中,当执行 java 命令时会去除该注解。

        3.  RetentionPolicy.RUNTIME ,作用范围为运行时,就是我们可以通过反射动态获取该注解。

@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation{}

    @Documented注解 :用于指定javadoc生成API文档时显示该注解信息

    @Inherited注解 :用于指定被描述的注解可以被其所描述的类的子类继承。默认情况

复制代码
// 默认注解不会被子类继承
@MyAnnotation
public class Parent{}

// Son并没有继承注解MyAnnotation
public class Son extends Parent{}
复制代码

通过 @Inherited 子类将会继承父类的 @MyAnnoation注解 。

 

四、读取注解                                  

  通过反射我们可以获取类、函数等上的注解信息。

复制代码
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.CLASS)
@Documented
public @interface MyAnnotaion{
  String value() default "hello world";
}

@MyAnnotation
public class Test{
  public static void main(String[] args){
    MyAnnotation ma = Test.class.getAnnotation(MyAnnotation.class);
    System.out.println(ma.value());

    // 获取自身和从父类继承的注解
    Annotation[] annotations = Test.class.getAnnotations();
    // 仅获取自身的注解
    Annotation[] annotations = Test.class.getDeclaredAnnotations();
  }
}    
复制代码

尊重原创,转载请注明来自:http://www.cnblogs.com/fsjohnhuang/p/4040929.html ^_^肥仔John

 

五、参考                                

http://www.cnblogs.com/liubiqu/archive/2008/06/01/1211503.html

如果您觉得本文的内容有趣就扫一下吧!捐赠互勉!


本文转自^_^肥仔John博客园博客,原文链接:http://www.cnblogs.com/fsjohnhuang/p/4040929.html,如需转载请自行联系原作者

相关文章
|
2天前
|
Java 编译器 开发者
Java一分钟之-Java注解的理解与应用
【5月更文挑战第12天】本文介绍了Java注解的基础知识和常见应用,包括定义、应用和解析注解。注解在编译检查、框架集成和代码生成等方面发挥重要作用。文章讨论了两个易错点:混淆保留策略和注解参数类型限制,并提供了避免策略。提醒开发者避免过度使用注解,以保持代码清晰。理解并恰当使用注解能提升代码质量。
12 3
|
2天前
|
Java 程序员 API
Java 8新特性之Lambda表达式与Stream API的深度解析
【5月更文挑战第12天】本文将深入探讨Java 8中的两个重要新特性:Lambda表达式和Stream API。我们将从基本概念入手,逐步深入到实际应用场景,帮助读者更好地理解和掌握这两个新特性,提高Java编程效率。
34 2
|
3天前
|
Java API Python
|
4天前
|
JSON 前端开发 Java
【JAVA进阶篇教学】第七篇:Spring中常用注解
【JAVA进阶篇教学】第七篇:Spring中常用注解
|
4天前
|
XML JavaScript Java
详解Java解析XML的四种方法
详解Java解析XML的四种方法
14 1
|
5天前
|
Java
解析java中的数组
解析java中的数组
12 3
|
5天前
|
存储 Java 程序员
Java面向对象编程的基础概念解析
Java面向对象编程的基础概念解析
13 0
|
8月前
|
Java 数据安全/隐私保护
Java自定义类加载器的编写步骤
Java自定义类加载器的编写步骤
42 0
|
10月前
|
Java 数据库 数据安全/隐私保护
【Java面试】谈谈你对自定义类加载器的理解
【Java面试】谈谈你对自定义类加载器的理解
95 0
|
前端开发 Java

推荐镜像

更多