如何将类库的Spring Context集成到应用程序的Spring Context中？

嗨，我完全懂你的需求：你开发了一个基于Spring+Hibernate（用到SessionFactory这类Bean）的类库，原本靠XML配置Spring上下文，现在希望使用者只要引入Maven依赖，启动应用时你的类库就能直接复用他们的通用Spring上下文，而不是维护一套独立的上下文配置。你知道Spring Boot里的spring.factories自动配置机制，但不确定纯Spring环境有没有类似方案，还想移除类库自己的独立配置对吧？下面给你几个可行的实现思路：

1. 把XML配置换成Java配置类 #

首先，把你原来XML里的Bean定义（比如SessionFactory的配置）转换成Java配置类，这样既灵活，又方便使用者集成。举个例子：

@Configuration
public class HibernateLibraryAutoConfig {
    // 直接复用应用上下文里已有的DataSource，不用自己创建
    @Bean
    public SessionFactory sessionFactory(DataSource dataSource) {
        LocalSessionFactoryBean sessionFactoryBean = new LocalSessionFactoryBean();
        sessionFactoryBean.setDataSource(dataSource);
        // 扫描类库自己的实体类包
        sessionFactoryBean.setPackagesToScan("com.your.library.entity");
        // Hibernate的属性配置可以让使用者通过外部配置传入，比如application.properties
        Properties hibernateProps = new Properties();
        hibernateProps.setProperty("hibernate.dialect", "org.hibernate.dialect.MySQL8Dialect");
        sessionFactoryBean.setHibernateProperties(hibernateProps);
        
        try {
            sessionFactoryBean.afterPropertiesSet();
            return sessionFactoryBean.getObject();
        } catch (IOException e) {
            throw new RuntimeException("Failed to initialize SessionFactory", e);
        }
    }

    // 类库需要的其他Bean，同样依赖应用上下文里的通用Bean
}

2. 让使用者通过@Import导入你的配置类 #

类库的使用者只需要在他们自己的Spring配置里导入你的配置类，就能让你的Bean融入到他们的上下文里：

• 如果使用者用Java配置：

@Configuration
// 导入类库的配置类
@Import(HibernateLibraryAutoConfig.class)
public class AppRootConfig {
    // 这里定义应用自己的DataSource、事务管理器等通用Bean
    @Bean
    public DataSource dataSource() {
        // 应用自己的数据源配置
        ...
    }
}

• 如果使用者还在用XML配置，可以通过<context:component-scan>扫描你的配置类所在包，或者直接导入：

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
                           http://www.springframework.org/schema/beans/spring-beans.xsd
                           http://www.springframework.org/schema/context
                           http://www.springframework.org/schema/context/spring-context.xsd">

    <!-- 扫描类库的配置类包 -->
    <context:component-scan base-package="com.your.library.config"/>
    
    <!-- 或者直接导入配置类 -->
    <import resource="classpath:com/your/library/config/HibernateLibraryAutoConfig.class"/>

    <!-- 应用自己的数据源配置 -->
    <bean id="dataSource" class="com.zaxxer.hikari.HikariDataSource">
        ...
    </bean>
</beans>

这样你的类库就完全复用了应用的Spring上下文，不需要自己启动独立的上下文实例。

3. 可选：用条件化配置增强灵活性 #

如果你的类库想做到“自适应”——比如只有当应用没有自定义SessionFactory时，才创建你提供的SessionFactory，可以用Spring的条件化配置特性：

纯Spring环境下需要自定义Condition类：

public class SessionFactoryMissingCondition implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        // 检查上下文里是否已经存在SessionFactory Bean
        return !context.getBeanFactory().containsBean(SessionFactory.class.getName());
    }
}

然后在你的配置类里使用：

@Configuration
public class HibernateLibraryAutoConfig {
    @Bean
    @Conditional(SessionFactoryMissingCondition.class)
    public SessionFactory sessionFactory(DataSource dataSource) {
        // 只有当应用没有自己的SessionFactory时才创建这个
        ...
    }
}

如果使用者用的是Spring 4.3+，也可以用@ConditionalOnMissingBean（不过这个注解其实是Spring Boot提供的，如果是纯Spring环境需要自己实现，或者引入Spring Boot的spring-boot-autoconfigure依赖，但这样就不算纯Spring了，所以更推荐自定义Condition）

4. 移除类库的独立XML配置 #

现在你已经用Java配置类替代了原来的XML，并且通过导入的方式让类库融入应用上下文，就可以完全移除类库中原来用于启动独立上下文的XML配置了——因为你的类库不再需要自己管理上下文，完全依赖应用提供的通用上下文。

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