java注解入门（学习笔记）

注解概述

• Java 注解 (Annotation）又称 Java 标注，是 JDK5.0引入的一种注释机制 。

• Java 语言中的类 、构造器 、方法 、成员变量 , 参数等都可以被注解进行标注 。

public class UserServiceTest{
    @Test 
    public void testLogin(){
    
    }
    @Test
    public void testChu(){
    
    }

注解的作用是什么呢 ？

• 对 Java 中类 、方法、成员变量做标记 ，然后进行特殊处理 ，至于到底做何种处理由业务需求来决定 。

• 例如：JUnit 框架中 ，标记了注解@Test的方法就可以被当成测试方法执行而没有标记的就不能当成测试方法执行 。

自定义注解

• 自定义注解就是自己做一个注解来使用。

public @interface 注解名称{
    
    public 属性类型 属性名（） default 默认值；
}

举个栗子

public @interface MyBook {
    String name();
    String[] authors();
    double price();
}

注解可以放在类，方法，属性上，如下

@MyBook(name= "《精通javaSE》",authors = {"无名氏","lei"},price = 199)
public class AnnotationDemo1 {

    @MyBook(name= "《精通javaSE2》",authors = {"无名氏","lei"},price = 199)
    public AnnotationDemo1() {
    }

    @MyBook(name= "《精通javaSE3》",authors = {"无名氏","lei"},price = 199)
    public static void main(String[] args) {
        @MyBook(name= "《精通javaSE4》",authors = {"无名氏","lei"},price = 199)
        int age = 20;
    }
}

特殊属性

• value 属性 ， 如果只有一个 value 属性的情况下，使用 value 属性的时候可以省略 value 名称不写 ！ ！

• 但是如果有多个属性 ，且多个属性没有默认值 ，那么 value 名称是不能省略的 。

举个栗子

public @interface Book {
    String value();//特殊属性
    double price() default 9.9;
}

//price有默认值，为9.9，且只有一个属性的情况，可省略value名称
@Book("class")
public class AnnotationDemo2 {
   @Book(value = "method",price = 12.3)
    public static void main(String[] args) {
        
    }
}

元注解

• 元注解 ： 就是注解注解的注解 。（套娃是吧）

元注解在Java5定义了4个注解：

@Target ： 约束自定义注解只能在些地方使用

• TYPE ：类，接口
• FIELD ： 成员变量
• METHOD ： 成员方法
• PARAMETER ：方法参数
• CONSTRUCTOR ：构造器
• LOCAL_VARIABLE ： 局部变量

@Retention ： 申明注解的生命周期

• SOURCE ： 注解只作用在源码阶段 ， 生成的字节码文件中不存在
• CLASS ： 注解作用在源码阶段 ， 字节码文件阶段@运行阶段不存在默认值 ，
• RUNTIME: 注解作用在源码阶段 ， 字节码文件阶段 ， 运行阶段 （ 开发常用 ）

@Documented ：一个标记注解，没有成员变量。

• @Documented 是一个标记注解，没有成员变量。用 @Documented 注解修饰的注解类会被 JavaDoc 工具提取成文档。默认情况下，JavaDoc 是不包括注解的，但如果声明注解时指定了 @Documented，就会被 JavaDoc 之类的工具处理，所以注解类型信息就会被包括在生成的帮助文档中。

@Inherited ： 一个标记注解，用来指定该注解可以被继承。

• @Inherited 是一个标记注解，用来指定该注解可以被继承。使用 @Inherited 注解的 Class 类，表示这个注解可以被用于该 Class 类的子类。就是说如果某个类使用了被 @Inherited 修饰的注解，则其子类将自动具有该注解。

注解解析

• 注解的操作中经常需要进行解析，注解的解析就是判断是否存在注解 , 存在注解就解析出内容 。

注解解析需要认识的接口

• Anonotation ： 注解的顶级接口注解都是 Annotation 类型的对象
• AnnotatedElement ： 该接口定义了与注解解析相关的解析方法

方法	说明
Annotation[] getDeclaredAnnotations()	获得当前对象上使用的所有注解，返回注解数组
T getDeclaredAnnotation(Class<T> annotationClass)	根据注解类型获得对应注解对象
boolean isAnnotationPresent (Class<Annotation> annotationClass)	判断当前对象是否使用了指定的注解，如果使用了则返回true，否则false

解析注解的技巧

• 注解在哪个成分上 ， 我们就先拿哪个成分对象 。
• 比如注解作用成员方法 ， 则要获得该成员方法对应的 Method 对象，再来拿上面的注解
• 比如注解作用在类上 ， 则要该类的 Class 对象 ， 再来拿上面的注解
• 比如注解作用在成员变量上 ， 则要获得该成员变量对应的 Field 对象 ， 再来拿上面的注解

举个栗子

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Book {
    String value();
    double price() default 100;
    String[] authors();
}

public class AnnotationDemo1 {
    @Test
    public void parseClass() throws NoSuchMethodException {
        //a1.先得到类对象
        Class c = BookStore.class;


        //b.判断这个类上面是否存在这个注释
        if(c.isAnnotationPresent(Book.class))
        {
            //c.直接获取该注释对象
            Book book =  (Book) c.getDeclaredAnnotation(Book.class);
            System.out.println(book.value());
            System.out.println(book.price());
            System.out.println(Arrays.toString(book.authors()));
        }
        
        //a2.得到方法（获取注解信息的步骤跟上面一样）
        Method m = c.getDeclaredMethod("test");
        if(m.isAnnotationPresent(Book.class))
        {
            Book book =  (Book) c.getDeclaredAnnotation(Book.class);
            System.out.println(book.value());
            System.out.println(book.price());
            System.out.println(Arrays.toString(book.authors()));
        }
    }
}
@Book(value = "西游记",price = 60,authors = {"吴承恩"})
class BookStore{

    @Book(value = "水浒传",price = 50,authors = "施耐庵")
    public void test(){

    }
}

西游记
60.0
[吴承恩]
西游记
60.0
[吴承恩]

注解的应用场景：Junit框架

直接上案例

需求

• 定义若干个方法 ， 只要加了注解@MyTest ， 就可以在启动时被触发执行

分析

• 定义一个自定义注解@MyTest, 只能注解方法存活范围是一直都在 。
• 定义若干个方法，只要有注解的方法就能在启动时被触发执行，没有这个注解的方法不能执行 。

@Target({ElementType.METHOD,ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyTest {
    public String value() default "注解";
}

public class AnnotationDemo {
//我只想执行test1（）和 test3（）方法
    @MyTest
    public void test1(){
        System.out.println("======test1========");
    }

    public void test2(){
        System.out.println("======test2========");
    }
    @MyTest
    public void test3(){
        System.out.println("======test3========");
    }

    /**
     * 启动菜单
     */
    public static void main(String[] args) throws InvocationTargetException, IllegalAccessException {
        AnnotationDemo a = new AnnotationDemo();
        
        //a.获取类对象
        Class c = AnnotationDemo4.class;

        //b.提取全部方法
        Method[] methods = c.getDeclaredMethods();
        
        //c.遍历方法，看是否有MyTest注解，有就跑它
        for (Method method : methods){
            if(method.isAnnotationPresent(MyTest.class)){
                //run 它
                method.invoke(a);
            }
        }
    }
}

======test3========
======test1========

完结撒花