java：@Repeatable注解使用

最新推荐文章于 2024-08-17 07:09:30 发布
最新推荐文章于 2024-08-17 07:09:30 发布
阅读量2.5k 收藏 10
点赞数 3
CC 4.0 BY-SA版权
分类专栏： Java 文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/a232884c/article/details/124827155
本文介绍了Java8的@Repeatable注解的使用，通过示例展示了如何创建可重复注解以及如何在代码中处理这些注解，解释了@Repeatable注解的作用以及其实现原理。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

java：@Repeatable注解使用

1 前言

java8新增了注解@Repeatable，在hibernate-validator的源码注解如@MAX、@NotNull等中，有@Repeatable注解的使用，源码示例如下：

/*
 * Jakarta Bean Validation API
 *
 * License: Apache License, Version 2.0
 * See the license.txt file in the root directory or <http://www.apache.org/licenses/LICENSE-2.0>.
 */
package javax.validation.constraints;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.CONSTRUCTOR;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import javax.validation.Constraint;
import javax.validation.Payload;
import javax.validation.constraints.NotNull.List;

/**
 * The annotated element must not be {@code null}.
 * Accepts any type.
 *
 * @author Emmanuel Bernard
 */
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Repeatable(List.class)
@Documented
@Constraint(validatedBy = { })
public @interface NotNull {

	String message() default "{javax.validation.constraints.NotNull.message}";

	Class<?>[] groups() default { };

	Class<? extends Payload>[] payload() default { };

	/**
	 * Defines several {@link NotNull} annotations on the same element.
	 *
	 * @see javax.validation.constraints.NotNull
	 */
	@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
	@Retention(RUNTIME)
	@Documented
	@interface List {

		NotNull[] value();
	}
}

2 使用

参考hibernate-validator注解，使用@Repeatable：

2.1 新建注解RepeaDemo，暂时不添加@Repeatable：

package com.xiaoxu.tool.demo;

import java.lang.annotation.*;

@Target(value = {ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RepeaDemo {
    String id();
    String name();
}

新建demo类：

package com.xiaoxu.tool.demo;

import java.lang.reflect.Field;
import java.util.Arrays;

/**
 * @author xiaoxu
 * @date 2022-05-17
 * spring_boot:com.xiaoxu.tool.demo.TestRepeatable
 */
public class TestRepeatable {
    @RepeaDemo(id = "1001",name = "荔枝")
    private String fruit1;

    @RepeaDemo(id = "1002",name = "葡萄")
    private String fruit2;

    public static void demo1(){
        Class<?> a = TestRepeatable.class;
        Field[] fruits = a.getDeclaredFields();
        Arrays.stream(fruits).forEach(f->{
            if(f.isAnnotationPresent(RepeaDemo.class)){
                RepeaDemo anno = f.getAnnotation(RepeaDemo.class);
                String id = anno.id();
                String name = anno.name();
                System.out.printf("水果id:%s,水果名称:%s%n",id,name);
            }
        });
    }
    public static void main(String[] args) {
        demo1();
    }
}

执行结果如下：

水果id:1001,水果名称:荔枝
水果id:1002,水果名称:葡萄

但是问题是，如果希望在字段上增加多个注解，那么会提示Duplicate annotation.错误：
在这里插入图片描述
于是考虑新增一个RepeaDemos注解，用于存储@RepeaDemo注解数组，就可以达到多个注解的使用了，如下：

package com.xiaoxu.tool.demo;

import java.lang.annotation.*;

@Target(value = {ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RepeaDemos {
    RepeaDemo[] repeaDemos();
}

修改TestRepeatable代码：

package com.xiaoxu.tool.demo;

import java.lang.reflect.Field;
import java.util.Arrays;

/**
 * @author xiaoxu
 * @date 2022-05-17
 * spring_boot:com.xiaoxu.tool.demo.TestRepeatable
 */
public class TestRepeatable {
    @RepeaDemos(repeaDemos = {
        @RepeaDemo(id = "1001",name = "荔枝"),
        @RepeaDemo(id = "1003",name = "沃柑")
    })
    private String fruit1;

    @RepeaDemo(id = "1002",name = "葡萄")
    private String fruit2;

    public static void demo1(){
        Class<?> a = TestRepeatable.class;
        Field[] fruits = a.getDeclaredFields();
        Arrays.stream(fruits).forEach(f->{
            if(f.isAnnotationPresent(RepeaDemo.class)){
                RepeaDemo anno = f.getAnnotation(RepeaDemo.class);
                String id = anno.id();
                String name = anno.name();
                System.out.printf("水果id:%s,水果名称:%s%n",id,name);
            }
        });
    }

    public static void demo2(){
        Class<?> a = TestRepeatable.class;
        Field[] fruits = a.getDeclaredFields();
        Arrays.stream(fruits).forEach(f->{
            if(f.isAnnotationPresent(RepeaDemos.class)){
                RepeaDemos anno = f.getAnnotation(RepeaDemos.class);
                RepeaDemo[] res= anno.repeaDemos();
                Arrays.stream(res).forEach(r-> System.out.printf("水果id:%s,水果名称:%s%n",r.id(),r.name()));
            }
            if(f.isAnnotationPresent(RepeaDemo.class)){
                RepeaDemo anno = f.getAnnotation(RepeaDemo.class);
                String id = anno.id();
                String name = anno.name();
                System.out.printf("水果id:%s,水果名称:%s%n",id,name);
            }
        });
    }
    public static void main(String[] args) {
        demo2();
    }
}

执行结果如下：

水果id:1001,水果名称:荔枝
水果id:1003,水果名称:沃柑
水果id:1002,水果名称:葡萄

2.2 @Repeatable注解使用：

对于上述注解使用，@Repeatable注解的作用就是使得@RepeaDemo注解可以多个添加在字段上，而最外层无须包裹@RepeaDemos注解，当然，@RepeaDemos注解任然需要保留，修改如下：

修改@RepeaDemos注解（注意@RepeaDemos注解，必须改为value()才可以）：

package com.xiaoxu.tool.demo;

import java.lang.annotation.*;

@Target(value = {ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RepeaDemos {
    RepeaDemo[] value();
}

修改@RepeaDemo注解，增加@Repeatable，参数为RepeaDemos.class：

package com.xiaoxu.tool.demo;

import java.lang.annotation.*;

@Target(value = {ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(RepeaDemos.class)
@Documented
public @interface RepeaDemo {
    String id();
    String name();
}

修改demo类：

package com.xiaoxu.tool.demo;

import java.lang.reflect.Field;
import java.util.Arrays;

/**
 * @author xiaoxu
 * @date 2022-05-17
 * spring_boot:com.xiaoxu.tool.demo.TestRepeatable
 */
public class TestRepeatable {
//    @RepeaDemos(value = {
//        @RepeaDemo(id = "1001",name = "荔枝"),
//        @RepeaDemo(id = "1003",name = "沃柑")
//    })
    @RepeaDemo(id = "1001",name = "荔枝")
    @RepeaDemo(id = "1003",name = "沃柑")
    private String fruit1;

    @RepeaDemo(id = "1002",name = "葡萄")
    private String fruit2;

    public static void demo1(){
        Class<?> a = TestRepeatable.class;
        Field[] fruits = a.getDeclaredFields();
        Arrays.stream(fruits).forEach(f->{
            if(f.isAnnotationPresent(RepeaDemo.class)){
                RepeaDemo anno = f.getAnnotation(RepeaDemo.class);
                String id = anno.id();
                String name = anno.name();
                System.out.printf("水果id:%s,水果名称:%s%n",id,name);
            }
        });
    }

    public static void demo2(){
        Class<?> a = TestRepeatable.class;
        Field[] fruits = a.getDeclaredFields();
        Arrays.stream(fruits).forEach(f->{
            if(f.isAnnotationPresent(RepeaDemos.class)){
                RepeaDemos anno = f.getAnnotation(RepeaDemos.class);
                RepeaDemo[] res= anno.value();
                Arrays.stream(res).forEach(r-> System.out.printf("水果id:%s,水果名称:%s%n",r.id(),r.name()));
            }
            if(f.isAnnotationPresent(RepeaDemo.class)){
                RepeaDemo anno = f.getAnnotation(RepeaDemo.class);
                String id = anno.id();
                String name = anno.name();
                System.out.printf("水果id:%s,水果名称:%s%n",id,name);
            }
        });
    }
    public static void main(String[] args) {
        demo2();
    }
}

执行效果如下：

水果id:1001,水果名称:荔枝
水果id:1003,水果名称:沃柑
水果id:1002,水果名称:葡萄

可见，如下两种方式，获取的结果是一致的，其实@Repeatable注解就是一种语法糖（类似于python的装饰器语法糖等等），本质上在java编译时，使用如下的第2种注解方式，等同于使用第1种：

	//1：
    @RepeaDemos(value = {
        @RepeaDemo(id = "1001",name = "荔枝"),
        @RepeaDemo(id = "1003",name = "沃柑")
    })
	//2:
    @RepeaDemo(id = "1001",name = "荔枝")
    @RepeaDemo(id = "1003",name = "沃柑")

2.3 小结

1 @Repeatable注解使用前，需先增加一个注解的属性值为子注解数组，且名称为value()的父注解；
2 @Repeatable注解需要在子注解上标注，且@Repeatable注解的值为父注解class；
3 @Repeatable注解本质上是一种语法糖。

【Spring】Spring ： @ComponentScan注解
九师兄
01-19 550
【代码】【Spring】Spring ： @ComponentScan注解。
【Java Web Spring Boot中的@Transactional注解】
xycxycooo的博客
07-26 1327
如果你希望对其他类型的异常也进行回滚，或者希望某些特定异常不触发回滚，可以使用注解的和属性进行自定义。假设我们希望对");} }");} }");} }");在这个例子中，当createUser方法抛出时，事务将会回滚。
Java注解——Repeatable
热门推荐
ljcgit的博客
08-16 1万+
Repeatable使用场景： 在需要对同一种注解多次使用时，往往需要借助@Repeatable。 实例： 在生活中一个人往往是具有多种身份，如果我把每种身份当成一种注解该如何使用？？？ 先声明一个Persons类用来包含所有的身份 @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @...
@Repeatable注解
做你想做的人，没有时间的限制，只要愿意，什么时候都可以start。
06-21 646
有些人生来就注定可以悠闲地坐在河边，有些人会被闪电击中，有些人会音乐，有些人是艺术家，有些人是游泳健将，有些人懂纽扣，有些人懂莎士比亚，有些人是妈妈，有些人是舞者…… 而人又都是有多个身份的,可以同时是丈夫/儿子/职员…程序里,我们有时候需要给一个目标加上多个相同的注解.这就是需要用到@Repeatable Repeatable代表可以重复,但是是归属于一个数组.本例Person注解归属Persons数组 @Retention(RetentionPolicy.RUNTIME) @Target(Eleme.
Java注解 @Repeatable
wumingdu1234的博客
03-01 417
当我们需要重复使用某个注解时，希望利用相同的注解来表现所有的形式时，我们可以借助@Repeatable注解。 @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface Persons { Person[] value(); } @Repeatable(Persons.class) public @interface Person{ String role() default ""; }
JAVA注解学习-@Repeatable注解
madman
12-22 6476
@Repeatable注解是用来标注一个注解在同一个地方可重复使用的一个注解，比如说你定义了一个注解，如果你的注解没有标记@Repeatable这个JDK自带的注解，那么你这个注解在引用的地方就只能使用一次。 例： 这里@ImportResource(value = “”)注解里面没有设置添加@Repeatable属性，所有引入的多次的时候就会报错， 参考链接 java8注解@Repeata...
Spring3事务管理详解：@Transactional 注解使用技巧
资源摘要信息:"Spring3事务管理——使用@Transactional 注解" 在当今的企业级应用开发中，事务管理是确保数据一致性和完整性的核心组件之一。Spring框架作为Java开发领域内广泛使用的企业级应用框架，提供了强大的...
Java注解@Transactional事务类内调用不生效问题及解决办法
08-19
然后，在启动类中添加@EnableAspectJAutoProxy(exposeProxy = true)注解： ```java @SpringBootApplication @EnableAspectJAutoProxy(exposeProxy = true) public class DonngPartsApplication { public static ...
Java元注解详解：@Documented与@Target
Java标准库提供了多个元注解，包括@Documented、@Target、@Retention、@Inherited以及Java 8新增的@Repeatable和@Native。这些元注解在`java.lang.annotation`包中定义。 @Documented 元注解是一个标记注解，没有...
@Repeatable注解学习
gli_001的博客
05-16 709
@Repeatable注解的学习
Java 8 新特性—重复注解@Repeatable
最新发布
smart_an的专栏
08-17 881
注解，以指定该注解可重复使用的容器注解类型。容器注解类型本身也是一个注解，通常具有一个value属性，其值是一个数组，用于存储重复使用的注解。通过上述那种方式确实是可以解决重复注解的问题，但是使用有点儿啰嗦，所以 Java 8 为了解决这个问题引入了注解。在 Java 8 之前我们是无法在一个类型重复使用多次同一个注解，比如我们常用的。注解允许在同一个类型上多次使用相同的注解，它提供了更灵活的注解使用方式。利用这种嵌套的方式来规避重复注解的问题，怎么获取呢？在使用重复注解之前，需要在自定义注解类型上使用。
@repeatable 注解小记
hei164730739的博客
03-23 626
在jdk1.8之前，自定义注解如果需要多次引用，一般都采用封装模式，即把一个自定义注解作为参数封装进另一个自定义注解，达到可以对同一个类多次注解的目的。但是这种注解方式还很有局限性 例： @Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) public @interface A { Str...
java 注解（@Repeatable）
weixin_43931625的博客
07-19 425
java注解（@Repeatable）
@Repeatable
qq_24851813的博客
01-02 1094
@Repeatable注解是用来标注一个注解在同一个地方可重复使用的一个注解，比如说你定义了一个注解，如果你的注解没有标记@Repeatable这个JDK自带的注解，那么你这个注解在引用的地方就只能使用一次。 这里@ImportResource(value = “”)注解里面没有设置添加@Repeatable属性，所有引入的多次的时候就会报错。 Repeatable注解的定义 java8以后支持在同一个地方（某个方法或者某个类等）加上相同的注解，前提是这个注解要使用元注解@Repeatable，但是在用之
java repeatable_Java @Repeatable
weixin_39870092的博客
02-13 169
查看@PropertySource注解时候，发现了@Repeatable，从来没见过的注解，学习了下；首先介绍下@Repeatable注解： JDK1.8出现的，作用是解决一个类上不能标注重复的注解；当你尝试在标注重复注解时候，IDE编译器就会提示：@Repeatable相当于指向一个容器，这样就可以在注解的地方重复标注注解了；简单的使用例子，方便自己理解：定义这样一个场景，每个人有不同的技能，不...
Java @Repeatable
aar49191的博客
01-19 299
查看@PropertySource注解时候，发现了@Repeatable，从来没见过的注解，学习了下； 首先介绍下@Repeatable注解： JDK1.8出现的，作用是解决一个类上不能标注重复的注解； 当你尝试在标注重复注解时候，IDE编译器就会提示： @Repeatable相当于指向一个容器，这样就可以在注解的地方重复标注注解了； 简单的使用例子，方便自己...
Repeatable元注解
weixin_43808717的博客
04-10 346
Repeatable：JDK8引入的元注解，表示被修饰的注解可以重复应用标记。这个注解比较绕，看了很久才想明白… 使用Repeatable元注解，需要定义一个目标注解，另外还需要定义一个存放目标注解的容器。 实例： 生活中的我们每个人都有很多不同的爱好，我们可以把每一种爱好都当做一种注解。因此可以利用Repeatable注解定义我们的爱好注解（每个人的爱好都不止一个），然后使用这个爱好注解修饰一个人。 首先定义一个注解容器，这个容器用于存放我们所有的兴趣爱好。 @Target(value = Ele
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值