java注解（Annotation）是个什么东西，有什么用？

2023-08-12 00:10| 来源: 网络整理| 查看: 265

一、什么是注解注解可以理解成一个标签，是给类、方法、变量、属性等加标签；这个标签还会有一些限制因素，java设计出元注解来产生这些限制因素，元注解也是标签，只是这些标签是来描述注解的原始标签。元注解如下：

1、标签（注解）的存活时间

@Retention取值如下：

RetentionPolicy.SOURCE 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。 RetentionPolicy.CLASS 注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。 RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们。

@Documented：

它的作用是能够将注解中的元素包含到 Javadoc 中去。

@Target

@Target 指定了注解运用的地方；类比到标签，原本标签是你想张贴到哪个地方就到哪个地方，但是因为 @Target 的存在，它张贴的地方就非ElementType.ANNOTATION_TYPE 可以给一个注解进行注解 ElementType.CONSTRUCTOR 可以给构造方法进行注解 ElementType.FIELD 可以给属性进行注解 ElementType.LOCAL_VARIABLE 可以给局部变量进行注解 ElementType.METHOD 可以给方法进行注解 ElementType.PACKAGE 可以给一个包进行注解 ElementType.PARAMETER 可以给一个方法内的参数进行注解 ElementType.TYPE 可以给一个类型进行注解，比如类、接口、枚举

@Inherited

Inherited 是继承的意思，但是它并不是说注解本身可以继承，而是说如果一个超类被 @Inherited 注解过的注解进行注解的话，那么如果它的子类没有被任何注解应用的话，那么这个子类就继承了超类的注解。

二、注解有什么用？

官方解释：

注解是一系列元数据，它提供数据用来解释程序代码，但是注解并非是所解释的代码本身的一部分。注解对于代码的运行效果没有直接影响。

1、提供信息给编译器：编译器可以利用注解来探测错误和警告信息

比如 @Override提示子类要复写父类中被修饰的方法

2、编译阶段时的处理：软件工具可以用来利用注解信息来生成代码、Html文档或者做其它相应处理。 3、运行时的处理：某些注解可以在程序运行的时候接受代码的提取

注解主要针对的是编译器和其它工具软件；当开发者使用了Annotation 修饰了类、方法、Field 等成员之后，这些 Annotation 不会自己生效，必须由开发者提供相应的代码来提取并处理 Annotation 信息。这些处理提取和处理 Annotation 的代码统称为 APT（Annotation Processing Tool)。现在，我们可以给自己答案了，注解有什么用？给谁用？给编译器或者 APT 用的。

三：注解的使用案例

我要写一个测试框架，测试程序员的代码有无明显的异常。

—— 程序员 A : 我写了一个类，它的名字叫做 NoBug，因为它所有的方法都没有错误。 —— 我：自信是好事，不过为了防止意外，让我测试一下如何？ —— 程序员 A: 怎么测试？ —— 我：把你写的代码的方法都加上 @Jiecha 这个注解就好了。 —— 程序员 A: 好的 --------------------- Nobug.java

package com.example.lwy.nestedscrolldemo.annotation; public class NoBug { @Jiecha public void suanShu() { System.out.println("1234567890"); } @Jiecha public void jiafa() { System.out.println("1+1=" + 1 + 1); } @Jiecha public void jiefa() { System.out.println("1-1=" + (1 - 1)); } @Jiecha public void chengfa() { System.out.println("3 x 5=" + 3 * 5); } @Jiecha public void chufa() { System.out.println("6 / 0=" + 6 / 0); } public void ziwojieshao() { System.out.println("我写的程序没有 bug!"); } }

注解

package com.example.lwy.nestedscrolldemo.annotation; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; @Retention(RetentionPolicy.RUNTIME) public @interface Jiecha { }

测试类

package com.example.lwy.nestedscrolldemo.annotation; import java.lang.reflect.Method; public class TestTool { public static void main(String[] args) { NoBug testobj = new NoBug(); Class clazz = testobj.getClass(); Method[] method = clazz.getDeclaredMethods(); //用来记录测试产生的 log 信息 StringBuilder log = new StringBuilder(); // 记录异常的次数 int errornum = 0; for ( Method m: method ) { // 只有被 @Jiecha 标注过的方法才进行测试 if ( m.isAnnotationPresent( Jiecha.class )) { try { m.setAccessible(true); m.invoke(testobj, null); } catch (Exception e) { // TODO Auto-generated catch block //e.printStackTrace(); errornum++; log.append(m.getName()); log.append(" "); log.append("has error:"); log.append("\n\r caused by "); //记录测试过程中，发生的异常的名称 log.append(e.getCause().getClass().getSimpleName()); log.append("\n\r"); //记录测试过程中，发生的异常的具体信息 log.append(e.getCause().getMessage()); log.append("\n\r"); } } } log.append(clazz.getSimpleName()); log.append(" has "); log.append(errornum); log.append(" error."); // 生成测试报告 System.out.println(log.toString()); } }

测试的结果是

1234567890 1+1=11 1-1=0 3 x 5=15 chufa has error: caused by ArithmeticException / by zero NoBug has 1 error.

提示 NoBug 类中的 chufa() 这个方法有异常，这个异常名称叫做 ArithmeticException，原因是运算过程中进行了除 0 的操作。

所以，NoBug 这个类有 Bug。

这样，通过注解我完成了我自己的目的，那就是对别人的代码进行测试。

所以，再问我注解什么时候用？我只能告诉你，这取决于你想利用它干什么用。

秒懂，Java 注解（Annotation）你可以这样学

【本文地址】

公司简介

联系我们