Java自定义注解(使用篇)

 

TL;DR

Java 注解广泛运用在开发之中,用于增强变量/方法/类等。

尝试说明 Java 自定义注解的使用,以及通过开源项目中的使用进行说明。

本文主要记录个人的理解,全文基于Java SE8。

自定义注解

自定义注解分为两个部分:注解声明注解处理逻辑

每个注解可以有多个属性值,同名注解通过声明后可以在对象上使用多个。

注解结构

定义注解

用以下实例说明:

逐行分析一下。

@Repeatable(LearnRepeatableAnnotation.class) 表示本注解可以在一个对象上使用多次,具体内容下文会具体说明。

@Retention(RetentionPolicy.RUNTIME) 是一个元注解,表示注解可以在运行时通过反射使用,元注解下文会具体说明。

@Target({ElementType.FIELD, ElementType.LOCAL_VARIABLE, ElementType.METHOD}) 也是一个元注解,表示注解可以在属性、本地变量、方法上。

public @interface LearnAnnotation 表示这是一个注解声明,注解需要以@interface声明。

String value() default ""; 表示注解的值域是字符串类型,默认为空字符串。注解使用时,可以通过属性名=值的形式进行赋值,如果不声明属性名,说明会赋值到value属性上。注解中的属性名就是声明中的方法名。

String filedAnnotationValue() default ""; 表示自定义注解@LearnAnnotation有一个名为filedAnnotationValue的字符串属性,使用时可以通过@LearnAnnotation(filedAnnotationValue = "NAME")这一形式使用。

Class<?> className() default Void.class; 表示自定义注解@LearnAnnotation有一个名为className的Class对象,此处需要注意,自定义注解的属性值只能是基本类型(short/int/long/boolean/char/String/enum/Class等)以及他们这些类型的数组。

注解如果没有default声明的,需要指定属性值后才能使用。

同一对象使用多个相同的注解声明

还是使用上述案例,第一行@Repeatable(LearnRepeatableAnnotation.class)通过声明利用@LearnRepeatableAnnotation这一注解表示可以在一个对象上使用多个LearnAnnotation注解。

@LearnRepeatableAnnotation 的实现如下:

即需要声明一个新类型的注解,且这一注解的值,是计划使用多个注解的数组。

实际使用中可以像如下形式使用:

使用多个同名注解,例如作为配置规则,可以让当前对象获取多个规则。

注解声明

注解声明又主要分为两个部分:元注解注解名称及字段定义。

元注解

Java 中提供了4种元注解:

  • @Documented – 在JavaDoc中提供注解信息
  • @Retention – 注解的生效范围
  • @Target – 注解允许使用的对象
  • @Inherited – 注解是否可以被子类继承

元注解是实现自定义注解的重要工具,最重要的是@Retention@Target

元注解@Retention

元注解 @Retention 可以有如下3个属性值:

  • RetentionPolicy.SOURCE – 注解保留在源码中,编译阶段会被丢弃
  • RetentionPolicy.CLASS – 注解保留在.class文件中,但不会在运行时存在
  • RetentionPolicy.RUNTIME – 注解可以在运行时读取、使用反射可以获得

默认是RetentionPolicy.CLASS

在注解指定了 RetentionPolicy.SOURCE 的情况下,Java 编译源码时,会有一个注解处理阶段,会调用对应的注解处理器(继承自javax.annotation.processing.AbstractProcessor的子类),在编译时,可以执行注解的一些逻辑,例如生成代码

在 IDEA 中,如果是 maven 项目,可以通过项目配置指定注解处理器,也可以通过 maven-processor-plugin 实现

元注解@Target

元注解 @Target 可以有如下8个属性值:

  • ElementType.ANNOTATION_TYPE
  • ElementType.CONSTRUCTOR
  • ElementType.FIELD
  • ElementType.LOCAL_VARIABLE
  • ElementType.METHOD
  • ElementType.PACKAGE
  • ElementType.PARAMETER
  • ElementType.TYPE

作用范围看名称基本都能对应上。默认是全部。

开源项目中的使用

Fastjson

Fastjson 作为广泛使用的 Java JSON 解析类库,广泛应用了注解。

字段别名

POJO 中如果使用驼峰命名,但是 API 中需要使用下划线分隔,这样的场景并不少见。

Fastjson 中通过 @JSONField 注解可以实现这一功能。

Fastjson 通过 toJSONString() 方法实现对象转化到 JSON 格式字符串的行为,首先会根据转换对象的类型解析出对象各个字段的信息(参见com.alibaba.fastjson.util.FieldInfo),读取每个字段上的 @JSONField 注解,在转化为字符串过程中,当需要写入键时,如果注解 name 值存在,则写入 name 配置的值。

Spring

AOP

AOP 是常用的编程模式。

在 Spring 中定义一个 Aspect,通过 @Pointcut 注解关联何种对象的何种操作,通过 @Before/@After 等注解指定当前 Aspect 各个阶段可以执行的方法(Advice)。

Spring 框架在扫描各个 bean 时,会根据指定的 Aspect 信息,为各个 bean 的指定方法关联上各个 Advice,在执行时逐个运行。

Lombok

Java 开发中对象的 Getter/Setter 方法以及常规的构造方法让代码变得臃肿,Lombok 通过注解的方式,在编译阶段修改 AST,实现生成的 class 文件中带有对应的方法。

以上内容还可以另起篇幅详细说明。

参考

发表评论

电子邮件地址不会被公开。 必填项已用*标注

*

您可以使用这些HTML标签和属性: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code class="" title="" data-url=""> <del datetime=""> <em> <i> <q cite=""> <strike> <strong> <pre class="" title="" data-url=""> <span class="" title="" data-url="">

This site uses Akismet to reduce spam. Learn how your comment data is processed.