Java-注解

概念：说明程序的，给计算机看的
注释：用文字描述程序的，给程序员看的

定义：注解(Annotation) ，也叫元数据，一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。
概念描述：
	1.JDK1.5之后的特性
	2.说明程序
	3.使用注解：@注解名称= =

作用分类：
①编写文档：通过代码里标识的注解生成文档【生成文档doc文档】
② 代码分析：通过代码里标识的注解对代码进行分析【使用反射】
③编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查【Override】

主要学习：Jdk中预定义的一些注解
@Override：检测被该注解标注的方法是否是继承自父类(接口)的
@Deprecated：将该注解标注的内容，表示已过时
@SuppressWarnings：压制警告 一般传递参数all @SuppressWarnings(“all”)

自定义注解
格式：
元注解：
public @interface 注解名称{
属性列表；
}

	注解本质：本质就是一个接口，该接口默认继承Annotation 接口
				public interface MyAnno extends java.lang.annotation.Annotation {}
	属性：接口中可以定义的成员方法
			要求：
				1.属性的返回值类型有以下取值
						基本数据类型
						String
						枚举
						注解
						以上类型的数组

package cn.itcast.annotation;

public @interface MyAnno {
    public abstract String show();
    int show1();
    String show2();
    Person per();
    MyAnno2 anno2();

    String strs();

    //void show3();  错误
}

			2.定义了属性，在使用时需要给属性赋值
					1.如果定义属性时，使用default关键字给属性默认初始化值，则使用注解时，可以不进行注解的赋值

package cn.itcast.annotation;

public @interface MyAnno {
    /*public abstract String show();*/
    int age();
    String name();
    String sex() default "男";
    /*String show2();
    Person per();
    MyAnno2 anno2();

    String strs();

    //void show3();  错误*/
}

package cn.itcast.annotation;

@MyAnno(age = 12, name = "张三")
public class Worker {
}

					2.如果只有一个属性需要赋值，并且属性的名称是value，则value可以省略，直接定义即可
					3.数组赋值时，值使用{}包裹，如果数组中只有一个值，则{}可以省略

package cn.itcast.annotation;

public @interface MyAnno {
    /*public abstract String show();*/
    int value();
    /*String name();
    String sex() default "男";*/
    /*String show2();*/
    Person per();
    MyAnno2 anno2();

    String[] strs();

    //void show3();  错误*/
}

package cn.itcast.annotation;

@MyAnno(value = 12,per = Person.P1,anno2 = @MyAnno2,strs = {"abc","bc"})
public class Worker {
}

	元注解：用于描述注解的注解
			@Target：描述注解能够作用的位置
					ElementType取值：
						TYPE:可以作用于类上
						METHOD:可以作用于方法上
						FIELD:可以作用于成员变量上
			@Retention：描述注解被保留的阶段
					@Retention(RetentionPolicy.RUNTIME):当前被描述的注解，会保留到class字节码文件中，并被JVM读取到
			@Documented：描述注解是否被抽取到api文档中
			@Inherited：描述注解是否被子类继承  加了子类自动继承父类的注解

在程序中使用(解析)使用注解：获取注解中定义的属性值
1.获取注解定义的位置的对象(Class,Method,Field)
2.获取指定的注解
getAnnotation(Class)
//其实就是在内存中生成了一个该注解接口的子类实现对象
/*
public class ProImpl implements pro{
public String className(){
return “cn.itcast.annotation.Demo1”;
}
public String methodName(){
return “show”;
}
}
*/
3.调用注解中的抽象方法获取配置的属性值

小结：
1.大多数时候，我们会使用注解，而不是自定义注解
2.注解给谁用？
1.编译器
2.给解析程序用
3.注解不是程序的一部分，可以理解为注解就是一个标签

练习：

package cn.itcast.annotation.demo;

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)
public @interface Check {
}

package cn.itcast.annotation.demo;

/**
 *  定义的计算器类
 */
public class Calculator {

    //加法
    @Check
    public void add(){
        System.out.println("1+0="+(1+0));
    }
    //减法
    @Check
    public void sub(){
        System.out.println("1-0="+(1-0));
    }
    //乘法
    @Check
    public void mul(){
        System.out.println("1*0="+(1*0));
    }
    //除法
    @Check
    public void div(){
        System.out.println("1/0="+(1/0));
    }

    public void show(){
        System.out.println("永无bug...");
    }
}

package cn.itcast.annotation.demo;

import java.io.BufferedWriter;
import java.io.FileWriter;
import java.io.IOException;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

/**
 * 简单的测试框架
 *
 *  当主方法执行后，会自动自行被检测的所有方法(加了check注解的方法)，判断方法是否有异常，记录到文件中
 */
public class TestCheck {
    public static void main(String[] args) throws IOException {
        //1.创建计算器对象
        Calculator c = new Calculator();
        //2.获取字节码文件对象
        Class cls = c.getClass();
        //3.获取所有方法
        Method[] methods = cls.getMethods();

        int number = 0;//出现异常的次数
        BufferedWriter bw = new BufferedWriter(new FileWriter("bug.txt"));

        for (Method method : methods) {
            //4.判断方法上是否有check注解
            if (method.isAnnotationPresent(Check.class)){
                try {
                    method.invoke(c);
                } catch (Exception e) {
                    //6.捕获异常
                    //记录到文件中
                    number ++;

                    bw.write(method.getName()+ "方法出异常了");
                    bw.newLine();
                    bw.write("异常的名称："+e.getCause().getClass().getSimpleName());
                    bw.newLine();
                    bw.write("异常的原因："+e.getCause().getMessage());
                    bw.newLine();
                    bw.write("----------------------");
                    bw.newLine();
                }
            }
        }

        bw.write("本次测试一共出现"+number+" 次异常");
        bw.flush();
        bw.close();
    }
}