SpringBoot的常用注解的使用记录

最新推荐文章于 2025-02-04 19:02:30 发布

原创最新推荐文章于 2025-02-04 19:02:30 发布 · 514 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#SpringBoot #常用注解的使用

SpringBoot 专栏收录该内容

26 篇文章

订阅专栏

本文深入解析SpringBoot中@ConditionalOnProperty注解的使用方法，包括如何通过name和havingValue属性控制@Configuration的生效条件，以及与其他注解如@ConfigurationProperties的配合使用。

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

@ConditionalOnProperty

1. 说明Spring Boot通过@ConditionalOnProperty来控制@Configuration是否生效(ConditionalOnProperty需要条件符合才可以,必须加Configuration是否生效才有效)

2. 解析
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
@Documented
@Conditional(OnPropertyCondition.class)
public @interface ConditionalOnProperty {

    String[] value() default {}; //数组，获取对应property名称的值，与name不可同时使用  
  
    String prefix() default "";//property名称的前缀，可有可无  
  
    String[] name() default {};//数组，property完整名称或部分名称（可与prefix组合使用，组成完整的property名称），与value不可同时使用  
  
    String havingValue() default "";//可与name组合使用，比较获取到的属性值与havingValue给定的值是否相同，相同才加载配置  
  
    boolean matchIfMissing() default false;//缺少该property时是否可以加载。如果为true，没有该property也会正常加载；反之报错  
  
    boolean relaxedNames() default true;//是否可以松散匹配，至今不知道怎么使用的  
    } 
}
3. 使用方法
通过其两个属性name以及havingValue来实现的，其中name用来从application.yml。
如果该值为空，则返回false;
如果值不为空，则将该值与havingValue指定的值进行比较，如果一样则返回true;否则返回false。
如果返回值为false，则该configuration不生效；为true则生效。

@ConfigurationProperties

1. @ConfigurationProperties可以配合@EnableConfigurationProperties(DynamicDbProperties.class)使用，@EnableConfigurationProperties可以指定那些DynamicDbProperties配置文件,自动装载yml(properties)的配置


通过@EnableConfigurationProperties(ConnectionSettings.class)来明确指定需要用哪个实体类来装载配置信息


@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@EnableAspectJAutoProxy
@EnableConfigurationProperties(DynamicDbProperties.class)
@Import({RefreshDynamicConfig.class, DataSourceAspect.class})
public @interface EnableDynamicDB {
}


/**
 * 通过配置penguin.dynamic.datasource.ssh.enable的属性配置如果和havingValue想匹配,则加载配置DynamicSSHProperties,然后启用自动配置@EnableConfigurationProperties(DynamicSSHConnectionProperties.class)
 * 的DynamicSSHConnectionProperties文件,然后DynamicSSHConnectionProperties就会自动注入了
 */
@Configuration
@EnableConfigurationProperties(DynamicSSHConnectionProperties.class)
@ConditionalOnProperty(prefix = "penguin.dynamic.datasource.ssh", name = "enable", havingValue = "true", matchIfMissing = true)
public class DynamicSSHProperties implements Serializable {
}


@Data
@NoArgsConstructor
@AllArgsConstructor
@ConfigurationProperties(prefix = "penguin.dynamic.datasource.ssh")
public class DynamicSSHConnectionProperties implements Serializable {
}

常用注解说明

执行顺序
@AutoConfigureAfter：在指定的配置类初始化后再加载
@AutoConfigureBefore：在指定的配置类初始化前加载
@AutoConfigureOrder：数越小越先初始化


条件配置
@ConditionalOnClass ： classpath中存在该类时起效
@ConditionalOnMissingClass ： classpath中不存在该类时起效
@ConditionalOnBean ： DI容器中存在该类型Bean时起效
@ConditionalOnMissingBean ： DI容器中不存在该类型Bean时起效
@ConditionalOnSingleCandidate ： DI容器中该类型Bean只有一个或@Primary的只有一个时起效
@ConditionalOnExpression ： SpEL表达式结果为true时
@ConditionalOnProperty ： 参数设置或者值一致时起效
@ConditionalOnResource ： 指定的文件存在时起效
@ConditionalOnJndi ： 指定的JNDI存在时起效
@ConditionalOnJava ： 指定的Java版本存在时起效
@ConditionalOnWebApplication ： Web应用环境下起效
@ConditionalOnNotWebApplication ： 非Web应用环境下起效