注解

注解基本概念

注解(元数据)为我们在代码中添加信息提供一种形式化的方法，我们可以在某个时刻非常方便的使用这些数据。将的通俗一点，就是为这个方法增加的说明或功能。例如：@Overvide这个注解就用来说明这个方式重写父类的。

 

/**

 * @author zhuhuiqing

 * @desc

 * @date 2020/12/22 4:02 PM

 */

@Target(ElementType.TYPE)

@Retention(RetentionPolicy.RUNTIME)

@Documented //应用到doc

@Inherited  //允许子类继承父类中的方法

public @interface Description {

    String desc();

}

@Target(ElementType.METHOD)

@Retention(RetentionPolicy.RUNTIME)

@Documented

@Inherited

@interface Name{

    String autoner();

    String age();

}



//#############


@Description(desc = "描述类注解")

public class AnnotationClass {



    @Name(autoner = "方法测试",age = "age属性")

    public void getName(){

        System.out.println("test!!!!!");

    }



    @Name(autoner = "方法测试2",age = "age属性2")

    public void getName2(){

        System.out.println("test2!!!!!");

    }

}


//##################





    public static void main(String[] args) {



        /**

         *什么是java注解

         * 注解，顾名思义，注解,就是对某一事物进行添加注释说明，会存放一些信息，这些信息可能对以后某个时段来说是很有用处的。

         * Java注解又叫java标注，java提供了一套机制，使得我们可以对方法、类、参数、包、域以及变量等添加标准(即附上某些信息)。

         *           且在以后某个时段通过反射将标注的信息提取出来以供使用。

         *

         *2 如何自定义注解

         * 自定义步骤大致分为两步：

         * 1)， 通过@interface关键字声明注解名称，以及注解的成员属性或者叫做注解的参数。

         * 2)， 使用java内置的四个元注解对这个自定义标注的功能和范围进行一些限制

         * 问题来了，什么是元注解？

         *

         *3 什么是元注解

         * 元注解，就是定义注解的注解，也就是说这些元注解是的作用就是专门用来约束其它注解的注解。请区别上面那三个注解，他们也是通过元注解定义而来的。

         * 元注解有哪些呢，主要有四个@Target,@Retention,@Documented,@Inherited

         *

         * 元注解有：@Target,@Retention,@Documented,@Inherited

         *

         * @Target 表示该注解用于什么地方，可能的 ElemenetType 参数包括：

         *  ElemenetType.CONSTRUCTOR 构造器声明

         *  ElemenetType.FIELD 域声明（包括 enum 实例）

         *  ElemenetType.LOCAL_VARIABLE 局部变量声明

         *  ElemenetType.METHOD 方法声明

         *  ElemenetType.PACKAGE 包声明

         *  ElemenetType.PARAMETER 参数声明

         *  ElemenetType.TYPE 类，接口（包括注解类型）或enum声明

         *

         *  @Retention 表示在什么级别保存该注解信息。可选的 RetentionPolicy 参数包括：

         *  RetentionPolicy.SOURCE 注解将被编译器丢弃

         *  RetentionPolicy.CLASS 注解在class文件中可用，但会被VM丢弃

         *  RetentionPolicy.RUNTIME VM将在运行期也保留注释，因此可以通过反射机制读取注解的信息。

         *

         * @Documented 将此注解包含在 javadoc 中

         * @Inherited 允许子类继承父类中的注解

         * 如果注解的属性名为value，比较特殊，它在被指定参数的时候可以不用显示的写出来。

         *       当然如果定义的时候参数名不是value而是其它的比如des，那么使用注解的时候，

         *       必须显示写出参数名，然后再赋值：@Description(Des=”xxx”)

         *

         * 注意事项：

         * 所有的Annotation会自动继承java.lang.annotation这一个接口,所以不能再去继承别的类或是接口.

         * 最重要的一点,Annotation类型里面的参数该怎么设定:

         * 第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型.

         * 第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型

         *       和String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String.

         *

         *

         */


        Class clazz =  AnnotationClass.class;

        Method[] methods = clazz.getMethods();



        boolean flag = clazz.isAnnotationPresent(Description.class);

        if(flag) {

            Description annotation = (Description) clazz.getAnnotation(Description.class);

            System.out.println(annotation.desc());

        }



        //把JavaEyer这一类有利用到@Name的全部方法保存到Set中去

        Set<Method> set = new HashSet<Method>();

        for (Method method : methods) {

            boolean present = method.isAnnotationPresent(Name.class);

            if (present) set.add(method);

        }


        set.forEach(s -> {

            Name annotation = s.getAnnotation(Name.class);

            System.out.println(annotation.age());

            System.out.println(annotation.autoner());

        });

    }

 

JDK提供的注解

Java目前内置了三种注解@Override、@Deprecated、@SuppressWarnnings

 

• @Override：用于标识方法，标识该方法属于重写父类的方法

1. @Target(ElementType.METHOD)

2. @Retention(RetentionPolicy.SOURCE)

3. public @interface Override {

4. }

• @Deprecated：用于标识方法或类，标识该类或方法已过时，建议不要使用

1. @Documented

2. @Retention(RetentionPolicy.RUNTIME)

3. @Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})

4. public @interface Deprecated {

5. }

• @SuppressWarnnings:用于有选择的关闭编译器对类、方法、成员变量、变量初始化的警告

1. @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})

2. @Retention(RetentionPolicy.SOURCE)

3. public @interface SuppressWarnings {

4. String[] value();

5. }