当前位置：文档之家 › 深入理解JAVA：注解(ANNOTATION)自定义注解入门

深入理解JAVA：注解(ANNOTATION)自定义注解入门

  • 格式：pdf
  • 大小：150.60 KB
  • 文档页数：7

深入理解Java：注解（Annotation）自定义注解入门要深入学习注解，我们就必须能定义自己的注解，并使用注解，在定义自己的注解之前，我们就必须要了解Java为我们提供的元注解和相关定义注解的语法。

元注解：元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它annotation类型作说明。Java5.0定义的元注解：1.@Target,2.@Retention,3.@Documented,4.@Inherited这些类型和它们所支持的类在java.lang.annotation包中可以找到。下面我们看一下每个元注解的作用和相应分参数的使用说明。

@Target：

@Target说明了Annotation所修饰的对象范围：Annotation可被用于packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。

作用：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）取值(ElementType)有：1.CONSTRUCTOR:用于描述构造器

2.FIELD:用于描述域

3.LOCAL_VARIABLE:用于描述局部变量

4.METHOD:用于描述方法

5.PACKAGE:用于描述包

6.PARAMETER:用于描述参数

7.TYPE:用于描述类、接口(包括注解类型)或enum声明

使用实例：

@Target(ElementType.TYPE)public@interfaceTable{/***数据表名称注解，默认值为类名称*@return*/publicStringtableName()default"className";}@Target(ElementType.FIELD)public@interfaceNoDBColumn{

}

注解Table可以用于注解类、接口(包括注解类型)或enum声明,而注解NoDBColumn仅可用于注解类的成员变量。

@Retention：@Retention定义了该Annotation被保留的时间长短：某些Annotation仅出现在源代

码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。使用这个meta-Annotation可以对Annotation的“生命周期”限制。

作用：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效）

取值（RetentionPoicy）有：1.SOURCE:在源文件中有效（即源文件保留）2.CLASS:在class文件中有效（即class保留）3.RUNTIME:在运行时有效（即运行时保留）

Retentionmeta-annotation类型有唯一的value作为成员，它的取值来自

java.lang.annotation.RetentionPolicy的枚举类型值。具体实例如下：

@Target(ElementType.FIELD)@Retention(RetentionPolicy.RUNTIME)public@interfaceColumn{publicStringname()default"fieldName";publicStringsetFuncName()default"setField";publicStringgetFuncName()default"getField";publicbooleandefaultDBValue()defaultfalse;}

Column注解的的RetentionPolicy的属性值是RUTIME,这样注解处理器可以通过反射，

获取到该注解的属性值，从而去做一些运行时的逻辑处理

@Documented:@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共

API，因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。

@Target(ElementType.FIELD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic@interfaceColumn{publicStringname()default"fieldName";publicStringsetFuncName()default"setField";publicStringgetFuncName()default"getField";publicbooleandefaultDBValue()defaultfalse;}

@Inherited：

@Inherited元注解是一个标记注解，@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类。

注意：@Inheritedannotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation，方法并不从它所重载的方法继承annotation。

当@Inheritedannotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME，则反射API增强了这种继承性。如果我们使用java.lang.reflect

去查询一个@Inheritedannotation类型的annotation时，反射代码检查将展开工作：检查class和其父类，直到发现指定的annotation类型被发现，或者到达类继承结构的顶层。

实例代码：

/****@authorpeida**/@Inheritedpublic@interfaceGreeting{publicenumFontColor{BULE,RED,GREEN};Stringname();FontColorfontColor()defaultFontColor.GREEN;}

自定义注解：使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。

定义注解格式：public@interface注解名{定义体}

注解参数的可支持数据类型：1.所有基本数据类型（int,float,boolean,byte,double,char,long,short)2.String类型3.Class类型4.enum类型5.Annotation类型6.以上所有类型的数组

Annotation类型里面的参数该怎么设定:第一,只能用public或默认(default)这两个访问权修饰.例如,Stringvalue();这里把方法设为defaul默认类型；第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,Stringvalue();这里的参数成员就为String;第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号.例:下面的例子FruitName注解就只有一个参数成员。

简单的自定义注解和使用注解实例：

packageannotation;importjava.lang.annotation.Documented;importjava.lang.annotation.ElementType;importjava.lang.annotation.Retention;importjava.lang.annotation.RetentionPolicy;importjava.lang.annotation.Target;

/***水果名称注解

*@authorpeida**/@Target(ElementType.FIELD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic@interfaceFruitName{

合集下载

Java Annotation 入门

Java Annotation 入门

Java Annotation 入门[关于Annotation 的翻译]这是语言学家需要做的事，但考虑到语言学家对这个领域不太关注。

还是自己先分析一下吧。

英文中的Comment 和Annotation 对应的中文翻译都是“注释、注解”,但个人感觉，Comment 更适合翻译成“注释”不仅因为已经广泛使用的，而且从意义上说，更接近。

个人以为，“Annotation”更接近“标记”这个含义，但是，XML 技术已经把“Markup”赋予这个词并广泛使用。

另一个“Annotation”接近的词是“Description”，描述或者说明。

但感觉这个词太泛泛。

想来想去，还是用原词吧！[历史]Java 平台原来就有一些类似Annotation 的机制，例如，Java 关键字transient 告诉Java 运行环境，持久化这个类时，这个变量是个例外。

javadoc标记@deprecated 告诉Java 编译器和运行时一旦有谁使用了这个API，你要报一个警告。

JCP 组织早在2002 年就把Annotation (被称为metadata) 作为JSR 175 引入了，并在2004 年9 月批准。

在Java 语言第三版中，正式加入了这个语言新特性的支持，并在JDK 1.5 发布。

在JDK 1.5 中，临时性的引入了apt 这个工具提供编译时的相关处理。

随后，JSR 269 标准化了Annotation 的处理过程，定义了一套annotation 处理API。

并在JDK 1.6 的javac编译器中集成了这个功能。

[什么是Annotation]情况1：我们在编写某些应用时，需要编写一组固定模式的代码，例如，JAX-RPC web 服务，你必须提供一个接口定义和一个与之对应的实现类（的框架）。

情况2：我们在开发EJB 时，除了要编写EJB 的接口代码和实现代码，还要编写与之配套的XML 格式的描述文件。

无论情况1中的接口和实现类的匹配使用，还是情况2中的代码和描述的配合使用，手工的方式是低效和容易出错的，不易维护。

Annotation(注解)

Annotation(注解)


基本Annotation
使用Annotation时要在其前面增加@符号，并把Annotation 当成一个修饰符使用，用于修饰它支持的程序元素 三个基本的Annotation： @Override @Deprecated @SuppressWarnings 注意：这三个基本的Annotation都定义在ng包下
抑制编译程序警告@SuppressWarnings
• • 对编译程序说明某个方法中若有警告讯息，则加以抑制 //关闭整个类里的编译器警告
• @SuppressWarnings（value="unchecked"） • public class SuppressWarningsTest{ • public static void main(String[] args){ • list<String>myList=new ArrayList(); • } • }
总结：@SuppressWarnings上一个有参数的Annotation，使用时必须指明参数， 一定要在括号里使用name=value来为该Annotation的成员变量设置值。即抑 制的警告种类在参数中指明
自定义Annotation类型
• • • • • 定义新的Annotation类型使用@interface关键字，不定义接口非常相似 //定义一个简单的Annotation类型 public @interface Test{ } 使用Annotation时的语法非常类似于public final这样的修饰符，通常可用于修饰程 序中的类、方法、变量、接口等。 //使用@Test修饰类定义 @Test //通常放在第一行； public class Person{ ............. } 默认情况下,Annotation可用于修饰任何程序元素，包括类，接口，方法等 public class Person{ @Test public void say(){ ...................... } }
注解Annotation原理详解及其应用示例

注解Annotation原理详解及其应用示例

注解Annotation原理详解及其应⽤⽰例⼀、什么是注解 注解也叫元数据，例如我们常见的@Override和@Deprecated，注解是JDK1.5版本开始引⼊的⼀个特性，⽤于对代码进⾏说明，可以对包、类、接⼝、字段、⽅法参数、局部变量等进⾏注解。

「ng.annotation.Annotation」接⼝中有这么⼀句话，⽤来描述『注解』。

The common interface extended by all annotation types所有的注解类型都继承⾃这个普通的接⼝（Annotation） 看⼀个 JDK 内置注解的定义：@Target(ElementType.METHOD)@Retention(RetentionPolicy.SOURCE)public @interface Override {} 这是注解 @Override 的定义，其实它本质上就是：public interface Override extends Annotation{} 注解的本质就是⼀个继承了 Annotation 接⼝的接⼝。

⼀个注解准确意义上来说，只不过是⼀种特殊的注释⽽已，如果没有解析它的代码，它可能连注释都不如。

⽽解析⼀个类或者⽅法的注解往往有两种形式：⼀种是编译期直接的扫描，⼀种是运⾏期反射。

编译器的扫描指的是编译器在对 java 代码编译字节码的过程中会检测到某个类或者⽅法被⼀些注解修饰，这时它就会对于这些注解进⾏某些处理。

典型的就是注解 @Override，⼀旦编译器检测到某个⽅法被修饰了 @Override 注解，编译器就会检查当前⽅法的⽅法签名是否真正重写了⽗类的某个⽅法，也就是⽐较⽗类中是否具有⼀个同样的⽅法签名。

这⼀种情况只适⽤于那些编译器已经熟知的注解类，⽐如JDK 内置的⼏个注解，⽽你⾃定义的注解，编译器是不知道你这个注解的作⽤的，当然也不知道该如何处理，往往只是会根据该注解的作⽤范围来选择是否编译进字节码⽂件，仅此⽽已。

java 入参注解

java 入参注解

java 入参注解在Java中，注解（Annotation）是一种特殊的注释，可以用于为代码提供额外的元数据信息。

通过使用注解，开发人员可以在代码中嵌入有关代码行为、约束条件、警告等额外的信息。

这些信息可以在编译时、运行时或开发时被编译器、解释器或其他工具使用，以执行各种操作或检查。

在Java中，注解通常用于以下目的：1.参数注解：用于为方法的参数添加额外的信息或约束。

通过在参数上使用注解，可以向编译器或其他工具提供有关参数的期望类型、有效性条件或其他限制的信息。

这对于验证参数的有效性、执行参数转换或执行其他操作非常有用。

例如，假设我们有一个方法需要一个表示日期的参数，我们可以在参数上使用注解来指定日期格式的期望格式：java复制代码public void processDate(@Format("yyyy-MM-dd") Date date) {// 方法实现}在上述代码中，@Format注解用于指定date参数应该遵循的日期格式。

这样，如果传递给方法的日期格式不符合指定的格式，编译器或运行时环境可以发出警告或错误。

1.类注解：用于为类添加元数据信息，例如标记为某个特定角色、约束条件或其他属性。

类注解可以用于向编译器或其他工具提供有关类的额外信息，以便在编译时或运行时执行特定操作或检查。

例如，我们可以使用自定义注解来标记一个类作为某个特定角色的实例：java复制代码@Role(name = "Admin")public class User {// 类定义}在上述代码中，@Role注解用于指定User类扮演的角色。

这样，我们可以使用该注解来筛选、过滤或识别具有特定角色的对象。

这只是注解的基本用法示例。

在实际开发中，注解可以用于各种不同的用途，例如配置、依赖注入、日志记录等。