JAVA的注解Annotation

墨蓝 2022-06-09 00:19 190阅读 0赞

**一.介绍**  
![这里写图片描述][SouthEast]

**二.java提供的5个基本的Annotation的使(定义在java.lang包下)**  
1.@Override  
![这里写图片描述][SouthEast 1]

2.@Deprecated  
![这里写图片描述][SouthEast 2]

3.@SuppressWarnings  
![这里写图片描述][SouthEast 3]

4.@SafeVarargs  
堆污染警告  
![这里写图片描述][SouthEast 4]  
![这里写图片描述][SouthEast 5]

5.@Functionalinterface  
![这里写图片描述][SouthEast 6]  
![这里写图片描述][SouthEast 7]  
![这里写图片描述][SouthEast 8]

**三.JDK的元Annotation(定义在java.lang.annotation下)**  
JDK还提供了6个Meta Annotation(元Annotation)，其中有5个元Annotation用于修饰其他Annotation的定义(定义或自定义Annotation时)。其中@Repeatable专门用于定义java8新增的重复注解

1.@Retention  
![这里写图片描述][SouthEast 9]  
![这里写图片描述][SouthEast 10]

2.@Target  
![这里写图片描述][SouthEast 11]

3.@Documented  
![这里写图片描述][SouthEast 12]  
![这里写图片描述][SouthEast 13]  
![这里写图片描述][SouthEast 14]

4.@Inherited  
![这里写图片描述][SouthEast 15]  
![这里写图片描述][SouthEast 16]  
![这里写图片描述][SouthEast 17]

**四.自定义Annotation**  
1.分类  
![这里写图片描述][SouthEast 18]

方法名称为了成员名，而方法返回值称为了成员的类型。而方法返回值必须为primitive类型、Class类型、枚举类型、Annotation类型或者由前面类型之一作为元素的一位数组。方法的后面可以使用default和一个默认数值来申明成员的默认值，null不能作为成员的默认值

2.标记Annotation  
![这里写图片描述][SouthEast 19]

package com.tiglle.annotation;
    //使用@interface关键字定义Annotation
    public @interface Test {
    
    }

使用  
![这里写图片描述][SouthEast 20]

package com.tiglle.test;
    
    import com.tiglle.annotation.Test;
    
    //使用在类上
    @Test 
    public class UseTest { 
    
        //使用在字段上
        @Test
        private String name;
    
        //使用在方法上
        @Test
        public void test(){
    
        }
    
        //使用在方法上
        @Test public void test(String name){
    
        }
    }

3.元数据Annotation  
![这里写图片描述][SouthEast 21]

package com.tiglle.annotation;
    
    public @interface MyAnnotation1 {
    
        //定义成员变量
        //格式:返回值 方法名();
        String name();
        int age();
        //定义了没有默认值的成员变量的Annotation使用时必须指定值
    }

使用  
![这里写图片描述][SouthEast 22]

package com.tiglle.test;
    
    import com.tiglle.annotation.MyAnnotation1;
    //定义了没有默认值的成员变量的Annotation使用时必须指定值
    @MyAnnotation1(name="小明",age=20)
    public class UseMyAnnotation1 { 
    
        //定义了没有默认值的成员变量的Annotation使用时必须指定值
        @MyAnnotation1(name="小红",age=30)
        public void test(){}
    
    }

4.带默认值的元数据Annotation  
![这里写图片描述][SouthEast 23]

package com.tiglle.annotation;
    
    public @interface MyAnnotation2 {
    
        //定义两个有初始默认值的成员变量
        //格式:返回值 方法名() defalut 值;
        String name() default "小明";
        int age() default 20;
        //指定了初始值的Annotation在使用时可以选择性的指定值,指定的值会覆盖初始值
    
    }

使用:  
指定了初始值的Annotation在使用时可以选择性的指定值,指定的值会覆盖初始值

package com.tiglle.test;
    
    import com.tiglle.annotation.MyAnnotation2;
    
    //指定了初始值的Annotation在使用时可以选择性的指定值,指定的值会覆盖初始值
    @MyAnnotation2
    public class UseAnnotation2 { 
    
        //指定了初始值的Annotation在使用时可以选择性的指定值,指定的值会覆盖初始值
        @MyAnnotation2(name="小明")
        public void test1(){}
    
        //指定了初始值的Annotation在使用时可以选择性的指定值,指定的值会覆盖初始值
        @MyAnnotation2(age=20)
        public void test2(){}
    
        //指定了初始值的Annotation在使用时可以选择性的指定值,指定的值会覆盖初始值
        @MyAnnotation2(name="小明",age=20)
        public void test3(){}
    }

![这里写图片描述][SouthEast 24]

**五.提取Annotation信息(使Annotation生效)**  
![这里写图片描述][SouthEast 25]

1.通过反射获取程序中的Annotation信息，并做出相应的处理  
![这里写图片描述][SouthEast 26]

2.通过反射操作Annotation的方法  
![这里写图片描述][SouthEast 27]

3.获取某个方法的Annotation信息  
@Retention(RetentionPolicy.RUNTIME):让注解可以保留到运行时  
定义:

package com.tiglle.annotation;
    
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    
    //使用@interface关键字定义Annotation
    //@Retention(RetentionPolicy.RUNTIME):让注解可以保留到运行时,不然通过反射获取不到Annotation信息
    @Retention(RetentionPolicy.RUNTIME)
    public @interface Test {
    
    }

在UseTest类的test方法添加@Test的Annotation  
获取方法Annotation信息

package com.tiglle.opera;
    
    import java.lang.annotation.Annotation;
    import java.lang.reflect.Method;
    
    public class OperaUseTest {
    
        public static void main(String[] args) throws Exception{
            //获取UseTest类的test方法的所有注解
            Class clazz = Class.forName("com.tiglle.use.UseTest");
            Method testMeth = clazz.getMethod("test");
            Annotation[] annos = testMeth.getAnnotations();
            for(Annotation anno:annos){
                System.out.println(anno);
            }
        }
    
    }
    //运行结果:
    @com.tiglle.annotation.Test()

4.获取元数据Annotation的元数据信息  
![这里写图片描述][SouthEast 28]  
定义两个元数据Annotation  
无默认值的元数据Annotation

package com.tiglle.annotation;
    
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    //@Retention(RetentionPolicy.RUNTIME):让注解可以保留到运行时
    @Retention(RetentionPolicy.RUNTIME)
    public @interface MyAnnotation1 { 
    
        //定义成员变量
        //格式:返回值 方法名();
        String name();
        int age();
        //定义了没有默认值的成员变量的Annotation使用时必须指定值
    }

有默认值的元数据Annotation

package com.tiglle.annotation;
    
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    
    //@Retention(RetentionPolicy.RUNTIME):让注解可以保留到运行时
    @Retention(RetentionPolicy.RUNTIME)
    public @interface MyAnnotation2 { 
    
        //定义两个有初始默认值的成员变量
        //格式:返回值 方法名() defalut 值;
        String name() default "小明";
        int age() default 20;
        //指定了初始值的Annotation在使用时可以选择性的指定值,指定的值会覆盖初始值
    
    }

使用:

package com.tiglle.use;
    
    import com.tiglle.annotation.MyAnnotation1;
    import com.tiglle.annotation.MyAnnotation2;
    
    public class UseMyAnnotation { 
    
        @MyAnnotation1(name="小红",age=90)//无默认值的
        @MyAnnotation2//有默认值的
        public void test(String name){
    
        }
    
    }

获取元数据Annotation的元数据信息的操作

package com.tiglle.opera;
    
    import java.lang.annotation.Annotation;
    import java.lang.reflect.Method;
    
    import com.tiglle.annotation.MyAnnotation1;
    import com.tiglle.annotation.MyAnnotation2;
    
    public class OperaUseMyAnnotation {
    
        public static void main(String[] args) throws Exception {
            Class clazz = Class.forName("com.tiglle.use.UseMyAnnotation");
            Method testMeth = clazz.getMethod("test");
            //获取test类的所有Annotation
            Annotation[] annos = testMeth.getAnnotations();
            for(Annotation anno:annos){
                //如果anno时MyAnnotation1类型
                if(anno instanceof MyAnnotation1){
                    //将anno强转为MyAnnotation1类型
                    MyAnnotation1 myAnno1 = (MyAnnotation1) anno;
                    //获取元数据信息
                    String name = myAnno1.name();
                    int age = myAnno1.age();
                    System.out.println("MyAnnotation1.name="+name+",MyAnnotation1.age="+age);
                }
                //如果anno时MyAnnotation2类型
                if(anno instanceof MyAnnotation2){
                    //将anno强转为MyAnnotation2类型
                    MyAnnotation2 myAnno2 = (MyAnnotation2) anno;
                    //获取元数据信息
                    String name = myAnno2.name();
                    int age = myAnno2.age();
                    System.out.println("MyAnnotation2.name="+name+",MyAnnotation2.age="+age);
                }
            }
        }
    
    }
    运行结果:
    MyAnnotation1.name=小红,MyAnnotation1.age=90
    MyAnnotation2.name=小明,MyAnnotation2.age=20

**六.使用Annotation的示例**  
1.指定运行的方法(只运行一个程序添加了指定注解的方法)  
自定义@Run注解(标记annotation)

package com.tiglle.annotation;
    
    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):只能用在方法上面
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.METHOD)
    public @interface Run {
    
    }

使用注解：

package com.tiglle.use;
    
    import com.tiglle.annotation.Test;
    
    //使用在类上
    @Test 
    public class UseTest { 
    
        //使用在字段上
        @Test
        private String name;
    
        //使用在方法上
        @Test
        public void test(){
    
        }
    
        //使用在方法上
        @Test public void test(String name){
    
        }
    }

对使用注解的操作

package com.tiglle.opera;
    
    import java.lang.reflect.Method;
    
    import com.tiglle.annotation.Run;
    
    public class OperaUseRun { 
    
        public static void main(String[] args) throws Exception {
            selectRun("com.tiglle.use.UseRun");
        }
    
        /** * 根据类名判断有没有添加Run注解,有即运行改添加@Run注解的方法 * @param forName * @throws Exception */
        public static void selectRun(String className) throws Exception{
            Class clazz = Class.forName(className);
            //获取所有方法
            Method[] meths = clazz.getMethods();
            Object obj = clazz.newInstance();
            for(Method meth:meths){
                //如果方法使用了@Run注解
                if(meth.isAnnotationPresent(Run.class)){
                    //即运行该方法(可能调用者不是同一个对象)
                    meth.invoke(obj);
                }
            }
        }
    
    }
    运行结果:
    我是run1,添加了@Run注解
    我是run4,添加了@Run注解

[SouthEast]: /images/20220609/a2936023461e4579b6962c0c13b49c14.png
[SouthEast 1]: /images/20220609/cef30adb7c034206bfaf5ca14aeba7e7.png
[SouthEast 2]: /images/20220609/8e5bd1b18a584f53a97371e9a19c18f0.png
[SouthEast 3]: /images/20220609/71f139fce42442d69ff903efb0e7da3a.png
[SouthEast 4]: /images/20220609/e189812c1a484d91ab3312ae5a515a94.png
[SouthEast 5]: /images/20220609/87793e155879469980b0fb4b7deed7ed.png
[SouthEast 6]: /images/20220609/cbc69072eb8c464fb0df408d0a3d13d0.png
[SouthEast 7]: /images/20220609/fbca9e5f87cb47baa8d469b760767e61.png
[SouthEast 8]: /images/20220609/766cabbcdb214af7b27c3caec7055078.png
[SouthEast 9]: /images/20220609/193ded883e534b15bdb183c279a39461.png
[SouthEast 10]: /images/20220609/c4e1acba07044dab9a3fe9799b3aea19.png
[SouthEast 11]: /images/20220609/67078ae013f04a3c88e15804b2b997ae.png
[SouthEast 12]: /images/20220609/058f710c41424c1c8810ac8df8ca708e.png
[SouthEast 13]: /images/20220609/396af11deb3a41a38ea8f993317432ee.png
[SouthEast 14]: /images/20220609/2322b6240a854ba18cda4fdcb0a9dceb.png
[SouthEast 15]: /images/20220609/1377626f4d3e46f082114159d594c1aa.png
[SouthEast 16]: /images/20220609/f9d4823ab13c4396b62c94a2a96ae189.png
[SouthEast 17]: /images/20220609/f4d999bcfc654fcbab63cbbbced68c9f.png
[SouthEast 18]: /images/20220609/8f12e9cd1d1346fbac82824a139edce0.png
[SouthEast 19]: /images/20220609/45d0eba08f8d41c3bb3ef1b32b437f9e.png
[SouthEast 20]: /images/20220609/750ae89611b946fc9fb0d2a864d63c21.png
[SouthEast 21]: /images/20220609/da33f6e683cb4b84847056dfd48461d2.png
[SouthEast 22]: /images/20220609/6fa192b7f33e47c3b29d61a53d64a57b.png
[SouthEast 23]: /images/20220609/4ed3dbe6ca6b4971a0ab7165ccdeb25d.png
[SouthEast 24]: /images/20220609/8f0a2f06cea84f8e9a1027b3676fe025.png
[SouthEast 25]: /images/20220609/ca69aeabeeed476aba555f02efcce78e.png
[SouthEast 26]: /images/20220609/6a54a2e043ac4704976a5f77f0031fdc.png
[SouthEast 27]: /images/20220609/663ffd4ba2d44ba480446f0afdf9e8ac.png
[SouthEast 28]: /images/20220609/1d8181dad7484bbf9fdfab09f0c6765b.png