← 返回学习路线

SYSTEM

注解

Java基础注解system
src/content/notes/system/注解.md

注解

概念

注解:类的组成部分,可以给类携带一些额外的信息,提供一种安全的类似注释标记的机制,用来将任何信息或元数据(metadata)与程序元素(类、方法、成员变量等)进行关联

  • 注解是给编译器或 JVM 看的,编译器或 JVM 可以根据注解来完成对应的功能
  • 注解类似修饰符,应用于包、类型、构造方法、方法、成员变量、参数及本地变量的声明语句中
  • 父类中的注解是不能被子类继承的

注解作用:

  • 标记
  • 框架技术多半都是在使用注解和反射,都是属于框架的底层基础技术
  • 在编译时进行格式检查,比如方法重写约束 @Override、函数式接口约束 @FunctionalInterface.

注解格式

定义格式:自定义注解用 @interface 关键字,注解默认可以标记很多地方

修饰符 @interface 注解名{
     // 注解属性
}

使用注解的格式:@注解名

@Book
@MyTest
public class MyBook {
    //方法变量都可以注解
}

@interface Book{
}
@interface MyTest{
}

注解属性

普通属性

注解可以有属性,属性名必须带 (),在用注解的时候,属性必须赋值,除非属性有默认值

属性的格式:

  • 格式 1:数据类型 属性名()
  • 格式 2:数据类型 属性名() default 默认值

属性适用的数据类型:

  • 八种数据数据类型(int,short,long,double,byte,char,boolean,float)和 String、Class
  • 以上类型的数组形式都支持
@MyBook(name="《精通Java基础》",authors = {"播仔","Dlei","播妞"} , price = 99.9 )
public class AnnotationDemo01 {
    @MyBook(name="《精通MySQL数据库入门到删库跑路》",authors = {"小白","小黑"} ,
     					price = 19.9 , address = "北京")
    public static void main(String[] args) {
    }
}
// 自定义一个注解
@interface MyBook{
    String name();
    String[] authors(); // 数组
    double price();
    String address() default "武汉";
}

特殊属性

注解的特殊属性名称:value

  • 如果只有一个 value 属性的情况下,使用 value 属性的时候可以省略 value 名称不写
  • 如果有多个属性,且多个属性没有默认值,那么 value 是不能省略的
//@Book("/deleteBook.action")
@Book(value = "/deleteBook.action" , age = 12)
public class AnnotationDemo01{
}

@interface Book{
    String value();
    int age() default 10;
}

元注解

元注解是 sun 公司提供的,用来注解自定义注解

元注解有四个:

  • @Target:约束自定义注解可以标记的范围,默认值为任何元素,表示该注解用于什么地方,可用值定义在 ElementType 类中:

    • ElementType.CONSTRUCTOR:用于描述构造器
    • ElementType.FIELD:成员变量、对象、属性(包括 enum 实例)
    • ElementType.LOCAL_VARIABLE:用于描述局部变量
    • ElementType.METHOD:用于描述方法
    • ElementType.PACKAGE:用于描述包
    • ElementType.PARAMETER:用于描述参数
    • ElementType.TYPE:用于描述类、接口(包括注解类型)或 enum 声明
  • @Retention:定义该注解的生命周期,申明注解的作用范围:编译时,运行时,可使用的值定义在 RetentionPolicy 枚举类中:

    • RetentionPolicy.SOURCE:在编译阶段丢弃,这些注解在编译结束之后就不再有任何意义,只作用在源码阶段,生成的字节码文件中不存在,@Override、@SuppressWarnings 都属于这类注解
    • RetentionPolicy.CLASS:在类加载时丢弃,在字节码文件的处理中有用,运行阶段不存在,默认值
    • RetentionPolicy.RUNTIME : 始终不会丢弃,运行期也保留该注解,因此可以使用反射机制读取该注解的信息,自定义的注解通常使用这种方式
  • @Inherited:表示修饰的自定义注解可以被子类继承

  • @Documented:表示是否将自定义的注解信息添加在 Java 文档中

public class AnnotationDemo01{
    // @MyTest // 只能注解方法
    private String name;

    @MyTest
    public static void main( String[] args) {
    }
}
@Target(ElementType.METHOD) // 申明只能注解方法
@Retention(RetentionPolicy.RUNTIME) // 申明注解从写代码一直到运行还在,永远存活!!
@interface MyTest{
}

注解解析

开发中经常要知道一个类的成分上面到底有哪些注解,注解有哪些属性数据,这都需要进行注解的解析

注解解析相关的接口:

  • Annotation:注解类型,该类是所有注解的父类,注解都是一个 Annotation 的对象
  • AnnotatedElement:该接口定义了与注解解析相关的方法
  • Class、Method、Field、Constructor 类成分:实现 AnnotatedElement 接口,拥有解析注解的能力

Class 类 API :

  • Annotation[] getDeclaredAnnotations():获得当前对象上使用的所有注解,返回注解数组
  • T getDeclaredAnnotation(Class<T> annotationClass):根据注解类型获得对应注解对象
  • T getAnnotation(Class<T> annotationClass):根据注解类型获得对应注解对象
  • boolean isAnnotationPresent(Class<Annotation> class):判断对象是否使用了指定的注解
  • boolean isAnnotation():此 Class 对象是否表示注释类型

注解原理:注解本质是特殊接口,继承了 Annotation ,其具体实现类是 Java 运行时生成的动态代理类,通过反射获取注解时,返回的是运行时生成的动态代理对象 $Proxy1,通过代理对象调用自定义注解(接口)的方法,回调 AnnotationInvocationHandler 的 invoke 方法,该方法会从 memberValues 这个 Map 中找出对应的值,而 memberValues 的来源是 Java 常量池

解析注解数据的原理:注解在哪个成分上,就先拿哪个成分对象,比如注解作用在类上,则要该类的 Class 对象,再来拿上面的注解

public class AnnotationDemo{
    @Test
    public void parseClass() {
        // 1.定位Class类对象
        Class c = BookStore.class;
        // 2.判断这个类上是否使用了某个注解
        if(c.isAnnotationPresent(Book.class)){
            // 3.获取这个注解对象
            Book b = (Book)c.getDeclarAnnotation(Book.class);
            System.out.println(book.value());
            System.out.println(book.price());
            System.out.println(Arrays.toString(book.authors()));
        }
    }
    @Test
    public void parseMethod() throws Exception {
        Class c = BookStore.class;
        Method run = c.getDeclaredMethod("run");
        if(run.isAnnotationPresent(Book.class)){
            Book b = (Book)run.getDeclaredAnnotation(Book.class);
           	sout(上面的三个);
        }
    }
}

@Book(value = "《Java基础到精通》", price = 99.5, authors = {"张三","李四"})
class BookStore{
    @Book(value = "《Mybatis持久层框架》", price = 199.5, authors = {"王五","小六"})
    public void run(){
    }
}
@Target({ElementType.TYPE,ElementType.METHOD}) // 类和成员方法上使用
@Retention(RetentionPolicy.RUNTIME) // 注解永久存活
@interface Book{
    String value();
    double price() default 100;
    String[] authors();
}

XML

概述

XML介绍:

  • XML 指可扩展标记语言(EXtensible Markup Language)
  • XML 是一种标记语言,很类似 HTML,HTML文件也是XML文档
  • XML 的设计宗旨是传输数据,而非显示数据
  • XML 标签没有被预定义,需要自行定义标签
  • XML 被设计为具有自我描述性,易于阅读
  • XML 是 W3C 的推荐标准

XML 与 HTML 的区别:

  • XML 不是 HTML 的替代,XML 和 HTML 为不同的目的而设计
  • XML 被设计为传输和存储数据,其焦点是数据的内容;XMl标签可自定义,便于阅读
  • HTML 被设计用来显示数据,其焦点是数据的外观;HTML标签被预设好,便于浏览器识别
  • HTML 旨在显示信息,而 XML 旨在传输信息

创建

person.xml

<?xml version="1.0" encoding="UTF-8"?>
<person id="110">
	<age>18</age>		<!--年龄-->
	<name>张三</name>	  <!--姓名-->
	<sex/>				<!--性别-->
</person>