java中注解的定义、创建和使用

1，注解概述

什么是注解：Annotation注解，是一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次

对比注释：

​ 注释是给程序员看的，注解是给程序看的。（注解不会影响代码的正常执行）

注解的作用：

​ 主要用于取代 XML 和 properties 配置文件

2，JDK提供的注解

注解	说明
@Deprecated	表示被修饰的方法已经过时。过时的方法不建议使用，但仍可以使用
@Override	JDK5.0 表示复写父类的方法；jdk6.0 还可以表示实现接口的方法
@SuppressWarnings	表示抑制警告，被修饰的类或方法如果存在编译警告，将被编译器忽略

3，@SuppressWarnings的参数

参数	说明
deprecation	或略过时
rawtypes	忽略类型安全
unused	忽略不使用
unchecked	忽略安全检查
null	忽略空指针
all	忽略所有

4，定义注解，使用@interface关键字

public @interface Zfwy {
   
}

4.1，定义带有属性的注解

public @interface Zfwy {
    String name() default "子非我鱼";
}

属性格式：修饰符 返回值类型 属性名() [default 默认值]

1. 修饰符：默认值 public abstract ，且只能是 public abstract。
2. 返回值类型：基本类型、字符串 String、Class、注解、枚举，以及以上类型的一维数组
3. 属性名：自定义
4. default 默认值：可以省略

4.2，完整示例

public @interface MyAnno {
    int age() default 1;
    String password();
    Class myqin();  // 类
    Zfwy zfwy();    // 注解
    Color color();  // 枚举
    String[] aggs(); // 数组
}

enum Color {
    RED,
    BLUE;
}

5，注解的使用

使用格式：@注解类名( 属性名= 值 , 属性名 = 值 , …)

    @MyAnno(age = 22,password = "zfwy",myqin = Myqxin.class,zfwy = @Zfwy,color = Color.BLUE,aggs = {"itcast","itcatstow"})
    @Override
    public void say(){
        System.out.println("冷言说这个方法重写了");
    }

注解使用的注意事项：
注解可以没有属性，如果有属性需要使用小括号括住。例如：@Zfwy 或 @Zfwy()
属性格式：属性名=属性值，多个属性使用逗号分隔。例如：@Zfwy(name=“子非我鱼”)
如果属性名为 value，且当前只有一个属性，value 可以省略。

如果属性类型为数组，值有多个时，需要加{} 。例如：arrs = {“itcast”,“ithermy”}
如果属性类型为数组，值只有一个时，{} 可以省略的。例如：arrs = “itcast”
一个内容上，注解只能使用一次，不能重复使用。

6，自定义注解：解析

如果给类、方法等添加注解，一般都需要获取注解上设置的数据，那么我们必须对注解进行解析。
JDK 提供 java.lang.reflect.AnnotatedElement 接口允许在运行时通过反射获得注解。

方法	说明
boolean isAnnotationPresent(Class annotationClass)	判断当前对象是否有注解
T getAnnotation(Class annotationClass)	获得当前对象上指定的注解
Annotation[] getAnnotations()	获得当前对象及其从父类上继承的，所有的注解
Annotation[] getDeclaredAnnotations()	获得当前对象上所有的注解

7，测试

User.java

@MyAnno(age = 22,password = "zfwy",myqin = Myqxin.class,zfwy = @Zfwy,color = Color.BLUE,aggs = {"itcast","itcatstow"})
public class User {
}

使用

public class Demo01 {
    public static void main(String[] args) {
        // 查看User类上是否有 MyAonn注解
        boolean b = User.class.isAnnotationPresent(MyAnno.class);
        // 结果为false
        System.out.println(b);
    }
}

当运行上面程序后，我们希望输出结果是 true，但实际是 false。
虽然类上有@MyAnno1 注解，但运行后不能获得。
因为每一个自定义注解，需要定义元注解进行修饰后，才可以真正的解析使用。

8，定义元注解

元注解：用于修饰注解的注解。（用于修饰自定义注解的 JDK 提供的注解）
JDK 提供 4 种元注解：

@Retention 用于确定被修饰的自定义注解生命周期

RetentionPolicy.SOURCE： 被修饰的注解只能存在源码中，字节码 class 没有。
RetentionPolicy.CLASS ： 被修饰的注解只能存在源码和字节码中，运行时内存中没有。
RetentionPolicy.RUNTIME ：被修饰的注解存在源码、字节码、内存（运行时）。

@Target 用于确定被修饰的自定义注解 使用位置

ElementType.TYPE 修饰 类、接口
ElementType.CONSTRUCTOR 修饰构造
ElementType.METHOD 修饰方法
ElementType.FIELD 修饰字段

@Documented 使用 javaDoc 生成 api 文档时，是否包含此注解 (了解)

@Inherited 如果父类使用被修饰的注解，子类是否继承。（了解）

注解	说明
Retention	指示注释类型的注释要保留多久
Target	指示注释类型所使用的程序元素的种类
Documented	指示某一类型的注释将通过javadoc和类似的默认工具进行文档化
Inherited	指示注释类型被自动继承
枚举	说明
RetentionPolicy	注释保留策略
ElementType	程序元素类型

9，修改MyAnno注解类

@Retention(RetentionPolicy.RUNTIME) // 运行时测试实例
public @interface MyAnno {
    int age() default 1;
    String password();
    Class myqin();  // 类
    Zfwy zfwy();    // 注解
    Color color();  // 枚举
    String[] aggs(); // 数组
}

enum Color {
    RED,
    BLUE;
}

重新使用

public class Demo01 {
    public static void main(String[] args) {
        // 查看User类上是否有 MyAonn注解
        boolean b = User.class.isAnnotationPresent(MyAnno.class);
        // 结果为true
        System.out.println(b);
    }
}

10，测试案例：模拟@Test注解

10.1，注解类@MyTest

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyTest {
}

10.2，目标类AnnotationDemo.java

public class AnnotationDemo {

    @MyTest
    public void run1(){
        System.out.println("run1方法执行了。。。");
    }

    @MyTest
    public void run2(){
        System.out.println("run2方法执行了。。。");
    }

    public void run3(){
        System.out.println("run3方法执行了。。。");
    }
}

10.3，测试方法

 public static void AnnotationTest() {
        // 获取类对象
        Class<AnnotationDemo> aClass = AnnotationDemo.class;
        // 获取实例对象
        try {
            AnnotationDemo annotationDemo = aClass.newInstance();
            // 获取目标类中所有方法
            Method[] methods = aClass.getMethods();
            // 遍历所有方法
            for (Method method : methods) {
                // 判断方法是否有@MyTest注解
                boolean flag = method.isAnnotationPresent(MyTest.class);
                if (flag) {
                    // 如果有这个注解，执行
                    method.invoke(annotationDemo);
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

结语：以上就是这次的内容，大致介绍了什么是注解，创建注解，注解的使用。有不足的地方，大佬们指点指点，加油！