• 04、Java进阶注解


    注解

    注解是Java SE 5.0版本开始引入的概念,它是对java源代码的说明,是一种元数据(描述数据的数据)。

    注解以@开头,在应用程序中会见到各种各样的注解,比如@Autowired、@Service、@Controller、@Override 、@Test、@Value等等,按照来源划分,可以分为 :

    JDK的注解

    第三方的注解

    自定义注解

    如果按照运行机制来说,分为源码注解、编译时注解和运行时注解。

    这里只讲述JDK注解和自定义注解,第三方注解使用一般参考相应的文档即可。

    JDK注解

    JDK自带的常用注解有如下三个:

    @Override 表示当前方法覆盖了父类的方法
    @Deprecation 表示方法已经过时,方法上有横线,使用时会有警告。
    @SuppviseWarnings 表示关闭一些警告信息(通知java编译器忽略特定的编译警告)

    JDK中有一些元注解,主要有@Target,@Retention,@Document,@Inherited用来修饰注解。

    @Target

    表明该注解可以应用的java元素类型

    Target类型 描述
    ElementType.TYPE 应用于类、接口(包括注解类型)、枚举
    ElementType.FIELD 应用于属性(包括枚举中的常量)
    ElementType.METHOD 应用于方法
    ElementType.PARAMETER 应用于方法的形参
    ElementType.CONSTRUCTOR 应用于构造函数
    ElementType.LOCAL_VARIABLE 应用于局部变量
    ElementType.ANNOTATION_TYPE 应用于注解类型
    ElementType.PACKAGE 应用于包
    ElementType.TYPE_PARAMETER 1.8版本新增,应用于类型变量)
    ElementType.TYPE_USE 1.8版本新增,应用于任何使用类型的语句中(例如声明语句、泛型和强制转换语句中的类型)

    @Retention

    表明该注解的生命周期

    生命周期类型 描述
    RetentionPolicy.SOURCE 编译时被丢弃,不包含在类文件中
    RetentionPolicy.CLASS JVM加载时被丢弃,包含在类文件中,默认值
    RetentionPolicy.RUNTIME 由JVM 加载,包含在类文件中,在运行时可以被获取到

    @Document
    表明该注解标记的元素可以被Javadoc 或类似的工具文档化

    @Inherited
    表明使用了@Inherited注解的注解,所标记的类的子类也会拥有这个注解

    @Target({ElementType.FIELD, ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface Info {
          String value() default "tracy";
          boolean isDelete();
    }
    

    自定义注解

    使用@interface自定义注解时,自动继承了java.lang.annotation.Annotation接口,由编译程序自动完成其他细节。在定义注解时,不能继承其他的注解或接口。@interface用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。可以通过default来声明参数的默认值。

    public @interface 注解名 {定义体}
    

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

    所有基本数据类型(int,float,boolean,byte,double,char,long,short)
    String类型
    Class类型
    enum类型
    Annotation类型
    以上所有类型的数组

    Annotation类型里面的参数该怎么设定:

    只能用public或默认(default)这两个访问权修饰。

    参数成员只能用基本数据类型、 String、Enum、Class、annotations等数据类型。以及这一些类型的数组。

    如果只有一个参数成员,最好把参数名称设为"value",后加小括号。

    1、创建自定义水果名称注解

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

    2、创建自定义水果颜色注解

    @Target(ElementType.FIELD)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface FruitColor {
        // 颜色枚举
        public enum Color{BLUE, RED, GREEN}
        // 颜色属性
        Color fruitColor() default Color.GREEN;
    }
    

    3、自定义注解的使用

    public class Apple {
        @FruitName(value = "Apple")
        private String appleName;
        @FruitColor(fruitColor = FruitColor.Color.RED)
        private String appleColor;
    
        public String getAppleName() {
            return appleName;
        }
    
        public void setAppleName(String appleName) {
            this.appleName = appleName;
        }
    
        public String getAppleColor() {
            return appleColor;
        }
    
        public void setAppleColor(String appleColor) {
            this.appleColor = appleColor;
        }
    
        public void displayName(){
            System.out.println("水果的名字是:" + appleName);
        }
    }
    

    4、通过反射的方式来解析注解:

    public class Main {
        public static void main(String[] args) {
            Class clazz = Apple.class;
            Field[] declaredFields = clazz.getDeclaredFields();
            for (Field field : declaredFields){
                if (field.isAnnotationPresent(FruitName.class)){
                    FruitName annotation = field.getAnnotation(FruitName.class);
                    System.out.println(field.getName() + "配置了FruitName注解--" + "value = " + annotation.value());
                }
    
                if (field.isAnnotationPresent(FruitColor.class)){
                    FruitColor annotation = field.getAnnotation(FruitColor.class);
                    System.out.println(field.getName() + "配置了FruitName注解--" + "value = " + annotation.fruitColor());
                }
            }
        }
    }
    

    运行结果如下:

    appleName配置了FruitName注解--value = Apple
    appleColor配置了FruitName注解--value = RED

    注意:注解元素必须有确定的值,非基本类型的注解元素的值不可为null,使用空字符串或0作为默认值是一种常用的做法。

  • 相关阅读:
    兼容利器之X-UA-Compatible
    SQL Server之游标的基础知识
    SQL 按特定字段值排序
    NodeJS 开篇 牛刀小试
    临时表之IF-ELSE
    css中如何设置字体
    怎么做到不加班?
    C# .net中cookie值为中文时的乱码解决方法
    HTML5商城开发一 楼层滚动加载数据
    QQ浏览器X5内核问题汇总
  • 原文地址:https://www.cnblogs.com/pengjingya/p/14928186.html
Copyright © 2020-2023  润新知