前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >注解:为计算机而做的注释

注解:为计算机而做的注释

作者头像
BWH_Steven
发布2019-08-09 15:40:44
7050
发布2019-08-09 15:40:44
举报
文章被收录于专栏:理想二旬不止

(一) 基本概述

  • 概念:注解是用来说明程序的,可以简单理解为给计算机看的
  • 注释:用文字描述程序的。这是给程序员看的
  • 定义:注解(Annotation),也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性,与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面,用来对这些元素进行说明,注释
  • 使用注解:@注解名称

(二) 作用分类

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

(三) JDK中预定义的注解

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

(四) 自定义注解

(1) 格式
代码语言:javascript
复制
public @interface 注解名称{
        属性列表;
    }
(2) 本质

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

代码语言:javascript
复制
public interface MyAnno extends java.lang.annotation.Annotation {}
(3) 属性

要求:

  1. 属性的返回值类型有下列取值
    • 基本数据类型
    • String
    • 枚举
    • 注解
    • 以上类型的数组
  2. 定义了属性,在使用时需要给属性赋值
    • 如果定义属性时,使用default关键字给属性默认初始化值,则使用注解时,可以不进行属性的赋值
    • 如果只有一个属性需要赋值,并且属性的名称是value,则value可以省略,直接定义值即可
    • 数组赋值时,值使用{}包裹。如果数组中只有一个值,则{}可以省略
(4) 元注解
  • @Target:描述注解能够作用的位置
  • ElementType取值:
    • TYPE:可以作用于类上
    • METHOD:可以作用于方法上
    • FIELD:可以作用于成员变量上
  • @Retention:描述注解被保留的阶段
  • @Retention(RetentionPolicy.RUNTIME):当前被描述的注解,会保留到class字节码文件中,并被JVM读取到
  • @Documented:描述注解是否被抽取到api文档中
  • @Inherited:描述注解是否被子类继承

(五) 注解的应用和案例

(1) 在程序使用(解析)注解:获取注解中定义的属性值

代码语言:javascript
复制
package cn.ideal.annotation;

public class Demo1 {
    public void show(){
        System.out.println("This is Demo1");
    }
}
代码语言:javascript
复制
package cn.ideal.annotation;

public class Demo2 {
    public void show(){
        System.out.println("This is Demo2");
    }
}
代码语言:javascript
复制
package cn.ideal.annotation;

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();
}
代码语言:javascript
复制
package cn.ideal.annotation;

@Pro(className = "cn.ideal.annotation.Demo1", methodName = "show")
public class ReflectTest {
    public static void main(String[] args) {
        /*
            不改变该类的任何代码,可以创建任意类的对象,可以执行任意方法
         */

        //解析注解

        //获取该类的字节码文件对象
        Class<ReflectTest> reflectTestClass = ReflectTest.class;
        //获取上面的注解对象
        //其实就是在内存中生成了一个该注解接口的子类实现对象

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

         */

        Pro an = reflectTestClass.getAnnotation(Pro.class);
        //调用注解对象中定义的抽象方法,获取返回值
        String className = an.className();
        String methodName = an.methodName();
        System.out.println(className);
        System.out.println(methodName);
    }
}

(2) 自定义注解,检测并且输出异常到外部文件

代码语言:javascript
复制
package cn.ideal.annotation.demo;

/**
 * 自己定义的计算器类,存在一些错误
 */
public class Calculator {

    //加法
    @Check
    public void add() {
        String str = null;
        str.toString();
        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...");
    }

}
代码语言:javascript
复制
package cn.ideal.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 {
}
代码语言:javascript
复制
package cn.ideal.annotation.demo;

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

public class TestCheck {
    public static void main(String[] args) throws IOException {
        //创建计算器对象
        Calculator c = new Calculator();
        //获取字节码文件对象
        Class cls = c.getClass();
        //获取所有方法
        Method[] methods = cls.getMethods();

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

        for (Method method : methods) {
            //判断方法上是否有Check注解
            if (method.isAnnotationPresent(Check.class)) {
                //有,执行
                try {
                    method.invoke(c);
                } catch (Exception e) {
                    //捕获异常

                    //记录到文件中
                    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();
    }
}

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2019-07-30,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 理想二旬不止 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • (一) 基本概述
  • (二) 作用分类
  • (三) JDK中预定义的注解
  • (四) 自定义注解
    • (1) 格式
      • (2) 本质
        • (3) 属性
          • (4) 元注解
          • (五) 注解的应用和案例
          相关产品与服务
          腾讯云代码分析
          腾讯云代码分析(内部代号CodeDog)是集众多代码分析工具的云原生、分布式、高性能的代码综合分析跟踪管理平台,其主要功能是持续跟踪分析代码,观测项目代码质量,支撑团队传承代码文化。
          领券
          问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档