如何实现Spring库项目根据用户依赖动态启用对应实现类

核心是两个场景的依赖与代码冗余问题：

• 分布式锁库：单一Jar包含Redis、DB、ZK三种实现的依赖，用户仅用Redis时也会强制引入另外两种的依赖；尝试用@ConditionalOnClass控制实现加载，但触发类缺失错误。
• Spring Cloud旧库升级：替换ZuulFilter为GlobalFilter后，非Gateway环境也加载了大量Gateway相关类和Bean，导致包臃肿。

一、依赖拆分：实现按需引入 #

分布式锁库改造 #

把原有单一模块拆成多模块结构：

• 核心模块：com.example.dlock:distributed-lock-core，只放统一API、注解、配置抽象类，不依赖任何第三方实现库
• 实现子模块：
  • com.example.dlock:distributed-lock-redis：仅引入Spring Redis依赖，包含Redis锁的具体实现
  • com.example.dlock:distributed-lock-db：仅引入JDBC/JPA依赖，包含数据库锁实现
  • com.example.dlock:distributed-lock-zookeeper：仅引入Curator等ZK依赖，包含ZK锁实现
    用户只需引入核心模块+对应实现模块，彻底避免冗余依赖。

Spring Cloud Gateway改造 #

把Gateway相关的GlobalFilter实现、配置类单独拆成一个子模块（如com.example.cloud:cloud-gateway-support），原核心库只保留通用过滤逻辑或抽象接口，不依赖任何Gateway类。

二、自动配置：修复条件加载失效问题 #

1. 配置类与实现类绑定到子模块 #

把各实现的自动配置类放在对应子模块里，比如Redis锁的RedisLockAutoConfiguration放在distributed-lock-redis模块。用户没引入该子模块时，配置类本身不在类路径，自然不会被加载，从根源避免类缺失。

2. 严格控制配置类的依赖范围 #

如果必须在核心模块放配置类，绝对不能直接引用具体实现类，要通过@ConditionalOnClass检查第三方依赖类作为触发条件，再用@Import动态导入实现：

@Configuration
@ConditionalOnClass(RedisTemplate.class)
@Import(RedisLockServiceImpl.class)
public class RedisLockAutoConfiguration {
    // 仅配置Redis锁的参数Bean，不涉及其他实现类
}

3. 用兜底条件排除未引入的实现 #

若某些场景无法避免跨模块类引用，配合@ConditionalOnMissingClass排除未引入的实现：

@Configuration
@ConditionalOnMissingClass("org.apache.curator.framework.CuratorFramework")
public class ZkLockExcludeConfiguration {
    // 空配置，用于阻止ZK相关Bean的加载逻辑
}

三、Spring Boot自动配置文件规范 #

Spring Boot 2.7+建议用META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports替代旧的spring.factories，让各子模块自己维护该文件。比如Gateway子模块的该文件中只注册GatewayAutoConfiguration，这样只有用户引入Gateway子模块时，配置类才会被Spring扫描加载。

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