java基础--Annotation

什么是注解(Annotation):

  Annotation(注解)就是Java提供了一种元程序中的元素关联任何信息和着任何元数据(metadata)的途径和方法。Annotion(注解)是一个接口,程序可以通过反射来获取指定程序元素的Annotion对象,然后通过Annotion对象来获取注解里面的元数据。

什么是metadata(元数据):

  元数据从metadata一词译来,就是“关于数据的数据”的意思。

  元数据的功能作用有很多,比如:你可能用过Javadoc的注释自动生成文档。这就是元数据功能的一种。总的来说,元数据可以用来创建文档,跟踪代码的依赖性,执行编译时格式检查,代替已有的配置文件。如果要对于元数据的作用进行分类,目前还没有明确的定义,不过我们可以根据它所起的作用,大致可分为三类:

    1. 编写文档:通过代码里标识的元数据生成文档

    2. 代码分析:通过代码里标识的元数据对代码进行分析

    3. 编译检查:通过代码里标识的元数据让编译器能实现基本的编译检查

  在Java中元数据以标签的形式存在于Java代码中,元数据标签的存在并不影响程序代码的编译和执行,它只是被用来生成其它的文件或针在运行时知道被运行代码的描述信息。

  综上所述:

    第一,元数据以标签的形式存在于Java代码中。

    第二,元数据描述的信息是类型安全的,即元数据内部的字段都是有明确类型的。

    第三,元数据需要编译器之外的工具额外的处理用来生成其它的程序部件。

    第四,元数据可以只存在于Java源代码级别,也可以存在于编译之后的Class文件内部。

Annotation和Annotation类型:

  Annotation

  Annotation使用了在java5.0所带来的新语法,它的行为十分类似public、final这样的修饰符。每个Annotation具有一个名字和成员个数>=0。每个Annotation的成员具有被称为name=value对的名字和值(就像javabean一样),name=value装载了Annotation的信息。

  Annotation类型:

Annotation类型定义了Annotation的名字、类型、成员默认值。一个Annotation类型可以说是一个特殊的java接口,它的成员变量是受限制的,而声明Annotation类型时需要使用新语法。当我们通过java反射api访问Annotation时,返回值将是一个实现了该 annotation类型接口的对象,通过访问这个对象我们能方便的访问到其Annotation成员。后面的章节将提到在java5.0的
java.lang包里包含的3个标准Annotation类型。

注解的分类:

  根据注解参数的个数,我们可以将注解分为三类:

    1.标记注解:一个没有成员定义的Annotation类型被称为标记注解。这种Annotation类型仅使用自身的存在与否来为我们提供信息。比如后面的系统注解@Override;

    2.单值注解

    3.完整注解  

  根据注解使用方法和用途,我们可以将Annotation分为三类:

    1.JDK内置系统注解

    2.元注解

    3.自定义注解

系统内置标准注解:

  注解的语法比较简单,除了@符号的使用外,他基本与Java固有的语法一致,JavaSE中内置三个标准注解,定义在java.lang中:

    @Override:用于修饰此方法覆盖了父类的方法;

    @Deprecated:用于修饰已经过时的方法;

    @SuppressWarnnings:用于通知java编译器禁止特定的编译警告。

java注解原理:

注解实际上相当于一种标记,它允许你在运行时(源码、文档、类文件我们就不讨论了)动态地对拥有该标记的成员进行操作。

  实现注解需要三个条件:注解声明、使用注解的元素、操作使用注解元素的代码。  

  首先是注解声明,注解也是一种类型,我们要定义的话也需要编写代码,如下:

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 自定义注解,用来配置方法
 */
@Retention(RetentionPolicy.RUNTIME)
// 表示注解在运行时依然存在
@Target(ElementType.METHOD)
// 表示注解可以被使用于方法上
public @interface SayHiAnnotation {
	String paramValue() default "johness"; // 表示我的注解需要一个参数 名为"paramValue"
										   // 默认值为"johness"
}

然后是使用我们注解的元素:

package element;

import annotation.SayHiAnnotation;

/**
 * 要使用SayHiAnnotation的元素所在类
 * 由于我们定义了只有方法才能使用我们的注解,我们就使用多个方法来进行测试
 */
public class SayHiEmlement {

    // 普通的方法
    public void SayHiDefault(String name){
        System.out.println("Hi, " + name);
    }

    // 使用注解并传入参数的方法
    @SayHiAnnotation(paramValue="Jack")
    public void SayHiAnnotation(String name){
        System.out.println("Hi, " + name);
    }

    // 使用注解并使用默认参数的方法
    @SayHiAnnotation
    public void SayHiAnnotationDefault(String name){
        System.out.println("Hi, " + name);
    }
}

最后,是我们的操作方法(值得一提的是虽然有一定的规范,但您大可不必去浪费精力,您只需要保证您的操作代码在您希望的时候执行即可):

package Main;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

import element.SayHiEmlement;
import annotation.SayHiAnnotation;

public class AnnotionOperator {
    public static void main(String[] args) throws IllegalAccessException, IllegalArgumentException, InvocationTargetException, ClassNotFoundException {
        SayHiEmlement element = new SayHiEmlement(); // 初始化一个实例,用于方法调用
        Method[] methods = SayHiEmlement.class.getDeclaredMethods(); // 获得所有方法

        for (Method method : methods) {
            SayHiAnnotation annotationTmp = null;
            if((annotationTmp = method.getAnnotation(SayHiAnnotation.class))!=null) // 检测是否使用了我们的注解
                method.invoke(element,annotationTmp.paramValue()); // 如果使用了我们的注解,我们就把注解里的"paramValue"参数值作为方法参数来调用方法
            else
                method.invoke(element, "Rose"); // 如果没有使用我们的注解,我们就需要使用普通的方式来调用方法了
        }
    }
}

结果为:Hi, Jack

     Hi, johness

     Hi, Rose

与xml的比较:

目前web应用中几乎都使用xml作为配置项,例如我们常用的框架 Struts、Spring、Hibernate、IBatis等等都采用 xml 作为配置。xml之所以这么流行,是因为它的很多优点是其它技术的配置所无法替代的。

  1、xml 作为可扩展标记语言最大的优势在于开发者能够为软件量身定制适用的标记,使代码更加通俗易懂。

  2、利用 xml 配置能使软件更具扩展性。例如 Spring将class间的依赖配置在xml 中,最大限度地提升应用的可扩展性。

  3、具有成熟的验证机制确保程序正确性。利用Schema或DTD 可以对 xml 的正确性进行验证,避免了非法的配置导致应用程序出错。

  4、修改配置而无需变动现有程序。

  虽然有如此多的好处,但毕竟没有什么万能的东西,xml也有自身的缺点。

  1、需要解析工具或类库的支持。

  2、解析 xml 势必会影响应用程序性能,占用系统资源。

  3、配置文件过多导致管理变得困难。

  4、编译期无法对其配置项的正确性进行验证,或要查错只能在运行期。

  5、IDE 无法验证配置项的正确性无能为力。

  6、查错变得困难。往往配置的一个手误导致莫名其妙的错误。

  7、开发人员不得不同时维护代码和配置文件,开发效率变得低下。

  8、配置项与代码间存在潜规则。改变了任何一方都有可能影响另外一方。

  让我们来看看 Annotation 的优点。

  1、保存在 class 文件中,降低维护成本。

  2、无需工具支持,无需解析。

  3、编译期即可验证正确性,查错变得容易。

  4、提升开发效率。

  同样 Annotation 也不是万能的,它也有很多缺点。

  1、若要对配置项进行修改,不得不修改 Java 文件,重新编译打包应用。

  2、配置项编码在 Java 文件中,可扩展性差。

总结:

没有一个事物是万能的,同样 xml 和 Java Annotation 都有各自的优缺点。通过以上对比,细心的读者可能已经发现它们的优缺点恰恰是互补的。xml 的强项是 Annotation 所不具备的,而 Annotation 的优势也是 xml 所欠缺的。这也正是时下流行的 xml + Annotation 配置的原因所在。

其实我们以前就使用过注解在C#中只是在哪里叫Attribute.Java与C#都从一开始就强调程序的模块化,所以写出来的程序不但包括代码逻辑,还包括类型信息等“元数据”。Java早期版本只支持有限的几种元数据,用户无法自定义新的元数据类型;后来者C#则从一开始就在支持内建attribute的同时支持用户定义的attribute,为程序在运行时提供更多信息。从Java 5开始,Java添加了一些内建元数据类型,并且开始以annotation的形式支持用户定义的元数据。这样,在Java和C#中,用户都可以通过元数据来扩展语言,为语言提供更丰富的语义。

C# attribute跟Java annotation其实它们都是元数据的载体。

时间: 2024-10-10 01:46:12

java基础--Annotation的相关文章

Java 基础之认识 Annotation

Java 基础之认识 Annotation 从 JDK 1.5 版本开始,Java 语言提供了通用的 Annotation 功能,允许开发者定义和使用自己的 Annotation 类型.Annotation 功能包括了关于定义 Annotation 类型的语法,对声明式进行注解的语法,读取 Annotation 的 API,Annotation 在 class 文件中的表现,以及 Annotation 处理工具(APT). Annotation 并不直接对程序的语法产生作用,但是会提供一些程序之

Java基础之理解Annotation(与@有关,即是注释)

Java基础之理解Annotation 一.概念 Annontation是Java5开始引入的新特征.中文名称一般叫注解.它提供了一种安全的类似注释的机制,用来将任何的信息或元数据(metadata)与程序元素(类.方法.成员变量等)进行关联. 更通俗的意思是为程序的元素(类.方法.成员变量)加上更直观更明了的说明,这些说明信息是与程序的业务逻辑无关,并且是供指定的工具或框架使用的. Annontation像一种修饰符一样,应用于包.类型.构造方法.方法.成员变量.参数及本地变量的声明语句中.

Java基础笔记 – Annotation注解的介绍和使用 自定义注解

Java基础笔记 – Annotation注解的介绍和使用 自定义注解 本文由arthinking发表于5年前 | Java基础 | 评论数 7 |  被围观 25,969 views+ 1.Annotation的工作原理:2.@Override注解:3.@Deprecated注解:4.@SuppressWarnings注解:5.自定义注解:5.1.添加变量:5.2.添加默认值:5.3.多变量使用枚举:5.4.数组变量:6.设置注解的作用范围:6.1.在自定义注解中的使用例子:7.使用反射读取R

Java基础之理解Annotation

一.概念 Annontation是Java5开始引入的新特征.中文名称一般叫注解.它提供了一种安全的类似注释的机制,用来将任何的信息或元数据(metadata)与程序元素(类.方法.成员变量等)进行关联. 更通俗的意思是为程序的元素(类.方法.成员变量)加上更直观更明了的说明,这些说明信息是与程序的业务逻辑无关,并且是供指定的工具或框架使用的. Annontation像一种修饰符一样,应用于包.类型.构造方法.方法.成员变量.参数及本地变量的声明语句中. 二.原理 Annotation其实是一种

java基础篇---注解(Annotation)

一.概念 Annontation是Java5开始引入的新特征.中文名称一般叫注解.它提供了一种安全的类似注释的机制,用来将任何的信息或元数据(metadata)与程序元素(类.方法.成员变量等)进行关联.更通俗的意思是为程序的元素(类.方法.成员变量)加上更直观更明了的说明,这些说明信息是与程序的业务逻辑无关,并且是供指定的工具或框架使用的. Annontation像一种修饰符一样,应用于包.类型.构造方法.方法.成员变量.参数及本地变量的声明语句中. java.lang.annotation.

java基础-注解Annotation原理和用法

在很多java代码中都可以看到诸如@Override.@Deprecated.@SuppressWarnings这样的字符,这些就是注解Annotation.注解最早在jdk5中被引入,现在已经成为java平台很重要的一部分了,很多的框架程序中也喜欢使用注解,如Spring.Mybatis等. 那么,什么是注解呢?注解就是元数据,一种描述数据的数据,通俗一点就是为程序的元素(类.方法.成员变量)加上更直观的说明,这些说明信息是与程序的业务逻辑无关的.但是,我们可以通过java的反射机制来获取An

Java基础:注解Annotation

从JDK5开始,Java增加了注解(Annotation),注解是代码里的特殊标记,这些标记可以在编译.类加载.运行时被读取,并执行相应的处理.通过使用注解,开发人员可以在不改变原有逻辑的情况下,在源文件中嵌入一些补充的信息.代码分析工具.开发工具和部署工具可以通过这些补充信息进行验证.处理或者进行部署. 注解提供了一种为程序元素(包.类.构造器.方法.成员变量.参数.局域变量)设置元数据的方法.跟public.static等修饰符一样,注解是这些程序元素的属性,是这些程序元素的一部分,不能脱离

java 基础(二)

java 基础(二)java 基础(二) 2016-2-1 by Damon 61. 编写多线程程序有几种实现方式 Java 5以前实现多线程有两种实现方法:一种是继承Thread类:另一种是实现Runnable接口.两种方式都要通过重写run()方法来定义线程的行为,推荐使用后者,因为Java中的继承是单继承,一个类有一个父类,如果继承了Thread类就无法再继承其他类了,显然使用Runnable接口更为灵活. 补充:Java 5以后创建线程还有第三种方式:实现Callable接口,该接口中的

java基础之 Advanced Class Design

 java基础之 Advanced Class Design Abstract Classes In many programming situations, you want to specify an abstraction without specifying implementation-level details. In such cases, you can use either abstract classes or interfaces. Abstract classes are