zoukankan      html  css  js  c++  java
  • java 注解

    举例:

    import java.lang.annotation.*;
    
    @Target({ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface CollectTask {
    
    
    }
    

    以上定义了一个CollectTask注解,@Target和@Retention称为元注解

    一、元注解(meta-annotation):

      元注解的作用就是负责申明注解的一些属性(比如作用域,作用范围等)。Java5.0定义了4个标准的meta-annotation类型:

        1.@Target,
        2.@Retention,
        3.@Documented,
        4.@Inherited
    

    @Target:

       @Target说明了Annotation作用域:Annotation可被用于 packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。

      作用:用于描述注解的使用范围(即:被描述的注解可以用在什么地方)

      取值(ElementType)有:
    
        1.CONSTRUCTOR:用于描述构造器
        2.FIELD:用于描述域(类属性)
        3.LOCAL_VARIABLE:用于描述局部变量
        4.METHOD:用于描述方法
        5.PACKAGE:用于描述包
        6.PARAMETER:用于描述参数
        7.TYPE:用于描述类、接口(包括注解类型) 或enum声明
    

    @Retention:
    @Retention定义了该Annotation被保留的时间长短属性:某些Annotation仅出现在源代码中,而被编译器丢弃;而另一些却被编译在class文件中;编译在class文件中的Annotation可能会被虚拟机忽略,而另一些在class被装载时将被读取(请注意并不影响class的执行,因为Annotation与class在使用上是被分离的)。@Override 和 @SuppressWarnings,则可选用 SOURCE 注解。

      作用:表示需要在什么级别保存该注释信息,用于描述注解的生命周期(即:被描述的注解在什么范围内有效)

      取值(RetentionPoicy)有:

         1、RetentionPolicy.SOURCE:注解只保留在源文件,当Java文件编译成class文件的时候,注解被遗弃;
                   2、RetentionPolicy.CLASS:注解被保留到class文件,但jvm加载class文件时候被遗弃,这是默认的生命周期;
                   3、RetentionPolicy.RUNTIME:注解不仅被保存到class文件中,jvm加载class文件之后,仍然存在;
    

    一般如果需要在运行时去动态获取注解信息,那只能用 RUNTIME 注解;如果要在编译时进行一些预处理操作,比如生成一些辅助代码(如 ButterKnife),就用 CLASS注解;如果只是做一些检查性的操作,比如
    3.@Documented,
    @Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解,没有成员。
    4.@Inherited
    是一个标注注解,没有成员,使用该申明的注解,使用该注解的类,继承了该类的子类也相当于加上了该注解。

    二:注解参数

    @interface用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。可以通过default来声明参数的默认值。

      定义注解格式:
      public @interface 注解名 {定义体}

      注解参数的可支持数据类型:

        1.所有基本数据类型(int,float,boolean,byte,double,char,long,short)
        2.String类型
        3.Class类型
        4.enum类型
        5.Annotation类型
        6.以上所有类型的数组

      Annotation类型里面的参数该怎么设定:
      第一,只能用public或默认(default)这两个访问权修饰.例如,String value();默认defaul类型;   
      第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;  
      第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号。

    举例:

    @Target(ElementType.FIELD)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface CarName{
        String value() default "";
    }
    

    这里定义了一个在类的属性上的注解CarName。使用如下,在一个类的属性上加注解以及内容,当然返回类型可以设置以上类型,这里不再举例。

    @CarName("BYD")
        private String carNmae;
    

    使用:可以用过反射来获取注解的内容

    public static void main(String[] args) throws Exception
        {
            // 获得要调用的类
            Class<MyTest> myTestClass = MyTest.class;
            // 获得要调用的方法,output是要调用的方法名字,new Class[]{}为所需要的参数。
            Method method = myTestClass.getMethod("output", new Class[]{});
            // 是否有类型为MyAnnotation的注解
            if (method.isAnnotationPresent(MyAnnotation.class))
            {
                // 获得注解
                MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);
                // 调用注解的内容
                System.out.println(annotation.hello());
                System.out.println(annotation.world());
            }
            System.out.println("----------------------------------");
            // 获得所有注解。必须是runtime类型的
            Annotation[] annotations = method.getAnnotations();
            for (Annotation annotation : annotations)
            {
                // 遍历所有注解的名字
                System.out.println(annotation.annotationType().getName());
            }
        }
    
  • 相关阅读:
    面向对象基本原则
    策略模式
    简单工厂模式
    高内聚、低耦合
    UML在代码中的展现
    使用commons-csv简单读写CSV文件
    java反射机制
    SrpingDruid数据源加密数据库密码
    markdown学习经验
    Vue.js学习笔记
  • 原文地址:https://www.cnblogs.com/hts-technology/p/9340576.html
Copyright © 2011-2022 走看看