Spring Modulith项目中配置Bean的存放位置及启动异常解决

问题根因分析 #

你遇到的启动报错（工厂方法参数非法），核心原因是Spring Modulith的模块边界隔离机制：

• 当WebSecurityConfig放在子模块的config目录时，该配置类依赖的跨模块Bean（比如自定义UserDetailsService）没有被当前模块正确访问到——要么子模块没暴露该Bean，要么配置类所在模块没声明对依赖模块的引用，导致Spring无法注入所需参数。
• 放到根目录时，启动类所在的根模块默认能访问所有已声明依赖的子模块暴露Bean，所以配置类能正常找到参数。

配置Bean的组织原则与实践 #

1. 按「全局配置/模块内配置」拆分 #

• 全局跨领域配置（如WebSecurityConfig、全局数据源配置等）：放在启动类所在的根模块的config子包下。这类配置需要依赖多个模块的Bean，根模块作为全局协调者，天然适合承载这类配置。
• 模块内配置（如某领域的专属数据源、事件配置等）：放在对应子模块的config子包下，属于模块内部实现的一部分，仅对当前模块生效。

2. 正确暴露跨模块依赖的Bean #

如果配置类需要引用其他模块的Bean，必须确保目标模块已暴露该Bean：

• 方式一：在模块的@ApplicationModule注解中指定暴露的包：

  @ApplicationModule(exposedPackages = "com.example.user.service")
  public class UserModule {}
  

• 方式二：直接在需要暴露的Bean上添加@Exposed注解：

  @Service
  @Exposed
  public class CustomUserDetailsService implements UserDetailsService {
      // ...
  }
  

3. 明确模块间的依赖关系 #

在配置类所在的模块上，通过@ApplicationModule(requires = ...)声明对依赖模块的引用：
比如根模块依赖用户、订单模块：

@SpringBootApplication
@EnableApplicationModules
@ApplicationModule(requires = {UserModule.class, OrderModule.class})
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

4. 规范目录结构示例 #

your-project/
├── app-root/                     # 根模块（启动类所在）
│   ├── src/main/java/com/example/app/
│   │   ├── Application.java      # 启动类
│   │   └── config/
│   │       └── WebSecurityConfig.java  # 全局安全配置
│   └── pom.xml
├── user-module/                  # 用户子模块
│   ├── src/main/java/com/example/user/
│   │   ├── UserModule.java       # 模块标识类（带@ApplicationModule）
│   │   ├── config/
│   │   │   └── UserDbConfig.java # 模块内数据源配置
│   │   └── service/
│   │       └── CustomUserDetailsService.java # 带@Exposed的服务类
│   └── pom.xml
└── order-module/                 # 订单子模块
    ├── src/main/java/com/example/order/
    │   ├── OrderModule.java      # 模块标识类
    │   └── config/
    │       └── OrderEventConfig.java # 模块内事件配置
    └── pom.xml

5. 避免常见误区 #

• 不要在子模块中放置需要跨模块依赖的全局配置，否则容易出现Bean无法注入的问题。
• 不要直接引用其他模块的配置类，配置类属于模块内部实现，应通过暴露的业务Bean来依赖。

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