SpringBoot根据配置文件设置将类交给容器管理

SpringBoot根据配置文件设置将类交给容器管理

需求分析

在SpringBoot项目的开发过程中，不可避免的会有一些配置类在某些情况下不需要加载，比如开发过程中对接口进行修改测试时，假如项目已经配置了相关路由拦截要求必须登录或者某种权限后才可以访问该接口，这对开发接口测试造成不便。

直接的解决方案如下:

• 在该类的代码处将@Configuration进行注释，这样就不会对路由进行拦截，可以直接访问到接口

• 接口测试时先手动登录获取输入相关登录的token令牌，然后接口测试时携带该token进行路由验证后访问测试接口

上述解决方案存在以下缺点:

• 手动注释代码相对繁琐，应该尽可能将代码与配置文件分开
• 接口测试往往需要多次重启项目，而token往往存于内存中，这样每次启动项目后token失效就得重新登录

综合考虑上述问题解决方案为使用Spring中的@ConditionalOnProperty注解

解决方案

要在application.yaml文件中控制是否将某个配置类交给Spring，可以使用Spring Boot的条件注解，特别是@ConditionalOnProperty。

下面是如何操作的步骤：

1. 在你的配置类上添加@ConditionalOnProperty注解。
2. 指定在application.yaml中应该查找的属性和期望值。

例如：

YourConfigurationClass.java

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConditionalOnProperty(
    name = "your.config.enabled", 
    havingValue = "true", //配置文件中匹配的值
    matchIfMissing = true // 如果属性缺失，则默认为true
)
public class YourConfigurationClass {
    // ... your bean definitions and other configurations ...
}

在上面的例子中，只有当application.yaml中有如下设置时，该配置类才会被Spring加载：

application.yaml

your:
  config:
    enabled: true

仅仅当enabled设置为true或者完全移除这个属性，那么Spring才会加载这个配置类。

完全移除这个属性示例如下，application.yaml中找不到该属性,Spring也会加载这个配置类

application.yaml

your:
  config:
#    enabled:

对于@ConditionalOnProperty中matchIfMissing = true若设置为matchIfMissing = false，上述情况则不会加载

@ConditionalOnProperty中matchIfMissing = true若设置为matchIfMissing = false，上述情况则不会加载