多模块Spring Boot多数据库持久层子模块配置方案咨询

Spring Boot默认的配置加载、Bean扫描规则只对主启动模块（也就是你项目里的web模块）生效：

• 默认只会加载主模块src/main/resources下的application前缀配置文件，依赖的子模块jar包内的同名配置不会被自动加载，就算文件名不重名，也不会被主动扫描导入
• 默认只会扫描主启动类所在包及其子包下的Spring注解Bean，子模块里的配置类、Repository、实体如果不在这个扫描路径下，根本不会被Spring容器识别

这就是你之前必须把配置文件挪到web模块下才能生效的核心原因。

1. 各持久层模块使用独立命名的配置文件 #

不要所有模块都用application.properties/application.yml命名，避免类路径下重名被覆盖。比如MySql持久层模块sbsuitedata在自身src/main/resources目录下创建mysql-datasource.properties，后续的Oracle持久层模块创建oracle-datasource.properties，各自在文件里维护专属的数据库连接、JPA/ORM参数，不需要往web模块拷贝。

2. 每个持久层模块自带独立配置类，自行加载自身配置 #

在每个持久层模块内编写专属的配置类，自己完成配置文件加载、数据源、事务管理器、实体/Repository扫描的定义，完全不依赖web模块的配置。
以MySql持久层模块为例，配置类示例代码如下：

@Configuration
@PropertySource(value = "classpath:mysql-datasource.properties", encoding = "UTF-8")
@EntityScan(basePackages = "com.yourpackage.sbsuitedata.entity")
@EnableJpaRepositories(
        basePackages = "com.yourpackage.sbsuitedata.repository",
        entityManagerFactoryRef = "mysqlEntityManagerFactory",
        transactionManagerRef = "mysqlTransactionManager"
)
public class MysqlPersistenceAutoConfig {

    @Bean
    @ConfigurationProperties(prefix = "spring.datasource.mysql")
    public DataSource mysqlDataSource() {
        return DataSourceBuilder.create().build();
    }

    // 按需补充mysqlEntityManagerFactory、mysqlTransactionManager两个Bean的定义，和其他数据源做隔离
}

Oracle持久层模块按相同逻辑编写自己的配置类即可，注意所有Bean的名称（数据源、实体管理器、事务管理器）必须和其他持久层模块区分开，避免启动时Bean冲突。

注意：多数据源场景下必须指定一个主数据源，在对应数据源的Bean或者配置类上加@Primary注解即可，否则Spring启动会报存在多个同类型Bean的错误。

3. 让主web模块识别子模块的配置类 #

两种实现方式选其一即可：

• 方式一：统一包扫描路径。给web模块的启动类上的@SpringBootApplication注解配置scanBasePackages属性，值设为所有模块的公共根包，比如所有模块的类都在com.yourpackage.sbsuite包下，就配置为@SpringBootApplication(scanBasePackages = "com.yourpackage.sbsuite")，这样子模块中标了@Configuration的配置类会被自动扫描加载。
• 方式二：显式导入配置类。如果不想扩大包扫描范围，直接在web模块的启动类或者web自身的配置类上通过@Import注解引入所有持久层模块的配置类即可，示例：@Import({MysqlPersistenceAutoConfig.class, OraclePersistenceAutoConfig.class})，适合子模块数量不多的场景。

4. 打包规则校验 #

默认maven构建会自动把src/main/resources下的配置文件打进模块jar包，如果你的项目自定义过资源过滤规则，需要在每个持久层模块的pom.xml里补充资源打包配置，避免配置文件遗漏：

<build>
    <resources>
        <resource>
            <directory>src/main/resources</directory>
            <includes>
                <include>**/*.properties</include>
                <include>**/*.yml</include>
            </includes>
        </resource>
    </resources>
</build>

按以上方案配置后，每个持久层模块可以完全独立维护自身的数据库连接配置、实体类、数据访问逻辑，web模块只需要引入对应持久层模块的maven依赖即可正常调用，不需要把任何持久层的配置文件挪到web模块下。后续新增对接其他数据库的持久层模块时，只需要按相同规则编写模块内的配置类和配置文件即可，不需要改动web模块的核心逻辑。

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