JAVA注解

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了JAVA注解，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含6924字，纯文字阅读大概需要10分钟。

内容图文

1 定义Annotation

定义新的Annotation类型使用@interface关键字（在原有interface关键字前增加@符号）。定义一个新的Annotation类型与定义一个接口很像，例如：

public @interface Test{
}

定义完该Annotation后，就可以在程序中使用该Annotation。使用Annotation，非常类似于public、final这样的修饰符，通常，会把Annotation另放一行，并且放在所有修饰符之前。例如：

@Test
public class MyClass{
....
}

1.1 成员变量

Annotation只有成员变量，没有方法。Annotation的成员变量在Annotation定义中以“无形参的方法”形式来声明，其方法名定义了该成员变量的名字，其返回值定义了该成员变量的类型。例如：

public @interface MyTag{
    string name();
    int age();
}

示例中定义了2个成员变量，这2个成员变量以方法的形式来定义。

一旦在Annotation里定义了成员变量后，使用该Annotation时就应该为该Annotation的成员变量指定值。例如：

public class Test{
    @MyTag(name="红薯"，age=30)
    public void info(){
    ......
    }
}

也可以在定义Annotation的成员变量时，为其指定默认值，指定成员变量默认值使用default关键字。示例：

public @interface MyTag{
    string name() default "我兰";
    int age() default 18;
}

如果Annotation的成员变量已经指定了默认值，使用该Annotation时可以不为这些成员变量指定值，而是直接使用默认值。例如：

public class Test{
    @MyTag
    public void info(){
    ......
    }
}

根据Annotation是否包含成员变量，可以把Annotation分为如下两类：

标记Annotation：没有成员变量的Annotation被称为标记。这种Annotation仅用自身的存在与否来为我们提供信息，例如@override等。
元数据Annotation：包含成员变量的Annotation。因为它们可以接受更多的元数据，因此被称为元数据Annotation。

2 提取Annotation信息（反射）

当开发者使用了Annotation修饰了类、方法、Field等成员之后，这些Annotation不会自己生效，必须由开发者提供相应的代码来提取并处理Annotation信息。这些处理提取和处理Annotation的代码统称为APT（Annotation Processing Tool）。

JDK主要提供了两个类，来完成Annotation的提取：

java.lang.annotation.Annotation接口：这个接口是所有Annotation类型的父接口（后面会分析Annotation的本质，Annotation本质是接口，而java.lang.annotation.Annotation接口是这些接口的父接口）。
java.lang.reflect.AnnotatedElement接口：该接口代表程序中可以被注解的程序元素。

2 提取Annotation信息（反射）

JDK主要提供了两个类，来完成Annotation的提取：

java.lang.annotation.Annotation接口：这个接口是所有Annotation类型的父接口（后面会分析Annotation的本质，Annotation本质是接口，而java.lang.annotation.Annotation接口是这些接口的父接口）。
java.lang.reflect.AnnotatedElement接口：该接口代表程序中可以被注解的程序元素。

2.1 java.lang.annotation.Annotation

java.lang.annotation.Annotation接口源码:

package java.lang.annotation;

public interface Annotation {

    boolean equals(Object obj);

    int hashCode();

    String toString();

    Class<? extends Annotation> annotationType();
}

java.lang.annotation.Annotation接口的主要方法是annotationType( )，用于返回该注解的java.lang.Class。

2.2 java.lang.reflect.AnnotatedElement

java.lang.reflect.AnnotatedElement接口源码：

package java.lang.reflect;

import java.lang.annotation.Annotation;

public interface AnnotatedElement {

     boolean isAnnotationPresent(Class<? extends Annotation> annotationClass);

    <T extends Annotation> T getAnnotation(Class<T> annotationClass);

    Annotation[] getAnnotations();

    Annotation[] getDeclaredAnnotations();
}

主要方法有：

isAnnotationPresent(Class<? extends Annotation> annotationClass)：判断该程序元素上是否存在指定类型的注解，如果存在则返回true，否则返回false。
getAnnotation(Class<T> annotationClass)：返回该程序元素上存在的指定类型的注解，如果该类型的注解不存在，则返回null
Annotation[] getAnnotations()：返回该程序元素上存在的所有注解。

java.lang.reflect.AnnotatedElement接口是所有程序元素（例如java.lang.Class、java.lang.reflect.Method、java.lang.reflect.Constructor等）的父接口。类图结构如下：

技术分享

所以程序通过反射获取了某个类的AnnotatedElement对象（例如，A类method1()方法的java.lang.reflect.Method对象）后，就可以调用该对象的isAnnotationPresent( )、getAnnotation( )等方法来访问注解信息。

为了获取注解信息，必须使用反射知识。

PS：如果想要在运行时提取注解信息，在定义注解时，该注解必须使用@Retention(RetentionPolicy.RUNTIME)修饰。

2.3 示例

2.3.1 标记Annotation

给定一个类的全额限定名，加载类，并列出该类中被注解@MyTag修饰的方法和没被修饰的方法。

注解定义：

package com.demo1;

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

}

注解处理：

package com.demo1;

import java.lang.reflect.Method;

public class ProcessTool {
	public static void process(String clazz) {
		Class targetClass = null;

		try {
			targetClass = Class.forName(clazz);
		} catch (ClassNotFoundException e) {
			e.printStackTrace();
		}

		for (Method m : targetClass.getMethods()) {
			if (m.isAnnotationPresent(MyTag.class)) {
				System.out.println("被MyTag注解修饰的方法名：" + m.getName());
			} else {
				System.out.println("没被MyTag注解修饰的方法名：" + m.getName());
			}
		}
	}
}

测试类：

package com.demo1;

public class Demo {
	public static void m1() {

	}

	@MyTag
	public static void m2() {

	}
}

package com.demo1;

public class Test {

	public static void main(String[] args) {
		ProcessTool.process("com.demo1.Demo");
	}
}

运行结果：

没被MyTag注解修饰的方法名：m1
被MyTag注解修饰的方法名：m2
没被MyTag注解修饰的方法名：wait
没被MyTag注解修饰的方法名：wait
没被MyTag注解修饰的方法名：wait
没被MyTag注解修饰的方法名：equals
没被MyTag注解修饰的方法名：toString
没被MyTag注解修饰的方法名：hashCode
没被MyTag注解修饰的方法名：getClass
没被MyTag注解修饰的方法名：notify
没被MyTag注解修饰的方法名：notifyAll

2.3.2 元数据Annotation

给定一个类的全额限定名，加载类，找出被注解MyTag修饰的方法，并输出每个方法的MyTag注解的属性。

注解定义：

package com.demo1;

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 MyTag {
	String name() default "我兰";

	int age() default 18;
}

注解处理：

package com.demo1;

import java.lang.reflect.Method;

public class ProcessTool {
	public static void process(String clazz) {
		Class targetClass = null;

		try {
			targetClass = Class.forName(clazz);
		} catch (ClassNotFoundException e) {
			e.printStackTrace();
		}

		for (Method m : targetClass.getMethods()) {
			if (m.isAnnotationPresent(MyTag.class)) {
				MyTag tag = m.getAnnotation(MyTag.class);
				System.out.println("方法" + m.getName() + "的MyTag注解内容为：" + tag.name() + "，" + tag.age());
			}
		}
	}
}

测试类：

package com.demo1;

public class Demo {
	public static void m1() {

	}

	@MyTag
	public static void m2() {

	}

	@MyTag(name = "红薯")
	public static void m3() {

	}

	@MyTag(name = "红薯", age = 30)
	public static void m4() {

	}
}

package com.demo1;

public class Test {

	public static void main(String[] args) {
		ProcessTool.process("com.demo1.Demo");
	}
}

运行结果：

方法m2的MyTag注解内容为：我兰，18
方法m3的MyTag注解内容为：红薯，18
方法m4的MyTag注解内容为：红薯，30

若要获取注解中的成员变量值，直接调用注解对象的"成员变量民( )"形式的方法就行，例如示例中的tag.name()等。

PS：在编译器编译注解定义时，自动在class文件中，添加与成员变量同名的抽象方法，用于反射时获取成员变量的值。

通过上面的示例可以看出，其实Annotation十分简单，它是对源代码增加的一些特殊标记，这些特殊标记可通过反射获取，当程序获取这些特殊标记后，程序可以做出相应的处理（当然也可以完全忽略这些Annotation）。

3 注解本质

对于示例”2.3.2 元数据Annotation“中的MyTag注解，在编译后，生成一个MyTag.class文件。反编译该class文件：

javap -verbose -c MyTag.class > m.txt

MyTag注解的字节码为：

技术分享

通过分析字节码可知：

注解实质上会被编译器编译为接口，并且继承java.lang.annotation.Annotation接口。
注解的成员变量会被编译器编译为同名的抽象方法。
根据Java的class文件规范，class文件中会在程序元素的属性位置记录注解信息。例如，RuntimeVisibleAnnotations属性位置，记录修饰该类的注解有哪些；flags属性位置，记录该类是不是注解；在方法的AnnotationDefault属性位置，记录注解的成员变量默认值是多少。

我们再反编译下示例”2.3.2 元数据Annotation“中的Demo测试类，查看下”被注解修饰的方法是怎样记录自己被注解修饰的“：

javap -verbose -c Demo.class > d.txt

反编译结果如下：

技术分享

通过字节码可知：

在字节码文件中，每个方法都有RuntimeVisibleAnnotations属性位置，用来放置注解和注解的成员变量赋值。JVM在解析class文件时，会解析RuntimeVisibleAnnotations属性，并新建相应类型的注解对象，并将成员变量赋值。

如果要明白JVM对注解的运行机制，需要对class文件的格式规范有一定了解。（资料）

4 注解的意义

为编译器提供辅助信息 — Annotations可以为编译器提供而外信息，以便于检测错误，抑制警告等.

编译源代码时进行而外操作 — 软件工具可以通过处理Annotation信息来生成原代码，xml文件等等.

运行时处理 — 有一些annotation甚至可以在程序运行时被检测，使用.

总之，注解是一种元数据，起到了”描述，配置“的作用。

原文：http://www.cnblogs.com/panxuejun/p/7071041.html

内容总结

以上是互联网集市为您收集整理的JAVA注解全部内容，希望文章能够帮你解决JAVA注解所遇到的程序开发问题。如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容，请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端

扫描二维码推送至手机访问。

本文链接：https://qyyshop.com/info/1291036.html

来源：【匿名】

【上一篇】Java学习的第六天【下一篇】JAVA/JSP学习系列之五

更多 ►

【JAVA注解】教程文章相关的互联网学习教程文章

1 定义Annotation定义新的Annotation类型使用@interface关键字（在原有interface关键字前增加@符号）。定义一个新的Annotation类型与定义一个接口很像，例如：public @interface Test{ }定义完该Annotation后，就可以在程序中使用该Annotation。使用Annotation，非常类似于public、final这样的修饰符，通常，会把Annotation另放一行，并且放在所有修饰符之前。例如：@Test public class MyClass{ .... }1.1 成员变量Annotation只有...

Java注解及反射得到注解【代码】【图】

Class类的方法f package com.part1; /*** * @author pc**/publicclass Student {publicint sid;publicchar sex;private String sname;private String password;private String cardno;privatedouble money;public Student() {}public Student(int sid, String sname, String password, String cardno,double money) {this.sid = sid;this.sname = sname;this.password = password;this.cardno = cardno;this.money = money;}publ...

java 注解的实现机制【代码】

一.什么是注解：注解是标记，也可以理解成是一种应用在类、方法、参数、属性、构造器上的特殊修饰符。注解作用有以下三种：第一种：生成文档，常用的有@param@return等。第二种：替代配置文件的作用，尤其是在spring等一些框架中，使用注解可以大量的减少配置文件的数量。第三种：检查代码的格式，如@Override，标识某一个方法是否覆盖了它的父类的方法。二.注解的底层实现原理：注解的底层也是使...

java自定义注解并解读【图】

不多说，先看例子，通过例子来说这个自定义注解。自己定义了一个注解类testType：package com.zhudan.test;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, ElementType.FIELD,ElementType.METHOD })public @interface testType {int length...

java注解@Valid@Validated表单验证【图】

1.分组验证，参数太多不想一一分组分组的类继承package javax.validation.groups 下的Default 分组验证遇到的坑2.@Valid和@Validated的区分@Validated是@Valid 的一次封装，是Spring提供的校验机制使用。@Valid不提供分组功能@Validated不提供嵌套验证功能。嵌套验证需要在对应的嵌套属性前加@Valid @Valid和@Validated的总结区分https://blog.csdn.net/gaojp008/article/details/80583301https://www.cnblogs.com/guchunchao/p/98...

Java基础13-注解和反射【代码】

Annotation注解与注释Comment区分Java注解用于为Java代码提供元数据。作为元数据，注解不直接影响你的代码执行，但也有一些类型的注解实际上可以用于这一目的。Java注解是从Java5开始添加到Java的。注解有三类：内置注解、自定义注解和元注解。内置注解就是java自带的注解，元注解是用于修饰注解的注解，使用元注解来定义自定义注解。内置注解@Overwrite：限定重写父类方法，该注解只能运用于方法 @Deprecated：用于表示某个程序元...

Java注解(1)-注解基础

注解（Annotation）是在JAVA5中开始引入的，它为在代码中添加信息提供了一种新的方式。注解在一定程度上把元数据与源代码文件结合在一起，正如许多成熟的框架（Spring）所做的那样。那么，注解到底可以做什么呢？1、注解的作用。提供用来完整地描述程序所需要的信息，如编译期校验程序信息。生成描述符文件，或生成新类的定义。减轻编写“样板”代码（配置文件）的负担，可以使用注解自动生成。更加干净易读的代码。编译期类型检查...

java--反射和注解【代码】

一、java.lang.reflect类 Class类1、反射机制（Reflection）：通过类创建对象，2、反射机制提供了如下功能: 在运行时，判断任意一个对象所属的类构造任意一个类的对象判断任意一个类所具有的成员变量和方法调用任意一个对象的方法生成动态代理例如连接数据库时数据处理动态获取数据类型的方式：getResource( ) toURI( ) getPath( ) 1)、getClass( )，用到Ob...

java spring - 自动装配Bean 注解大全

@Configuration 将一个类定义为Bean的配置类　　@Componet("userDao") 通过Repository定义一个DAO的bean　　　　等价于<bean id="userDao" class="com.ib.anno.UserDao"/>　　@Repository 用户对DAO实现类进行注解　　@Service 用户对Service实现类进行注解　　@Controller 用户对Controller实现类进行注解　　@Autowired 默认按类型匹配注入Bean，自动注入，默认情况下required为ture，要求一顶耀找到匹配的Bean，否则报NoSuch...

JAVA 注解

JAVA 注解的几大作用及使用方法详解转自http://blog.sina.com.cn/s/blog_93dc666c0101gzn5.htmljava 注解，从名字上看是注释，解释。但功能却不仅仅是注释那么简单。注解（Annotation）为我们在代码中添加信息提供了一种形式化的方法，是我们可以在稍后某个时刻方便地使用这些数据（通过解析注解来使用这些数据），常见的作用有以下几种：1.生成文档。这是最常见的，也是java 最早提供的注解。常用的有@see @param @return 等；...

java注解

注解相当于一种标记，在程序中加了注解就等于为程序打上了某种标记。程序可以利用java的反射机制来了解你的类及各种元素上有无何种标记，针对不同的标记，就去做相应的事件。标记可以加在包，类，字段，方法，方法的参数以及局部变量上。注解是通过@interface关键字定义出来的，和接口有一点点类似，就是没有具体函数或者方法的实现体，既然是可以定义的，你想让注解叫什么名字都可以的。注解分为三种，一般来讲我们使用的是运行时...

EasyExcel无法用转换器或者注解将java字段写入为excel的数值格式【代码】【图】

需求：在用easyExcel导出报表时，碰到需要将数据转换为数值or货币格式的需求过程：1.首先采取转换器的形式 @Overridepublic CellData convertToExcelData(BigDecimal bigDecimal, ExcelContentProperty excelContentProperty, GlobalConfiguration globalConfiguration) throws Exception {if (ObjectUtils.isEmpty(bigDecimal)) {bigDecimal=BigDecimal.ZERO;}CellData cellData = new CellData(new DecimalFormat("#,##0.00").f...

深入理解java：注解（Anotation）自定义注解【代码】【图】

要深入学习注解，我们就必须能定义自己的注解，并使用注解，在定义自己的注解之前,我们就必须了解java为我们提供的元注解和相关定义注解的语法。元注解：元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解：　　　　1.@Target,　　　　2.@Retention,　　　　3.@Documented,　　　　4.@Inherited　　这些类型和它们所支持的类在java....

java 自学简单框架（反射+注解）【图】

1、先定义一个学生类2、再定义一个teacher类（这个是为了练习多个注解，自己练习可以不写这个）3、再定义个一个学生老师类（这个是为了最终调用上面的那个学生类做准备）4、下面开始真正的写框架：先定义一个注解类5、reflect里面就是所有的逻辑了6、就是在main函数调用了：原文：https://www.cnblogs.com/yangcube/p/9184514.html

Java连载108-注解Override\Deprecated\SuppressWarnings【代码】【图】

一、Java注解1.引入起始：Java5.0开始引入；2.该功能可用于类、构造方法、成员变量、方法、参数3.注解功能的影响范围：不影响程序的正常执行，但是会对编译器等辅助工具产生影响。4.定义：注解又可以称为标注，是程序的元数据，也是程序代码的标记。5.获取方式：在编译、加载类和运行时。6.作用：使用反射功能，可以对程序代码进行分析；使用系统定义的注解，可以在编译的时候对程序进行检查；使用元注解，可以生成相应的文档。7. ...

JAVA - 技术教程分类

Java 教程 Java 简介 Java 开发环境配置 Java 基础语法 Java 对象和类 Java 基本数据类型 Java 变量类型 Java 修饰符 Java 运算符 Java 循环结构 Java 条件语句 Java switch case Java Number & Math 类 Java Character 类 Java String 类 Java StringBuffer Java 数组 Java 日期时间 Java 方法 Java Stream、File、IO Java Scanner 类 Java 异常处理 Java 继承 Java Override/Overload Java 多态 Java 抽象类 Java 封装 Java 接口 Java 枚举 Java 包(package) Java 数据结构 Java 集合框架 Java ArrayList Java LinkedList Java HashSet Java HashMap Java Iterator Java Object Java 泛型 Java 序列化 Java 网络编程 Java 多线程编程 Java Applet 基础 Java 文档注释 Java 实例 Java 8 新特性 Java MySQL 连接 Java 9 新特性 Java 测验 java 全部

JAVA - 最热教程

Java在运行项目时候，点击右键的弹框，...nacos配置中心超时问题：java.net.Conn...Java的设计模式（7）— 生产者-消费者模...基于DOM4j和POI实现的XML文件转换为XLS...如何在Java中创建一些变量类型别名使用java8的Stream统计字符串数组中每一...idea插件篇之java内存分析工具(JProfil...cannot cast 'java.lang.Integer' to '...java – Bootstrap.properties中Spring...Java8利用stream流实现数字排序和中文排...

首页 / JAVA / JAVA注解

JAVA注解

内容导读

内容图文

内容总结

内容备注

内容手机端

【JAVA注解】教程文章相关的互联网学习教程文章

JAVA注解【代码】【图】

Java注解及反射得到注解【代码】【图】

java 注解的实现机制【代码】

java自定义注解并解读【图】

java注解@Valid@Validated表单验证【图】

Java基础13-注解和反射【代码】

Java注解(1)-注解基础

java--反射和注解【代码】

java spring - 自动装配Bean 注解大全

JAVA 注解

java注解

EasyExcel无法用转换器或者注解将java字段写入为excel的数值格式【代码】【图】

深入理解java：注解（Anotation）自定义注解【代码】【图】

java 自学简单框架（反射+注解）【图】

Java连载108-注解Override\Deprecated\SuppressWarnings【代码】【图】

JAVA - 技术教程分类

JAVA - 最新教程

JAVA - 最热教程