首页 > 编程语言 >Java注解​

Java注解​

时间：2023-10-17 20:02:52浏览次数：41  
标签：Java String value class 修饰 注解 Annotation

Java注解

学习目录：

  • 注解(Annotation)概述
  • 常见的Annotation示例
  • 自定义Annotation
  • JDK中的元注解
  • 利用反射获取注解信息（在反射部分涉及）

1、注解概述

从 JDK 5.0 开始，Java 增加了对元数据(MetaData) 的支持，也就是Annotation(注解)

Annotation 其实就是代码里的特殊标记，这些标记可以在编译，类加载，运行时被读取，并执行相应的处理。通过使用，程序员可以在不改变原有逻辑的情况下，在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。

Annotation 可以像修饰符一样被使用，可用于修饰包、类、构造器、方法、成员变量、参数、局部变量的声明，这些信息被保存在 Annotation的 “name=value” 对中。

在JavaSE中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在JavaEE/Android中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替JavaEE旧版中所遗留的繁冗代码和XML配置等。

未来的开发模式都是基于注解的，JPA是基于注解的，Spring2.5以上都是基于注解的，现在的MyBatis有一部分也是基于注解的了，注解是一种趋势，一定程度上可以说：框架 = 注解 + 反射 + 设计模式。

2、常见的Annotation示例

使用 Annotation 时要在其前面增加 @ 符号, 并把该 Annotation 当成一个修饰符使用。用于修饰它支持的程序元素

示例一：生成文档相关的注解

@author 标明开发该类模块的作者，多个作者之间使用,分割

  • @version 标明该类模块的版本
  • @see 参考转向，也就是相关主题
  • @since 从哪个版本开始增加的
  • @param 对方法中某参数的说明，如果没有参数就不能写
  • @return 对方法返回值的说明，如果方法的返回值类型是void就不能写
  • @exception 对方法可能抛出的异常进行说明 ，如果方法没有用throws显式抛出的异常就不能写其中
  • @param @return 和 @exception 这三个标记都是只用于方法的。
  • @param的格式要求：@param 形参名 形参类型 形参说明
  • @return 的格式要求：@return 返回值类型 返回值说明
  • @exception的格式要求：@exception 异常类型 异常说明
  • @param和@exception可以并列多个举例

package com.demo01;
/**
* @author Jack
* @version 1.0
*/
public class JavaDocTest {
/**
 * 程序的主方法，程序的入口
 * @param args String[] 命令行参数
*/
public static void main(String[] args) {}
/**
 * 求圆面积的方法
 * @param radius double 半径值
* @return double 圆的面积
*/
public static double getArea(double radius) {
return Math.PI * radius * radius;
}
}

通过IDEA工具生成api帮助文档

Java注解​_java


Java注解​_Java_02


Java注解​_java_03


示例二：在编译时进行格式检查(JDK内置的三个基本注解)

  • @Override: 限定重写父类方法, 该注解只能用于方法
  • @Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
  • @SuppressWarnings: 抑制编译器警告代码

package com.demo01;
public class AnnotationTest {
public static void main(String[] args) {
// @SuppressWarnings("unused")
int a = 10;
}
@Deprecated
public void print() {
System.out.println("过时的方法");
}
@Override
public String toString() {
return "重写的toString方法()";
}
}

示例三：跟踪代码依赖性，实现替代配置文件功能

Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署。

Java注解​_java_04


Java注解​_Java_05


3、自定义注解

  • 定义新的 Annotation 类型使用 @interface关键字
  • 自定义注解自动继承了java.lang.annotation.Annotation接口
  • Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组。
  • 可以在定义Annotation的成员变量时为其指定初始值, 指定成员变量的初始值可使用default关键字
  • 如果只有一个参数成员，建议使用参数名为value
  • 如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认值。格式是“参数名 = 参数值” ，如果只有一个参数成员，且名称为value，可以省略“value=”
  • 没有成员定义的 Annotation 称为标记；包含成员变量的 Annotation 称为元数据 Annotation 注意：自定义注解必须配上注解的信息处理流程才有意义。

package com.demo01;

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.TYPE)
@interface MyAnnotation {
String value() default "data";
}


package com.demo01;

import java.lang.annotation.Annotation;

@MyAnnotation(value = "测试自定义注解")
public class MyAnnotationTest {
public static void main(String[] args) {
Class clazz = MyAnnotationTest.class;
Annotation a = clazz.getAnnotation(MyAnnotation.class);
MyAnnotation m = (MyAnnotation) a;
String info = m.value();
System.out.println(info);
}
}

4、JDK 中的元注解

  • JDK 的元 Annotation 用于修饰其他 Annotation 定义
  • JDK5.0提供了4个标准的meta-annotation类型，分别是：
  • Retention
  • Target
  • Documented
  • Inherited


@Retention: 只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 的生命周期, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用 @Rentention 时必须为该 value 成员变量指定值:

RetentionPolicy.SOURCE:在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注释

RetentionPolicy.CLASS:在class文件中有效（即class保留），当运行 Java 程序时, JVM 不会保留注解。这是默认值

RetentionPolicy.RUNTIME:在运行时有效（即运行时保留），当运行 Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释。

Java注解​_Java_06


Java注解​_Java_07


Java注解​_成员变量_08


@Target: 用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于修饰哪些程序元素。 @Target 也包含一个名为 value 的成员变量。

Java注解​_成员变量_09


@Documented: 用于指定被该元 Annotation 修饰的 Annotation 类将被 javadoc 工具提取成文档。默认情况下，javadoc是不包括注解的。

定义为Documented的注解必须设置Retention值为RUNTIME。

@Inherited:被它修饰的 Annotation 将具有继承性。如果某个类使用了被 @Inherited 修饰的 Annotation, 则其子类将自动具有该注解。

比如：如果把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解

实际应用中，使用较少

利用反射获取注解信息

  • JDK 5.0 在 java.lang.reflect 包下新增了 AnnotatedElement 接口, 该接口代表程序中可以接受注解的程序元素
  • 当一个 Annotation 类型被定义为运行时 Annotation 后, 该注解才是运行时可见, 当 class 文件被载入时保存在 class 文件中的 Annotation 才会被虚拟机读取
  • 程序可以调用 AnnotatedElement对象的如下方法来访问 Annotation 信息

Java注解​_java_10




标签：Java,String,value,class,修饰,注解,Annotation
From： https://blog.51cto.com/u_16230968/7908667

相关文章

  • java处理显示clob字段内容
    可以直接通过clob的提供的方法进行处理，非常的方便，但是一定要注意判空，通过下面的这种方式处理，即使有换行、空格等特殊字符出现的时候，都能够原模原样的保存到新的字段当中比如判空处理dataMap.get("clobcloumn")==null?"":StringUtils.substring(ComUtils.clobToString((C......
  • java配置环境变量
    为啥要配置环境变量？？我们在终端使用的各种命令，都是在系统的环境变量中去寻找可执行文件；所以我们安装好java环境后，需要将java配置到系统的环境变量中；这样下次在命令行使用java命令的时候就可以直接找到，不需要使用绝对位置命令了。怎么配置环境变量？？linux系统：在终端家目录下找到.ba......
  • 【JVM】Java 的类加载机制
    目录字节码类加载过程LoadingVerificationPreparationResolutionInitialization类加载器双亲委派模型字节码Java源文件通过编译后，就会生成字节码：类加载过程Java的类加载过程可以分为5个阶段：载入、验证、准备、解析和初始化。这5个阶段一般是顺序发生的，但在动态绑定的......
  • java链表详解 理论+代码+图示
    1、定义链表是一种物理存储结构上非连续存储结构，数据元素的逻辑顺序是通过链表中的引用链接次序实现的。（即链表是一个个节点组成的，这些节点物理上不连续，但逻辑上连续）一个节点就是一个Node对象。2、链表结构单向、双向；带头、不带头；循环、非循环； 以上情况组......
  • JavaScript中'??'和'?.'
     ??空值合并运算符判断一直变量是否为'null'/'undefined'，进行不同的返回值处理console.log(1??2)//1console.log(null??2)//2console.log(undefined??2)//2console.log(1??2??3)//1console.log(null??2??3)//2console.log(null??null??3)//3......
  • Java中::的用法
    “::”是Java8引入的新特性之一，常常被称作为方法引用，提供了一种不执行方法的方法。使用“::”可以进一步简化一些使用了lambda表达式的代码，让代码更加简洁。用法1：省略lamda表达式publicclassTest01{publicstaticvoidmain(String[]args){String[]array......
  • Java开发到部署：从代码到上线的完整指南
    在软件开发领域中，Java一直是最流行和广泛使用的编程语言之一。Java的跨平台性以及强大的生态系统使其成为许多开发人员的首选。本文将介绍Java开发到部署的完整过程，帮助您了解如何将Java应用程序从代码编写到成功部署和上线。1、环境设置在开始Java开发之前，您需要安装JavaDevelo......
  • java基础，java基本数据类型、引用数据类型
    java数据类型基本数据类型：1，整型：byte（1字节），short（2字节），int（4字节），long（8字节）2，浮点型：float（单精度4字节），double（双精度8字节）3，字符型：char（2字节）4，布尔型：boolean（true/false）引用数据类型：1，类class引用例如Object:Object是一个很重要的类，Object是类层次结构的根类，每个类都使用Object作为......
  • JavaScript的数字运算不准的问题
    JavaScript的运算问题存在两方面：第一个表示不准问题：打开浏览器按F12，在Console里，输入0.1+0.2=0.30000000000000004输入91.25*0.7=63.87499999999999 解决这个问题，要用第三方库math.js或decimal.js constmath=require('mathjs');console.log(math.add(0.1,0.2));......
  • iframe实现与父页面跨域隔离的JavaScript 代码沙箱
    这篇文章主要介绍了使用iframe实现与父页面跨域隔离的JavaScript代码沙箱，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪目录正文1.iframe2.dataURL3.将JavaScript代码变成dataURL4.如果需要获取执行结果的话，基于postMessage定制通信机制正文假......

赞助商

阅读排行

网站主页关于我们联系我们网站地图

本网站内容转载自其他媒体，侵权联系[admin##ips99.com]。

Copyright © 2020-2023 IPS99 版权所有 IPS99