运行带有嵌入式容器和 JNDI 的 Spring Boot 应用程序

Question

我有一个带有 spring.datasource.jndi-name=java:/foo 属性的 Spring Boot 应用程序，它在 WildFly 下运行良好。

我想使用嵌入式容器运行相同的应用程序，即mvn spring-boot:run，但是虽然 WildFly 在其配置中配置了 JNDI 数据源，但嵌入式容器没有，即我得到：

org.springframework.jdbc.datasource.lookup.DataSourceLookupFailureException:
Failed to look up JNDI DataSource with name 'java:/foo'

我想我必须在某处包含一个 XML 文件来为嵌入式容器配置 JNDI 数据源，但我找不到关于此的文档。我刚刚找到了有关如何在 Java 源代码中创建 JNDI 数据源的教程，但我想避免这种情况，以便同一个应用程序可以在外部和嵌入式容器中运行。

我怎样才能做到这一点？

EDIT This answer 展示了如何在 Tomcat 中创建 JNDI 上下文，这种方式会破坏在其他容器（例如 WildFly）中运行相同的应用程序。我正在寻找一个答案，它可以让应用程序在不同容器中使用相同的源运行，例如只需使用 WildFly 中配置的相同 JNDI 资源配置嵌入式容器。

Answer 1

@Setu 的回答对我不起作用，因为 TomcatEmbeddedServletContainerFactory 是在 ApplicationContext 刷新后创建的，但我需要 JNDI 在 ApplicationContext 刷新期间可用。

相反，我在启动我的 Spring Boot 应用程序以启用 Tomcat 命名之前设置了以下系统属性：

System.setProperty(Context.URL_PKG_PREFIXES, "org.apache.naming");
System.setProperty(Context.INITIAL_CONTEXT_FACTORY,
                   "org.apache.naming.java.javaURLContextFactory");

Answer 2

要使应用程序也可部署在其他启用 jndi 的容器中，请执行以下操作；

1. 扩展TomcatEmbeddedServletContainerFactory并启用jndi命名并添加资源
2. 使用 Profile 注释创建一个配置类，该类公开扩展的 TomcatEmbeddedServletContainerFactory bean

见下面的代码；

扩展 TomcatEmbeddedServletContainerFactory

class EmbeddedServletContainerFactory extends TomcatEmbeddedServletContainerFactory {
    @Override
    protected TomcatEmbeddedServletContainer getTomcatEmbeddedServletContainer(Tomcat tomcat) {
        tomcat.enableNaming(); // This is essential. Naming is disabled by default which needs enabling
        return super.getTomcatEmbeddedServletContainer(tomcat);
    }

    @Override
    protected void postProcessContext(Context context) {
        ContextResource resource = new ContextResource();
        // All the below properties you can retrieve via preferred method
        resource.setName("jdbc/test");
        resource.setAuth("Container");
        resource.setType(DataSource.class.getName());
        resource.setProperty("driverClassName", driverClass);
        resource.setProperty("factory", "org.apache.commons.dbcp2.BasicDataSourceFactory");
        resource.setProperty("url", dbUrl);
        resource.setProperty("username", username);
        resource.setProperty("password", password);
        context.getNamingResources().addResource(resource);
    }
}

暴露 bean 的配置类

@Profile("embedded")
@Configuration
public class EmbeddedConfig {

    @Bean
    public TomcatEmbeddedServletContainerFactory tomcatFactory() {
        return new EmbeddedServletContainerFactory();
    }
}

如果你不喜欢 java config 中的这个，你可以用 xml 方式做同样的事情

<beans profile="embedded">
    <bean id="TomcatEmbeddedServletContainerFactory" class="EmbeddedServletContainerFactory" />
</bean>

现在您可以在 pom 中硬编码配置文件名称或通过 jvm 参数添加它；

mvn spring-boot:run -Drun.profiles=embedded

您的其他代码保持不变，并且在其他容器中的行为相同。通过 jndi 查找数据源也保持不变。此代码确保在嵌入式容器中实际上有一个绑定到该 jndi 的数据源。