`

深入理解Java:注解(Annotation)自定义注解入门

 
阅读更多

如果没有用来读取注解的方法和工作,那么注解也就不会比注释更有用处了。使用注解的过程中,很重要的一部分就是创建于使用注解处理器。Java SE5扩展了反射机制的API,以帮助程序员快速的构造自定义注解处理器。


注解处理器类库(java.lang.reflect.AnnotatedElement):

  Java使用Annotation接口来代表程序元素前面的注解,该接口是所有Annotation类型的父接口。除此之外,Java在java.lang.reflect 包下新增了AnnotatedElement接口,该接口代表程序中可以接受注解的程序元素,该接口主要有如下几个实现类:

  Class:类定义
  Constructor:构造器定义
  Field:累的成员变量定义
  Method:类的方法定义
  Package:类的包定义

  java.lang.reflect 包下主要包含一些实现反射功能的工具类,实际上,java.lang.reflect 包所有提供的反射API扩充了读取运行时Annotation信息的能力。当一个Annotation类型被定义为运行时的Annotation后,该注解才能是运行时可见,当class文件被装载时被保存在class文件中的Annotation才会被虚拟机读取。
  AnnotatedElement 接口是所有程序元素(Class、Method和Constructor)的父接口,所以程序通过反射获取了某个类的AnnotatedElement对象之后,程序就可以调用该对象的如下四个个方法来访问Annotation信息:

  方法1:<T extends Annotation> T getAnnotation(Class<T> annotationClass): 返回改程序元素上存在的、指定类型的注解,如果该类型注解不存在,则返回null。
  方法2:Annotation[] getAnnotations():返回该程序元素上存在的所有注解。
  方法3:boolean is AnnotationPresent(Class<?extends Annotation> annotationClass):判断该程序元素上是否包含指定类型的注解,存在则返回true,否则返回false.
  方法4:Annotation[] getDeclaredAnnotations():返回直接存在于此元素上的所有注释。与此接口中的其他方法不同,该方法将忽略继承的注释。(如果没有注释直接存在于此元素上,则返回长度为零的一个数组。)该方法的调用者可以随意修改返回的数组;这不会对其他调用者返回的数组产生任何影响。

  一个简单的注解处理器:  

复制代码
/***********注解声明***************/

/**
 * 水果名称注解
 * @author peida
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitName {
    String value() default "";
}

/**
 * 水果颜色注解
 * @author peida
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitColor {
    /**
     * 颜色枚举
     * @author peida
     *
     */
    public enum Color{ BULE,RED,GREEN};
    
    /**
     * 颜色属性
     * @return
     */
    Color fruitColor() default Color.GREEN;

}

/**
 * 水果供应者注解
 * @author peida
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitProvider {
    /**
     * 供应商编号
     * @return
     */
    public int id() default -1;
    
    /**
     * 供应商名称
     * @return
     */
    public String name() default "";
    
    /**
     * 供应商地址
     * @return
     */
    public String address() default "";
}

/***********注解使用***************/

public class Apple {
    
    @FruitName("Apple")
    private String appleName;
    
    @FruitColor(fruitColor=Color.RED)
    private String appleColor;
    
    @FruitProvider(id=1,name="陕西红富士集团",address="陕西省西安市延安路89号红富士大厦")
    private String appleProvider;
    
    public void setAppleColor(String appleColor) {
        this.appleColor = appleColor;
    }
    public String getAppleColor() {
        return appleColor;
    }
    
    public void setAppleName(String appleName) {
        this.appleName = appleName;
    }
    public String getAppleName() {
        return appleName;
    }
    
    public void setAppleProvider(String appleProvider) {
        this.appleProvider = appleProvider;
    }
    public String getAppleProvider() {
        return appleProvider;
    }
    
    public void displayName(){
        System.out.println("水果的名字是:苹果");
    }
}

/***********注解处理器***************/

public class FruitInfoUtil {
    public static void getFruitInfo(Class<?> clazz){
        
        String strFruitName=" 水果名称:";
        String strFruitColor=" 水果颜色:";
        String strFruitProvicer="供应商信息:";
        
        Field[] fields = clazz.getDeclaredFields();
        
        for(Field field :fields){
            if(field.isAnnotationPresent(FruitName.class)){
                FruitName fruitName = (FruitName) field.getAnnotation(FruitName.class);
                strFruitName=strFruitName+fruitName.value();
                System.out.println(strFruitName);
            }
            else if(field.isAnnotationPresent(FruitColor.class)){
                FruitColor fruitColor= (FruitColor) field.getAnnotation(FruitColor.class);
                strFruitColor=strFruitColor+fruitColor.fruitColor().toString();
                System.out.println(strFruitColor);
            }
            else if(field.isAnnotationPresent(FruitProvider.class)){
                FruitProvider fruitProvider= (FruitProvider) field.getAnnotation(FruitProvider.class);
                strFruitProvicer=" 供应商编号:"+fruitProvider.id()+" 供应商名称:"+fruitProvider.name()+" 供应商地址:"+fruitProvider.address();
                System.out.println(strFruitProvicer);
            }
        }
    }
}

/***********输出结果***************/
public class FruitRun {

    /**
     * @param args
     */
    public static void main(String[] args) {
        
        FruitInfoUtil.getFruitInfo(Apple.class);
        
    }

}

====================================
 水果名称:Apple
 水果颜色:RED
 供应商编号:1 供应商名称:陕西红富士集团 供应商地址:陕西省西安市延安路89号红富士大厦
复制代码

   Java注解的基础知识点(见下面导图)基本都过了一遍,下一篇我们通过设计一个基于注解的简单的ORM框架,来综合应用和进一步加深对注解的各个知识点的理解和运用。

分享到:
评论

相关推荐

    基于Java注解(Annotation)的自定义注解入门介绍

    自定义注解是Java注解机制的一个重要方面,允许开发者根据需求创建自己的注解类型。 首先,我们来了解一下元注解,这是定义自定义注解的基础。元注解是用于注解其他注解的注解,Java 5.0提供了四个基本的元注解: ...

    Java Annotation入门.doc

    4. 自定义注解:开发者根据需求自定义的注解,如上面的`RequestForEnhancement`。 总结,Java注解是一种强大的工具,可以帮助开发者提高代码的可读性、可维护性和自动化程度。通过定义和使用注解,可以实现更灵活的...

    入门级java 注解学习示例代码

    Java注解(Annotation)是Java语言的一个重要特性,它为元数据提供了强大的支持。元数据是一种描述数据的数据,它提供了一种安全的方式,使我们可以在不改变程序代码本身的情况下,向编译器或运行时环境提供额外的...

    java-annotation:Java注解入门教程

    本教程将带你深入理解Java注解的基础知识,并通过实际示例帮助你掌握其用法。 一、注解的定义与类型 1. 定义:Java注解是一种特殊的声明,用于向编译器、JVM或工具提供有关代码的信息。它们以`@`符号开头,后面...

    Java+Annotation入门[定义].pdf

    Java注解(Annotation)是Java语言的一个重要特性,它为元数据提供了强大的支持。元数据是关于数据的数据,可以用来提供额外...对于更高级的应用,如使用自定义注解生成JavaBean映射到XML文件,需要更深入的学习和实践。

    java annotation入门

    Java 注解(Annotation)是 Java 语言中的一个重要特性,它为程序员提供了元数据,即关于...对于更高级的用法,如自定义注解生成 XML 映射文件等,可以进一步阅读《Java Annotation 高级应用》等相关资料进行深入学习。

    java 注解的小demo,适合入门 pom

    首先,我们来深入了解一下Java注解。注解在Java中以`@AnnotationName`的形式出现,它们并不直接影响程序的运行,但可以被编译器或运行时系统用来生成代码、验证类型、部署组件等。Java提供了预定义的注解,如`@...

    2020老杜最新Java零基础进阶视频教程-注解课件

    Java注解(Annotation)是Java编程语言的一个重要特性,它提供了一种安全的方式来元数据(metadata)与程序元素关联,如类、接口、字段和方法等。注解不会改变程序的基本结构,但它们可以被编译器、JVM或工具在编译...

    java从入门到深入

    - **注解(Annotation)**:学习自定义注解及其在代码中的使用。 - **反射**:理解反射机制,如何通过Class类操作类和对象。 - **多线程**:线程的创建、同步和协作,以及线程池的使用。 11. **Java集合框架进阶...

    注解入门小解

    学习注解时,首先需要理解基本概念,然后通过编写简单的自定义注解和处理器来实践。接着,可以深入研究预定义注解的用法,并了解它们在实际项目中的应用。最后,阅读和分析使用注解的开源项目代码,可以进一步提高...

    Android 注解快速入门和实用解析.rar_Android 注解_android

    自定义注解的实现通常涉及到Java反射API,这使得在运行时可以读取并处理这些注解。 注解的应用场景广泛,包括但不限于: 1. 静态代码分析:通过注解,编译器或Lint可以在编译阶段发现潜在问题。 2. 编译时代码生成...

    Java开发实战从入门到精通视频教程下载第16章 Annotation.zip

    在本Java开发实战从入门到精通的视频教程中,第16章主要聚焦于Java注解(Annotation)这一核心特性。注解是Java语言提供的一种元数据机制,它为代码提供了额外的信息,这些信息可以被编译器、JVM或者在运行时的工具...

    重难点之JavaAnnotation手册.pdf

    在《Java Annotation入门》之后的这篇《重难点之JavaAnnotation手册》中,作者深入探讨了Annotation的概念、定义以及其在Java开发中的应用。 一、Annotation是什么? Annotation是一种在代码中添加的特殊注解,用于...

    Hibernate Annotation入门

    首先,我们需要理解Java注解的基本概念。注解是一种元数据,它提供了在编译时或运行时处理类、方法和属性的能力。在Hibernate中,注解用于声明实体类(Entity)、主键(Id)、属性映射(Column)等信息,使得我们...

    了解和入门注解的应用

    在编程世界中,注解(Annotation)是一种元数据,它为编译器、JVM(Java虚拟机)或工具提供信息...在学习注解时,理解其原理、分类及如何创建自定义注解同样至关重要,这将有助于开发出更高效、更具扩展性的软件系统。

    Java入门教程.zip

    12. **Java注解(Annotation)**:了解注解的用途,如元数据,以及如何自定义注解和使用反射来处理注解。 13. **JDBC**:学习如何使用Java Database Connectivity (JDBC) API连接数据库,执行SQL语句,处理结果集。 ...

    Java SE完整版精品优质课件 自学入门必看的优秀Java基础知识培训教案 第09章_枚举&注解(共22页).rar

    自定义注解可以定义自己的元数据,基本语法如下: ```java @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface MyAnnotation { String value(); } ``` 这里定义了一个名为...

    清华大学JAVA培训教程 JAVA基础培训教程 入门培训教程

    这个清华大学的Java教程将通过实例演示和练习帮助学员深入理解这些知识点,为后续的Java高级学习和实际项目开发打下坚实的基础。通过系统的学习和实践,学员将具备独立编写Java程序的能力,并能应对各种编程挑战。

Global site tag (gtag.js) - Google Analytics