Java 注解

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

Annotation能被用来为某个程序元素(类、方法、成员变量等)关联任何的信息。需要注意的是,这里存在着一个基本的规则:Annotation不能影响程序代码的执行,无论增加、删除 Annotation,代码都始终如一的执行。另外,尽管一些annotation通过java的反射api方法在运行时被访问,而java语言解释器在工作时忽略了这些annotation。正是由于java虚拟机忽略了Annotation,导致了annotation类型在代码中是“不起作用”的; 只有通过某种配套的工具才会对annotation类型中的信息进行访问和处理。

三种内置的注解,在java.lang包中:

  • @Override
  • @Deprecated     表示修饰的内容已经过时了,不建议使用这个方法了。
  • @SupressWarnings 关闭不当的编译器警告信息

SupressWarnings 的参数是一个String数组,可以的取值有

1.deprecation:使用了不赞成使用的类或方法时的警告;
    2.unchecked:执行了未检查的转换时的警告,例如当使用集合时没有用泛型 (Generics) 来指定集合保存的类型; 
    3.fallthrough:当 Switch 程序块直接通往下一种情况而没有 Break 时的警告;
    4.path:在类路径、源文件路径等中有不存在的路径时的警告; 
    5.serial:当在可序列化的类上缺少 serialVersionUID 定义时的警告; 
    6.finally:任何 finally 子句不能正常完成时的警告; 
    7.all:关于以上所有情况的警告

public @interface _Test {
}

在注解中可以包含一些元素,注解跟接口很相似,但是注解的元素可以指定默认值,没有元素的注解成为标记注解
注解可以定义到任意的位置上,使用的位置可以由@Target指定。

元注解

@Target 表示注解可以用于什么地方 在ElementType中

  • CONSTRUCTOR
  • FIELD
  • LOCAL_VARIABLE
  • METHOD
  • PACKAGE
  • PARAMETER
  • TYPE    类、接口、enum、注解的声明

@Retention 表示在什么级别保存注解信息,在RetentionPolicy中

  • SOURCE
  • CLASS
  • RUNTIME

@Documented 将此注解包含在javadoc中

@Inherited 允许子类继承父类的注解,是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation,方法并不从它所重载的方法继承annotation。

注解中的元素只能是一下类型,默认值必须是确定的,不能是null:

  • 基本类型
  • String
  • Class
  • enum
  • Annatation,,也就是注解可以嵌套

注解的一个价值在于,对于RUNTIME的注解,可以通过反射机制来获得注解的信息对应的相关的值,完成相关操作

注解的赋值:

当元素的名字是value的时候,如果只想对这一个元素赋值,可以直接写,不用key=val的对儿

对于数组,使用{}赋值,多个参数使用逗号隔开,并且要使用 key=val的语法

关于反射读取注解:

 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():返回直接存在于此元素上的所有注释。与此接口中的其他方法不同,该方法将忽略继承的注释。

程序举例:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface classIfo{
    String value() default "";
}

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface NameType{
    String value() default "这是乳名";
}
@Retention(RetentionPolicy.RUNTIME)
@interface adultIfo{
    String name() default "";
    int age() default 0;
}

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@interface parentIfo{
    int Marriage_time() default -1;    //这里是注解的嵌套,其实用起来跟一般的类型一样,使用的时候就把注解当成是接口就可以了
    adultIfo [] parent() default {};
}

@classIfo("学生类-用来测试反射机制读取Annotation")
class Student{
        //不指定参数就是使用默认值
    @NameType
    String name="小明";
         //这里注意数组和嵌套的使用
    @parentIfo(Marriage_time=20,parent={@adultIfo(name="baba",age=39),@adultIfo(name="mama",age=39)})
    String getParent(){
        return "parent";
    }
}

public class Demo04 {
    public static void main(String[] args){

        Class<?> cc=Student.class;

        Field[] ff=cc.getDeclaredFields();
        for(Field f:ff){
            if(f.isAnnotationPresent(NameType.class)){
                NameType nt=f.getAnnotation(NameType.class);
                System.out.println("名字类型的说明   "+nt.value());
            }
        }
        Method[] mm=cc.getDeclaredMethods();
        for(Method m:mm){
            if(m.isAnnotationPresent(parentIfo.class)){
                parentIfo pi=m.getAnnotation(parentIfo.class);
                System.out.println("结婚时间:"+String.valueOf(pi.Marriage_time()));
                adultIfo ai[]=pi.parent();
                System.out.println("父亲"+ai[0].name()+" "+ai[0].age());
                System.out.println("母亲"+ai[1].name()+" "+ai[1].age());

            }
        }
    }
}
时间: 2024-10-10 05:13:50

Java 注解的相关文章

Java注解(2)-注解处理器(运行时|RetentionPolicy.RUNTIME)

如果没有用来读取注解的工具,那注解将基本没有任何作用,它也不会比注释更有用.读取注解的工具叫作注解处理器.Java提供了两种方式来处理注解:第一种是利用运行时反射机制:另一种是使用Java提供的API来处理编译期的注解. 反射机制方式的注解处理器 仅当定义的注解的@Retention为RUNTIME时,才能够通过运行时的反射机制来处理注解.下面结合例子来说明这种方式的处理方法. Java中的反射API(如java.lang.Class.java.lang.reflect.Field等)都实现了接

Java注解(1)-注解基础

注解(Annotation)是在JAVA5中开始引入的,它为在代码中添加信息提供了一种新的方式.注解在一定程度上把元数据与源代码文件结合在一起,正如许多成熟的框架(Spring)所做的那样.那么,注解到底可以做什么呢? 1.注解的作用. 提供用来完整地描述程序所需要的信息,如编译期校验程序信息. 生成描述符文件,或生成新类的定义. 减轻编写"样板"代码(配置文件)的负担,可以使用注解自动生成. 更加干净易读的代码. 编译期类型检查. 2.Java提供的注解 Java5内置了一些原生的注

Java注解(3)-注解处理器(编译期|RetentionPolicy.SOURCE)

注解的处理除了可以在运行时通过反射机制处理外,还可以在编译期进行处理.在编译期处理注解时,会处理到不再产生新的源文件为止,之后再对所有源文件进行编译. Java5中提供了apt工具来进行编译期的注解处理.apt是命令行工具,与之配套的是一套描述"程序在编译时刻的静态结构"的API:Mirror API(com.sun.mirror.*).通过Mirror API可以获取到被注解的Java类型元素的信息,从而提供自定义的处理逻辑.具体的处理工具交给apt来处理.编写注解处理器的核心是两个

java注解中的元注解

一:java注解中的元注解 四个元注解分别是:@Target,@Retention,@Documented,@Inherited , 再次强调下元注解是java API提供,是专门用来定义注解的注解,其作用分别如下: @Target 表示该注解用于什么地方,可能的值在枚举类 ElemenetType 中,包括: ElemenetType.CONSTRUCTOR----------------------------构造器声明 ElemenetType.FIELD ----------------

Java注解

注解是一种元数据形式,提供关于不是程序部分的程序的数据.操作代码上的注解不影响注解的代码. 注解有许多用途,其中: 编译器信息 -- 注解被用于编译器检测错误或抑制警告. 编译时和部署时处理 -- 软件工具能处理注解信息生成代码.XML文件等等. 运行时处理 -- 一些注解可用在运行时检查. 1     注解基础 1.1    注解的格式 最简单的注解形式如下所示: @Entity 在符号字符(@)告诉编译器这是一个注解.在下面的例子中,注解的名称是Override: @Override voi

Java注解项目实战即模拟Hibenernate生成sql语句

整理了近期学习java注解的部分代码 ,借助java注解模拟Hibenernate ORM模型建立对象与sql语句的映射 Table 注解的创建 package com.imooc.test; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.

java注解例子

java注解在web框架中使用比较广泛,这使得对象之间的关系配置起来更加容易 目前web框架中最常用的两种配置对象依赖关系的方式就是注解和xml配置文件的方法,api配置相对来说用的少一些, 下面实现一个Table注解来实现数据库表和实体bean之间的对应关系,实现一个Column注解来实现数据库表中每个字段和实体bean每个属性之间的 对应关系.java中的orm基本上就是根据这种思想来实现的. Table注解代码: package com.panther.dong.annotation.an

Java注解处理器

这几天看公司一个中间件对异步的支持的新特性中,它使用注解处理器来自动生成异步接口.就看了下如何使用注解及编译期注解处理器,一下是些学习笔记吧! 此处说的Java注解及注解处理器,不是运行期注解及使用Class对象和反射来处理的处理器!而是编译期处理的源文件注解(RetentionPolicy.SOURCE);其注解处理器(Annotation Processor)是javac的一个工具,它用来在编译时扫描和处理注解(Annotation).你可以对自定义注解,并注册相应的注解处理器. 用途 编译

19.Java 注解

19.Java注解 1.Java内置注解----注解代码 @Deprecated                                    //不推荐使用的过时方法 @Deprecated public void badMethod(){ System.out.println("I am a old function"); } @Override                                        //必须是覆盖父类(接口)的函数 @Overrid

Java注解入门

注解的分类 按运行机制分: 源码注解:只在源码中存在,编译后不存在 编译时注解:源码和编译后的class文件都存在(如@Override,@Deprecated,@SuppressWarnings) 运行时注解:能在程序运行时起作用(如spring的依赖注入) 按来源分: 来自JDK的注解 第三方的注解 自定义的注解 自定义注解   如下实例给出了自定义注解的基本方法 1 package com.flypie.annotations; 2 3 import java.lang.annotatio