"一、注解定义 JVM5.0 定义了 4 个标准的元注解： @Target, @Retention, @Documented @Inherited 1. @Target 作用：用于描述注解的使用范围取值 ElementType 有： CONSTRUCTOR: 用于描述构造器 FIELD: 用于描述域 ...."

someone1
AI专业者开发社区 1 号成员
AI开发者社区 • 0 回帖 • 6 浏览 • 5 个月前

Java注解学习

一、注解定义

JVM5.0 定义了 4 个标准的元注解：

@Target,
@Retention,
@Documented
@Inherited

1. @Target

作用：用于描述注解的使用范围
取值 ElementType 有：

CONSTRUCTOR: 用于描述构造器
FIELD: 用于描述域
LOCAL_VARIABLE: 用于描述局部变量
METHOD: 用于描述方法
PACKAGE: 用于描述包
PARAMETER: 用于描述参数
TYPE: 用于描述类、接口 (包括注解类型) 或 enum 声明

举例：

@Target(ElementType.TYPE)
public @interface Table {
    /**
     * 数据表名称注解，默认值为类名称
     * @return
     */
    public String tableName() default "className";
}
@Target(ElementType.FIELD)
public @interface NoDBColumn {
}

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

2. @Retention

作用：用于描述注解的生命周期
取值 RetentionPolicy 有：

SOURCE: 在源文件中有效（即源文件保留）
CLASS: 在 class 文件中有效（即 class 保留）
RUNTIME: 在运行时有效（即运行时保留）

举例：

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
    public String name() default "fieldName";
    public String setFuncName() default "setField";
    public String getFuncName() default "getField"; 
    public boolean defaultDBValue() default false;
}

Column 注解的的 RetentionPolicy 的属性值是 RUNTIME, 这样注解处理器可以通过反射，获取到该注解的属性值，从而去做一些运行时的逻辑处理

3. Documented

作用：用于描述其它类型的 annotation 应该被作为被标注的程序成员的公共 API，因此可以被例如 javadoc 此类的工具文档化。Documented 是一个标记注解，没有成员。

举例：

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Column {
    public String name() default "fieldName";
    public String setFuncName() default "setField";
    public String getFuncName() default "getField"; 
    public boolean defaultDBValue() default false;
}

4. @Inherited

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

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

当 Inherited annotation 类型标注的 annotation 的 Retention 是 RetentionPolicy.RUNTIME，则反射 API 增强了这种继承性。如果我们使用 java.lang.reflect 去查询一个 Inherited annotation 类型的 annotation 时，反射代码检查将展开工作：检查 class 和其父类，直到发现指定的 annotation 类型被发现，或者到达类继承结构的顶层。

实例代码：

@Inherited
public @interface Greeting {
    public enum FontColor{ BULE,RED,GREEN};
    String name();
    FontColor fontColor() default FontColor.GREEN;
}

5. 自定义注解

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

定义注解格式：

public @interface 注解名（定义体）

注解参数的可支持数据类型：

所有基本数据类型（int,float,boolean,byte,double,char,long,short)
String 类型
Class 类型
enum 类型
Annotation 类型
以上所有类型的数组

自定义注解的定义和具体实现可以见下一章节。

二、注解实现

创建注解处理器，利用反射对注解加以处理。

AnnotatedElement 接口是所有程序元素（Class、Method 和 Constructor）的父接口，关于 AnnotatedElement 点详细信息可以参考

JavaDoc：Interface AnnotatedElement。

所以程序通过反射获取了某个类的 AnnotatedElement 对象之后，程序就可以调用该对象的如下四个个方法来访问 Annotation 信息：

方法 1：

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

返回改程序元素上存在的、指定类型的注解，如果该类型注解不存在，则返回 null。

方法 2：Annotation[] getAnnotations(): 返回该程序元素上存在的所有注解。
方法 3：boolean is AnnotationPresent(Class<?extends Annotation> annotationClass): 判断该程序元素上是否包含指定类型的注解，存在则返回 true，否则返回 false.
方法 4：Annotation[] getDeclaredAnnotations()：返回直接存在于此元素上的所有注释。与此接口中的其他方法不同，该方法将忽略继承的注释。（如果没有注释直接存在于此元素上，则返回长度为零的一个数组。）该方法的调用者可以随意修改返回的数组；这不会对其他调用者返回的数组产生任何影响。

举例：

注解声明

1.FruitName

package annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitName {
String value() default "";
}

2.FruitColor

package annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitColor {
public enum Color{BlUE, RED, GREEN};
Color fruitColor() default Color.GREEN;
}

3.FruitProvider

package annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitProvider {
public int id() default -1;
public String name() default "";
public String address() default "";
}

注解使用

package annotation;
import annotation.FruitColor.Color;
public class Apple {
@FruitName("Apple")
private String appleName;
<span class="hljs-meta">@FruitColor(fruitColor=Color.RED)</span>
<span class="hljs-keyword">private</span> String appleColor;

<span class="hljs-meta">@FruitProvider(id=1, name="红富士集团", address="红富士大厦")</span>
<span class="hljs-keyword">private</span> String appleProvider;

<span class="hljs-keyword">public</span> String <span class="hljs-title function_">getAppleName</span><span class="hljs-params">()</span> {
	<span class="hljs-keyword">return</span> appleName;
}

<span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title function_">setAppleName</span><span class="hljs-params">(String appleName)</span> {
	<span class="hljs-built_in">this</span>.appleName = appleName;
}

<span class="hljs-keyword">public</span> String <span class="hljs-title function_">getAppleColor</span><span class="hljs-params">()</span> {
	<span class="hljs-keyword">return</span> appleColor;
}

<span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title function_">setAppleColor</span><span class="hljs-params">(String appleColor)</span> {
	<span class="hljs-built_in">this</span>.appleColor = appleColor;
}

<span class="hljs-keyword">public</span> String <span class="hljs-title function_">getAppleProvider</span><span class="hljs-params">()</span> {
	<span class="hljs-keyword">return</span> appleProvider;
}

<span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title function_">setAppleProvider</span><span class="hljs-params">(String appleProvider)</span> {
	<span class="hljs-built_in">this</span>.appleProvider = appleProvider;
}

<span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title function_">display</span><span class="hljs-params">()</span>{
	System.out.println(<span class="hljs-string">"The fruit name is："</span> + appleName + <span class="hljs-string">", its color is: "</span> + appleColor + <span class="hljs-string">"."</span>);
}

}

注解实现

package annotation;
import java.lang.reflect.Field;
public class FruitInfoUtil {
public static void getFruitInfo(Class<?> clazz){
String strFruitName= "水果名称:";
String strFruitColor= "水果颜色:";
String strFruitProvider= "供应商信息:";
	Field[] fields = clazz.getDeclaredFields();
	
	<span class="hljs-keyword">for</span>(Field field : fields){
		<span class="hljs-keyword">if</span> (field.isAnnotationPresent(FruitName.class)){
			<span class="hljs-type">FruitName</span> <span class="hljs-variable">fruitName</span> <span class="hljs-operator">=</span> (FruitName)field.getAnnotation(FruitName.class);
			strFruitName += fruitName.value();
			System.out.println(strFruitName);
		}
		
		
		<span class="hljs-keyword">if</span> (field.isAnnotationPresent(FruitColor.class)){
			<span class="hljs-type">FruitColor</span> <span class="hljs-variable">fruitColor</span> <span class="hljs-operator">=</span> (FruitColor)field.getAnnotation(FruitColor.class);
			strFruitColor += fruitColor.fruitColor().toString();
			System.out.println(strFruitColor);
		}
		
		<span class="hljs-keyword">if</span> (field.isAnnotationPresent(FruitProvider.class)){
			<span class="hljs-type">FruitProvider</span> <span class="hljs-variable">fruitProvider</span> <span class="hljs-operator">=</span> (FruitProvider)field.getAnnotation(FruitProvider.class);
			strFruitProvider += <span class="hljs-string">" 供应商编号："</span> + fruitProvider.id() + <span class="hljs-string">" 供应商名称："</span> + fruitProvider.name() + <span class="hljs-string">" 供应商地址："</span> + fruitProvider.address();
			System.out.println(strFruitProvider);
		}
	}
}

}

执行结果：

水果名称: Apple
水果颜色: RED
供应商信息:  供应商编号：1 供应商名称：红富士集团 供应商地址：红富士大厦

三、注解基础知识点汇总

注解基础知识点汇总

Java注解学习

一、注解定义

1. @Target

2. @Retention

3. Documented

4. @Inherited

5. 自定义注解

二、注解实现

注解声明

注解使用

注解实现

三、注解基础知识点汇总

四、参考博客

相关帖子

随便看看

Java注解学习