java基础语法（四十一）—注解（二）

注解的概述

注释：用文字描述程序，给程序员看的。
注解：说明程序的，给计算机看的。
*定义:注解(Annotation)，也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性。与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元秦进行说明，注释。
*概念描述︰
*JDK1.5之后的新特性
*说明程序的
*使用注解︰@注解名称
*作用分类∶
1.编写文档:通过代码里标识的注解生成文档【生成文档doc文档]】
2.代码分析:通过代码里标识的注解对代码进行分析【使用反射】
3.编译检查∶通过代码里标识的注解让编译器能够实现基本的编译检查(override)

JDK中预定义的一些注解

	@Override:检测被该注解标注的方法是否是继承自父类（接口）的
	@Deprecated：将该注解标注的内容已经过时
	@SuppressWarnings：压制警告
	一般传递参数all  @SuppressWarnings("all")

自定义注解
格式：

		元注解
			Public @interface 注解名称{}
		本质：注解本质上就是一个接口，该接口默认继承Annotation接口
			public interface com.company.annotation.MyAnno extends java.lang.annotation.Annotation { }

/**
 * 注解javadoc演示
 * @author itcat
 * @version 1.0
 * @since 1.5
 */
public class AnnoDemo01 {
    /**
     * 计算两数的和
     * @param a 整数
     * @param b 整数
     * @return 两数的和
     */
    public int add(int a,int b){
        return a+b;
    }
    
}

public class AnnoDemo02 {
    @Override
    public String toString() {
        return super.toString();
    }

    @Deprecated
    public void show1(){
        //有缺陷
    }


    @MyAnno2
    public void show2(){
        //替代show1方法
    }

    public void demo(){
        show1();
    }
}

自定义注解-属性定义

• 自定义注解
• 格式

•  元注解
  

•  Public @interface 注解名称{
  

•      属性列表;
  

•  }
  

• 本质：注解本质上就是一个接口，该接口默认继承Annotation接口

•  *public interface com.company.annotation.MyAnno extends java.lang.annotation.Annotation { }
  

• 属性：接口中的抽象方法

•  要求：
  

•      1.属性的返回值类型有下列取值
  

•          基本数据类型
  

•          String
  

•          枚举
  

•          注解
  

•          以上类型的数组
  

•       2.定义了属性，在使用时需要给属性赋值
  

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

•           2.如果只有一个属性需要赋值，并且属性的名称是value,则value可以省略，直接定义值即可
  

•           3.数组赋值时，值使用{}包裹。如果数组中只有一个值，则{}可以省略
  

枚举类型：Person

package com.company.annotation;

public enum Person {
    p1,p2
}

注解类型：

public @interface MyAnno2 {
}

@MyAnno( value = 1,per = Person.p1,anno2 = @MyAnno2,strs = {"abc","bcd"})
public class Worker {
}

public @interface MyAnno {
    //public abstract String name() default "张三";
    int value();
    Person per();//枚举类型
    MyAnno2 anno2();//注解类型
    String[] strs();

    //int show1();


//

}

自定义注解-元注解

• 元注解:用于描述注解的注解
• @Target :描述注解能够作用的位置

•      ElementType取值:
         TYPE:可以作用于类上
         METHOD:可以作用于方法上
         FIELD：可以作用于成员变量上
  

• @Retention:描述注解被保留的阶段

•      @Retention(RetentionPolicy.RUNTIME)：当前被描述的注解会保留到class字节码文件中，并被JVM读取到
  

• @Documented:描进注解是否被抽取到api文档中
• @Inherited :描述注解是否被子类继承

@Target(value = {ElementType.TYPE})//表示该MyAnno3注解只能作用在类上
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface MyAnno3 {
}

注解-解析注解

public class Demo1 {
    public void show(){
        System.out.println("Demo1...show...");
    }
}

public class Demo2 {
    public void show(){
        System.out.println("Demo2...show...");
    }
}

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 描述需要执行的类名和方法名
 */

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface pro {
    String className();
    String methodName();
}

package com.company.annotation;

import java.io.InputStream;
import java.lang.reflect.Method;
import java.util.Properties;

/**
 * 框架类
 */

@pro(className = "com.company.annotation.Demo1",methodName = "show")
public class ReflectTest {
    public static void main(String[] args) throws  Exception {
        //可以创建任意类的对象，可以执行任意方法

        /*
            前提：不能改变该类的任何代码，可以创建任意类的对象，可以执行任意方法
         */

        //1.解析注解
        //1.1 获取该类的字节码文件对象
        Class<ReflectTest> reflectTestClass=ReflectTest.class;
        //2.获取上边的注解对象

        /*
            public class proImpl implements pro{
                public String className( ){
                    return "cn.itcast.annotation . Demo1" ;
                    }
                public String methodName(){
                    return "show" ;
                    }
                }

         */
        pro an=reflectTestClass.getAnnotation(pro.class);//其实就是在内存中生成了一个该注解接口的子类实现对象
        //3.调用注解中定义的抽象方法，获取返回值
        String className=an.className();
        String methodName=an.methodName();
        System.out.println(className);
        System.out.println(methodName);

        //4.加载该类进内存
        Class cls=Class.forName(className);
        //5.创建对象
        Object obj=cls.newInstance();
        //6.获取方法对象
        Method method=cls.getMethod(methodName);
        //7.执行方法
        method.invoke(obj);



    }
}

简单的测试框架

定义注解

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 {
}

定义计算的类，进行加减乘除

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......");
    }

}

• 简单的测试框架

   当主方法执行后，会自动检测所有的方法（加了check注解的方法），判断方法是否有异常，记录到文件当中
  

*/

package com.company.annotation.demo;

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


public class TestCheck {
    public static void main(String[] args) throws IOException {
        //1.创建计算器对象
        Calculator c=new Calculator();
        //2.获取字节码文件对象   一般创建对象用来直接调用该对象需要的方法，但是这里是获得所有的方法，所以可以通过获取字节码文件对象来获得
        Class<? extends Calculator> 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)){
                //5.有，执行
                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();
                    //e.printStackTrace();
                }
            }
        }
        bw.write("本次测试一共出现"+number+"次异常");
        bw.flush();
        bw.close();
}
}

运行之后，bug.txt记录的内容：

div方法出异常了
异常的名称:ArithmeticException
异常的原因:/ by zero
----------------------------------
本次测试一共出现1次异常