能否自定义组合注解整合重复使用的多个Spring注解？

Spring的**元注解（Meta-Annotation）**机制允许你把多个重复使用的注解整合成一个自定义注解，完全满足你的需求。下面是具体实现步骤：

1. 编写自定义注解@CustomAnnotation #

通过元注解特性，把你需要复用的注解都标注在自定义注解上，同时用@AliasFor将自定义注解的参数直接映射到原有注解的属性上：

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.core.annotation.AliasFor;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import java.lang.annotation.*;

// 指定注解可用于类
@Target(ElementType.TYPE)
// 注解在运行时生效
@Retention(RetentionPolicy.RUNTIME)
// 生成Javadoc时包含该注解
@Documented
// 整合所有需要复用的注解
@Configuration
@Data
@Slf4j
@ConfigurationProperties
@PropertySource(factory = YamlSourceFactory.class)
public @interface CustomAnnotation {

    // 映射@ConfigurationProperties的prefix属性，对应传入的key参数
    @AliasFor(annotation = ConfigurationProperties.class, attribute = "prefix")
    String key() default "";

    // 映射@PropertySource的value属性，对应配置文件路径
    @AliasFor(annotation = PropertySource.class, attribute = "value")
    String value() default "";
}

2. 确保YamlSourceFactory类可用 #

这个类用于加载YAML格式的配置文件，如果你之前已经实现过，直接复用即可；如果没有，参考以下实现：

import org.springframework.core.env.PropertySource;
import org.springframework.core.io.support.EncodedResource;
import org.springframework.core.io.support.PropertySourceFactory;
import org.springframework.boot.env.YamlPropertySourceLoader;
import java.io.IOException;
import java.util.List;

public class YamlSourceFactory implements PropertySourceFactory {
    @Override
    public PropertySource<?> createPropertySource(String name, EncodedResource resource) throws IOException {
        if (resource == null) {
            throw new IllegalArgumentException("EncodedResource must not be null");
        }
        YamlPropertySourceLoader loader = new YamlPropertySourceLoader();
        List<PropertySource<?>> sources = loader.load(resource.getResource().getFilename(), resource.getResource());
        return sources.get(0);
    }
}

3. 简化使用 #

现在其他类只需要一行注解，就能替代原来的多个注解：

@CustomAnnotation(key = "hello", value = "classpath:hello.yml")
public class HelloConfig {
    // 直接定义配置属性，@Data会自动生成getter/setter
    private String name;
    private String welcomeMsg;
}

注意点 #

• 项目需引入Lombok依赖（支持@Data、@Slf4j）和Spring Boot配置处理器依赖（spring-boot-configuration-processor，用于IDE自动提示配置属性）。
• 确保Spring版本在4.2及以上（@AliasFor的元注解属性映射从该版本开始支持）。
• 可以给自定义注解的key和value设置默认值，比如默认prefix为"common"、默认配置文件为"classpath:common.yml"，进一步简化使用。

内容的提问来源于stack exchange，提问作者MuCh