Spring Boot 根据配置决定服务(集群、单机)是否使用某些主件

比如:在集群模式下,我想用 Nacos 组件,单机版不想用它。

yml 复制代码
server:
  name: VipSoft Server Dev
  port: 8193
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848     #注册中心地址(集群用,号分隔)
        cluster-name: DEFAULT              #可以通过集群名称区分不同的项目
        server-name: netty-service
        group-name: NETTY_GROUP
java 复制代码
@Component
public class NettyServer {

    private static final Logger logger = LoggerFactory.getLogger(LoggerConfig.NETTY_LOGGER);

    @Value("${server.cloud.nacos.discovery.server-addr}")
    private String nacosServer;

    @Value("${server.cloud.nacos.discovery.server-name}")
    private String serviceName;

    @Value("${server.cloud.nacos.discovery.group-name}")
    private String groupName;

}

解决文案

方案1:使用条件注解 + 配置开关

  1. 修改 application.yml 添加启用开关:
yaml 复制代码
server:
  name: Telemetry Cloud Server Dev
  port: 8193
  cloud:
    nacos:
      enabled: false  # 添加这个开关
      discovery:
        server-addr: 127.0.0.1:8848
        cluster-name: DEFAULT
        server-name: netty-service
        group-name: NETTY_GROUP
  1. 修改 NettyServer 类:
java 复制代码
@Component
@ConditionalOnProperty(name = "server.cloud.nacos.enabled", havingValue = "true")
public class NettyServer {
    // 原有代码...
}

方案2:使用 Profile 区分

  1. 创建不同环境的配置文件:
  • application.yml (公共配置)
  • application-nacos.yml (Nacos相关配置)
  • application-standalone.yml (单机版配置)
  1. application.yml 中激活不同配置:
yaml 复制代码
spring:
  profiles:
    active: standalone # 或 nacos
  1. 将 Nacos 相关配置移到 application-nacos.yml 中

方案3:编程式条件加载(更灵活)

  1. 添加配置开关:
yaml 复制代码
netty:
  mode: standalone # 或 cloud
  1. 创建配置类:
java 复制代码
@Configuration
public class NettyConfig {
    
    @Bean
    @ConditionalOnProperty(name = "netty.mode", havingValue = "cloud")
    public NettyServer nettyServer() {
        return new NettyServer();
    }
}

方案4:使用 @ConfigurationProperties 更优雅地管理配置

  1. 创建配置类:
java 复制代码
@ConfigurationProperties(prefix = "server.cloud.nacos.discovery")
public class NacosProperties {
    private boolean enabled;
    private String serverAddr;
    private String clusterName;
    private String serverName;
    private String groupName;
    
    // getters and setters
}
  1. 修改 NettyServer:
java 复制代码
@Component
public class NettyServer {
    private final NacosProperties nacosProperties;
    
    public NettyServer(NacosProperties nacosProperties) {
        this.nacosProperties = nacosProperties;
        if(nacosProperties.isEnabled()) {
            // 初始化Nacos相关逻辑
        }
    }
}

最佳实践建议:

推荐方案1或方案4:

  1. 如果只是简单开关,用方案1最简单:
yaml 复制代码
server:
  cloud:
    nacos:
      enabled: false
java 复制代码
@Component
@ConditionalOnProperty(name = "server.cloud.nacos.enabled", matchIfMissing = false)
public class NettyServer {
    // ...
}
  1. 如果需要更复杂的配置管理,用方案4更优雅。

这样你可以通过修改配置文件的 enabled 值来决定是否启用Nacos相关功能,无需修改代码。