Java高级编程--注解Annotation

2022-11-02 10:26:03

从JDK 5.0开始, Java增加了对元数据(MetaData)的支持, 也就是Annotation(注解)。注解在实际的开发中有很重要的实际意义，Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。

☍ 注解(Annotation)

Annotation可以像修饰符一样被使用, 可用于修饰包,类,构造器,方法,成员变量,参数,局部变量的声明,这些信息被保存在 Annotation的“name=value”对中。

▴ 注解(Annotation)概述

☄ 在JavaSE中，注解的使用目的比较简单，例如标记过时的功能@Deprecated，忽略警告@SuppressWarnings等。在JavaEE/Android中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替JavaEE旧版中所遗留的繁冗代码和XML配置等。

☄ 未来的开发模式都是基于注解的，JPA是基于注解的，Spring2.5以上都是基于注解的，Hibernate3.x以后也是基于注解的，Struts2有一部分也是基于注解的了，注解是一种趋势，一定程度上
可以说：框架 = 注解 + 反射 + 设计模式。

▴ 常见注解示例

▾ 示例一：生成文档相关的注解

说明：此类注解常用于类或方法的相关标注

注解 功能
@author 标明开发该类模块的作者,多个作者之间使用‘,’分割
@version 标明该类模块的版本
@see 参考转向，也就是相关主题
@since 从哪个版本开始增加的
aram 对方法中某参数的说明，如果没有参数就不能写
return 对方法返回值的说明，如果方法的返回值类型是void就不能写
exception 对方法可能抛出的异常进行说明 ，如果方法没有用throws显式抛出的异常就不能写其中

✦✦
@param @return 和@exception 这三个标记都是只用于方法的
@param的格式要求：@param 形参名 形参类型 形参说明
@return 的格式要求：@return 返回值类型 返回值说明
@exception的格式要求：@exception 异常类型异常说明
@param和@exception可以并列多个

Java高级编程--注解Annotation

▾ 示例二：在编译时进行格式检查(JDK内置的三个基本注解)

注解 功能
@Override 限定重写父类方法, 该注解只能用于方法
@Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构存在风险或有更好的选择
@SuppressWarnings 抑制编译器警告
Java高级编程--注解Annotation

▾ 示例三：跟踪代码依赖性，实现替代配置文件功能

☄ Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署

Java高级编程--注解Annotation

☄ Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署

☄ 框架使用注解简化开发流程

注解 功能
@Controller 标识一个该类是Spring MVC controller处理器，用来创建处理http请求的对象
@Service 用于标注业务层组件，即用注解的方式把这个类注入到spring配置中
@Repository 用于标注数据访问组件，即DAO组件
@Autowired 用来装配bean实例
@Component 泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注
@Required 适用于bean属性setter方法，并表示受影响的bean属性必须在XML配置文件在配置时进行填充。否则，容器会抛出一个BeanInitializationException异常
@Qualifier 如果容器中有多个相同类型的 bean，通过使用 @Qualifier 注解，我们可以消除需要注入哪个 bean 的问题

▴ 自定义 Annotation注解

1、定义新的 Annotation 类型使用 @interface 关键字

2、自定义注解自动继承了java.lang.annotation.Annotation 接口

3、Annotation的成员变量在 Annotation 定义中以无参数方法的形式来声明。其方法名和返回值类型定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String类型 、Class 类型 、enum 类型 、Annotation类型以及以上所有类型的数组。

4、可以在定义 Annotation 的成员变量时为其指定初始值, 可使用default关键字指定成员变量的初始

5、如果只有一个参数成员，建议使用参数名为value

6、如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认值。格式是@myannotation(参数1=参数值1,参数2=参数值2...)，如果只有一个参数成员，且名称为value，可以省略'value='直接使用@myannotation(参数值)

7、没有成员定义的Annotation称为标记; 包含成员变量的Annotation称为元数据Annotation

➥ 自定义注解必须配上注解的信息处理流程(使用反射)才有意义

@Inherited   //继承性
@Repeatable(MyAnnotations.class)  //可重复性,要与被关联的Annotations.class的Retention及Target保持一致，关联的成员为当前Annotation数组对象，否则编译报错
@Retention(RetentionPolicy.RUNTIME)   //指定该 Annotation的生命周期，默认为RetentionPolicy.CLASS
@Target({TYPE,FIELD,METHOD,PARAMETER,CONSTRUCTOR,LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
public @interface MyAnnotation {
    String value();
	//    String value() default "HELLO";  指定默认值形式
}


//测试
@MyAnnotation("测试注解")
public class AnnotationTest {
    public static void main(String[] args) {
        //获取注解信息
        Class clazz = AnnotationTest.class;
        MyAnnotation a1 = (MyAnnotation) clazz.getAnnotation(MyAnnotation.class);
        System.out.println(a1.value());    //输出：测试注解
    }
}

▴ JDK中的元注解

☄ JDK的元Annotation用于修饰其他Annotation定义

☄ JDK5.0提供了4个标准的meta-annotation类型，分别是：Retention、Target、Documented、Inherited

@Retention：用于指定Annotation的生命周期,所以只能用于修饰一个Annotation定义， @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用
@Rentention 时必须为该value成员变量指定值

➣ RetentionPolicy.SOURCE:在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注释(不编译改注释)

➣ RetentionPolicy.CLASS:在class文件中有效（即class保留）当运行Java程序时, 编译器会编译该注释，但JVM不会保留注解。这是默认值

➣ RetentionPolicy.RUNTIME:在运行时有效（即运行时保留），当行运行Java程序时,JVM会保留注释。程序可以通过反射获取该注释。自定义注解常用该模式

Java高级编程--注解Annotation
Java高级编程--注解Annotation

@Target：用于修饰 Annotation 定义,用于指定被修饰的Annotation能用于修饰哪些程序元素。@Target包含一个名为value[]的成员变量

Java高级编程--注解Annotation
类型 说明
TYPE 描述类、接口（包括注解类型）或emun声明
FIELD 用于描述域
PACKAGE 由于描述包
CONSTRUCTOR 用于描述构造器
METHOD 用于描述方法
PARAMETER 用于描述参数
LOCAL_VARIABLE 用于描述局部变量

@Documented：用于指定被该元 Annotation 修饰的 Annotation 类将被javadoc工具提取成文档。默认情况下，javadoc是不包括注解的

↪ 定义为Documented的注解必须设置Retention值为RUNTIME

@Inherited：被它修饰的Annotation将具有继承性。如果某个类使用了被@Inherited修饰的 Annotation,则其子类将自动具有该注解。如：把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解（实际使用较少）

▴ 利用反射获取注解信息

1、JDK5.0在java.lang.reflect包下新增了 AnnotatedElement接口,该接口代表程序中可以接受注解的程序元素

2、当一个Annotation类型被定义为运行时 Annotation 后, 该注解才是运行时可见,当class文件被载入时保存在class文件中的Annotation才会被虚拟机读取

3、程序可以调用AnnotatedElement对象的如下方法来访问 Annotation信息

Java高级编程--注解Annotation
@MyAnnotation("测试注解")
public class AnnotationTest {
    public static void main(String[] args) {
        //获取注解信息
        Class clazz = AnnotationTest.class;
        MyAnnotation a1 = (MyAnnotation) clazz.getAnnotation(MyAnnotation.class);
        System.out.println(a1.value());

        Class clazz2 = Person.class;
        Annotation annotation = clazz2.getAnnotation(MyAnnotations.class);
        MyAnnotations myAnnotation = (MyAnnotations)annotation;
        MyAnnotation[] a = myAnnotation.value();
        System.out.println(a[1].value());
    }
}

@MyAnnotation(value = "Person")
//当注解成员为单个且命名为value时，可省略value=
@MyAnnotation("Student")
//注解有多个成员时
@MyAnnotation2(name={"张明","小明"}, age=2) 
class Person{
    private String name;
    private int age;
    public Person(){}
    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }
    public void walk(){
        System.out.println("走路");
    }
}

/*可重复注解*/
@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE,FIELD,METHOD,PARAMETER,CONSTRUCTOR,LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
public @interface MyAnnotation {
    String value();
}

@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE,FIELD,METHOD,PARAMETER,CONSTRUCTOR,LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
public @interface MyAnnotations {
    MyAnnotation[] value();
}

//多个成员的注解
@Retention(RetentionPolicy.RUNTIME)   //指定该 Annotation的生命周期，默认为RetentionPolicy.CLASS
@Target({TYPE,FIELD,METHOD,PARAMETER,CONSTRUCTOR,LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
public @interface MyAnnotation2 {
    String[] name();
    int age();
}

▴ JDK8中注解的新特性

Java 8对注解处理提供了两点改进：可重复的注解及可用于类型的注解。此外，反射也得到了加强，在Java8中能够得到方法参数的名称。这会简化标注在方法参数上的注解

可重复注解(@Repeatable)：

@Inherited   //继承性
//可重复性,要与被关联的Annotations.class的Retention及Target保持一致，关联的成员为当前Annotation数组对象，否则编译报错
@Repeatable(MyAnnotations.class)  
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE,FIELD,METHOD,PARAMETER,CONSTRUCTOR,LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
public @interface MyAnnotation {
    String value();
}

@Inherited
@Retention(RetentionPolicy.RUNTIME) 
@Target({TYPE,FIELD,METHOD,PARAMETER,CONSTRUCTOR,LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
public @interface MyAnnotations {
    MyAnnotation[] value();  //注解类型对象
}

@MyAnnotation(value = "Person")
@MyAnnotation(value = "Human")
class Person{
    public void info(@MyAnnotation(value = "info") String info){
        /*....*/
    }
 	//......
}

类型注解：

JDK1.8之后，关于元注解@Target的参数类型ElementType枚举值多了两个：TYPE_PARAMETER,TYPE_USE

在Java8之前，注解只能是在声明的地方所使用，Java8开始，注解可以应用在任何地方

➣ ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中（如：泛型声明）

➣  ElementType.TYPE_USE表示该注解能写在使用类型的任何语句中

@MyAnnotation("类注解:类")
class Generic<@MyAnnotation("类型注解:泛型类") T>{
    public void method() throws @MyAnnotation("类型注解:异常信息") RuntimeException{
        ArrayList<@MyAnnotation("类型注解：集合") String> list = new ArrayList<>();
        int num = (@MyAnnotation("类型注解:强转")int)14L;
        @MyAnnotation("参数注解:参数")
        String str = "Hello World!";
    }
}

本博客与CSDN博客༺ཌ༈君☠纤༈ད༻同步发布

Java高级编程--注解Annotation
上一篇：注解与反射01-注解


下一篇：父类上的注解能被子类继承吗，接口上面的注解呢（转）