如何使用嵌入式Tomcat容器在Spring Boot中创建JNDI上下文

Question

如何使用嵌入式Tomcat容器在Spring Boot中创建JNDI上下文

DaS*_*aun 45 jndi embedded-tomcat-7 spring-boot

import org.apache.catalina.Context;
import org.apache.catalina.deploy.ContextResource;
import org.apache.catalina.startup.Tomcat;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.context.embedded.ConfigurableEmbeddedServletContainer;
import org.springframework.boot.context.embedded.EmbeddedServletContainerCustomizer;
import org.springframework.boot.context.embedded.tomcat.TomcatContextCustomizer;
import org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedServletContainer;
import org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedServletContainerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.ImportResource;

@Configuration
@EnableAutoConfiguration
@ComponentScan
@ImportResource("classpath:applicationContext.xml")
public class Application {

    public static void main(String[] args) throws Exception {
        new SpringApplicationBuilder()
                .showBanner(false)
                .sources(Application.class)
                .run(args);
}

@Bean
public TomcatEmbeddedServletContainerFactory tomcatFactory() {
    return new TomcatEmbeddedServletContainerFactory() {
        @Override
        protected TomcatEmbeddedServletContainer getTomcatEmbeddedServletContainer(
                Tomcat tomcat) {
            tomcat.enableNaming();
            return super.getTomcatEmbeddedServletContainer(tomcat);
        }
    };
}

@Bean
public EmbeddedServletContainerCustomizer embeddedServletContainerCustomizer() {
    return new EmbeddedServletContainerCustomizer() {
        @Override
        public void customize(ConfigurableEmbeddedServletContainer container) {
            if (container instanceof TomcatEmbeddedServletContainerFactory) {
                TomcatEmbeddedServletContainerFactory tomcatEmbeddedServletContainerFactory = (TomcatEmbeddedServletContainerFactory) container;
                tomcatEmbeddedServletContainerFactory.addContextCustomizers(new TomcatContextCustomizer() {
                    @Override
                    public void customize(Context context) {
                        ContextResource mydatasource = new ContextResource();
                        mydatasource.setName("jdbc/mydatasource");
                        mydatasource.setAuth("Container");
                        mydatasource.setType("javax.sql.DataSource");
                        mydatasource.setScope("Sharable");
                        mydatasource.setProperty("driverClassName", "oracle.jdbc.driver.OracleDriver");
                        mydatasource.setProperty("url", "jdbc:oracle:thin:@mydomain.com:1522:myid");
                        mydatasource.setProperty("username", "myusername");
                        mydatasource.setProperty("password", "mypassword");

                        context.getNamingResources().addResource(mydatasource);

                    }
                });
            }
        }
    };
}

Run Code Online (Sandbox Code Playgroud)

}

我正在使用spring boot并尝试使用嵌入式tomcat启动,为我的数据源创建JNDI上下文:

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
        <version>1.1.4.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-tomcat</artifactId>
        <version>1.1.4.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.data</groupId>
        <artifactId>spring-data-oracle</artifactId>
        <version>1.0.0.RELEASE</version>
    </dependency>

Run Code Online (Sandbox Code Playgroud)

如果我删除@ImportResource我的应用程序启动就好了.我可以连接到tomcat实例.我可以检查所有执行器端点.使用JConsole,我可以连接到应用程序,我可以在MBeans中看到我的数据源(Catalina - >资源 - >上下文 - >"/" - > localhost - > javax.sql.DataSource - > jdbc/mydatasource)

我也通过JConsole在这里显示MBean(Tomcat - > DataSource - >/ - > localhost - > javax.sql.DataSource - > jdbc/mydatasource)

但是,当我@ImportResource通过JNDI实际寻找mydatasource时,它找不到它.

<bean id="myDS" class="org.springframework.jndi.JndiObjectFactoryBean">
    <property name="jndiName" value="java:comp/env/jdbc/mydatasource"/>
</bean>

Run Code Online (Sandbox Code Playgroud)

我导入的xml文件的相关部分

我在上面配置的ContextResource使用与在将应用程序部署到tomcat容器时部署的context.xml中使用的完全相同的参数.部署到tomcat容器时,我的导入bean和我的应用程序正常工作.

所以看来我现在有一个上下文,但似乎命名是正确的.我已尝试过各种资源名称组合,但似乎无法在此上下文中生成"comp"绑定.

Caused by: javax.naming.NameNotFoundException: Name [comp/env/jdbc/mydatasource] is not bound in this Context. Unable to find [comp].
    at org.apache.naming.NamingContext.lookup(NamingContext.java:819)
    at org.apache.naming.NamingContext.lookup(NamingContext.java:167)
    at org.apache.naming.SelectorContext.lookup(SelectorContext.java:156)
    at javax.naming.InitialContext.lookup(InitialContext.java:392)
    at org.springframework.jndi.JndiTemplate$1.doInContext(JndiTemplate.java:155)
    at org.springframework.jndi.JndiTemplate.execute(JndiTemplate.java:87)
    at org.springframework.jndi.JndiTemplate.lookup(JndiTemplate.java:152)
    at org.springframework.jndi.JndiTemplate.lookup(JndiTemplate.java:179)
    at org.springframework.jndi.JndiLocatorSupport.lookup(JndiLocatorSupport.java:95)
    at org.springframework.jndi.JndiObjectLocator.lookup(JndiObjectLocator.java:106)
    at org.springframework.jndi.JndiObjectFactoryBean.lookupWithFallback(JndiObjectFactoryBean.java:231)
    at org.springframework.jndi.JndiObjectFactoryBean.afterPropertiesSet(JndiObjectFactoryBean.java:217)
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.invokeInitMethods(AbstractAutowireCapableBeanFactory.java:1612)
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.initializeBean(AbstractAutowireCapableBeanFactory.java:1549)
    ... 30 more

Run Code Online (Sandbox Code Playgroud)

Answer 1

And*_*son 56

默认情况下,在嵌入式Tomcat中禁用JNDI,这导致了NoInitialContextException.您需要打电话Tomcat.enableNaming()才能启用它.最简单的方法是使用TomcatEmbeddedServletContainer子类:

@Bean
public TomcatEmbeddedServletContainerFactory tomcatFactory() {
    return new TomcatEmbeddedServletContainerFactory() {

        @Override
        protected TomcatEmbeddedServletContainer getTomcatEmbeddedServletContainer(
                Tomcat tomcat) {
            tomcat.enableNaming();
            return super.getTomcatEmbeddedServletContainer(tomcat);
        }
    };
}

Run Code Online (Sandbox Code Playgroud)

如果采用这种方法,还可以DataSource通过覆盖子类中的postProcessContext方法来注册JNDI TomcatEmbeddedServletContainerFactory.

context.getNamingResources().addResource将资源的java:comp/env背景下,因此资源的名称应该是jdbc/mydatasource没有java:comp/env/mydatasource.

Tomcat使用线程上下文类加载器来确定应该对哪个JNDI上下文执行查找.您将资源绑定到Web应用程序的JNDI上下文中,因此您需要确保在Web应用程序的类加载器是线程上下文类加载器时执行查找.您应该能够通过设置lookupOnStartup为falseon 来实现此目的jndiObjectFactoryBean.您还需要设置expectedType为javax.sql.DataSource:

<bean class="org.springframework.jndi.JndiObjectFactoryBean">
    <property name="jndiName" value="java:comp/env/jdbc/mydatasource"/>
    <property name="expectedType" value="javax.sql.DataSource"/>
    <property name="lookupOnStartup" value="false"/>
</bean>

Run Code Online (Sandbox Code Playgroud)

这将为DataSource创建一个代理,实际的JNDI查找是在首次使用时执行的,而不是在应用程序上下文启动期间执行的.

上面描述的方法在Spring Boot示例中进行了说明.

这对我不起作用，我得到`javax.naming.NoInitialContextException：需要在环境或系统属性中指定类名，或作为小程序参数，或在应用程序资源文件中：java.naming.factory.initial`我将我的 jndi 资源定义为其他文件中的 bean。 (4认同)

Answer 2

nek*_*739 12

毕竟我得到了wikisona的答案,首先是豆子:

@Bean
public TomcatEmbeddedServletContainerFactory tomcatFactory() {
    return new TomcatEmbeddedServletContainerFactory() {

        @Override
        protected TomcatEmbeddedServletContainer getTomcatEmbeddedServletContainer(
                Tomcat tomcat) {
            tomcat.enableNaming();
            return super.getTomcatEmbeddedServletContainer(tomcat);
        }

        @Override
        protected void postProcessContext(Context context) {
            ContextResource resource = new ContextResource();
            resource.setName("jdbc/myDataSource");
            resource.setType(DataSource.class.getName());
            resource.setProperty("driverClassName", "your.db.Driver");
            resource.setProperty("url", "jdbc:yourDb");

            context.getNamingResources().addResource(resource);
        }
    };
}

@Bean(destroyMethod="")
public DataSource jndiDataSource() throws IllegalArgumentException, NamingException {
    JndiObjectFactoryBean bean = new JndiObjectFactoryBean();
    bean.setJndiName("java:comp/env/jdbc/myDataSource");
    bean.setProxyInterface(DataSource.class);
    bean.setLookupOnStartup(false);
    bean.afterPropertiesSet();
    return (DataSource)bean.getObject();
}

Run Code Online (Sandbox Code Playgroud)

它的完整代码在这里:https://github.com/wilkinsona/spring-boot-sample-tomcat-jndi

Answer 3

dav*_*xxx 9

我最近要求在Spring Boot中使用JNDI和嵌入式Tomcat.
实际答案提供了一些有趣的提示来解决我的任务,但这还不够,因为Spring Boot 2可能没有更新.

这是我使用Spring Boot 2.0.3.RELEASE测试的贡献.

在运行时指定类路径中可用的数据源

你有多种选择:

使用DBCP 2数据源(您不希望使用过时且效率较低的DBCP 1).
使用Tomcat JDBC数据源.
使用任何其他数据源:例如HikariCP.

如果未指定其中任何一个,则使用默认配置数据源的实例化将引发异常:

Caused by: javax.naming.NamingException: Could not create resource factory instance
        at org.apache.naming.factory.ResourceFactory.getDefaultFactory(ResourceFactory.java:50)
        at org.apache.naming.factory.FactoryBase.getObjectInstance(FactoryBase.java:90)
        at javax.naming.spi.NamingManager.getObjectInstance(NamingManager.java:321)
        at org.apache.naming.NamingContext.lookup(NamingContext.java:839)
        at org.apache.naming.NamingContext.lookup(NamingContext.java:159)
        at org.apache.naming.NamingContext.lookup(NamingContext.java:827)
        at org.apache.naming.NamingContext.lookup(NamingContext.java:159)
        at org.apache.naming.NamingContext.lookup(NamingContext.java:827)
        at org.apache.naming.NamingContext.lookup(NamingContext.java:159)
        at org.apache.naming.NamingContext.lookup(NamingContext.java:827)
        at org.apache.naming.NamingContext.lookup(NamingContext.java:173)
        at org.apache.naming.SelectorContext.lookup(SelectorContext.java:163)
        at javax.naming.InitialContext.lookup(InitialContext.java:417)
        at org.springframework.jndi.JndiTemplate.lambda$lookup$0(JndiTemplate.java:156)
        at org.springframework.jndi.JndiTemplate.execute(JndiTemplate.java:91)
        at org.springframework.jndi.JndiTemplate.lookup(JndiTemplate.java:156)
        at org.springframework.jndi.JndiTemplate.lookup(JndiTemplate.java:178)
        at org.springframework.jndi.JndiLocatorSupport.lookup(JndiLocatorSupport.java:96)
        at org.springframework.jndi.JndiObjectLocator.lookup(JndiObjectLocator.java:114)
        at org.springframework.jndi.JndiObjectTargetSource.getTarget(JndiObjectTargetSource.java:140)
        ... 39 common frames omitted
Caused by: java.lang.ClassNotFoundException: org.apache.tomcat.dbcp.dbcp2.BasicDataSourceFactory
        at java.net.URLClassLoader.findClass(URLClassLoader.java:381)
        at java.lang.ClassLoader.loadClass(ClassLoader.java:424)
        at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:331)
        at java.lang.ClassLoader.loadClass(ClassLoader.java:357)
        at java.lang.Class.forName0(Native Method)
        at java.lang.Class.forName(Class.java:264)
        at org.apache.naming.factory.ResourceFactory.getDefaultFactory(ResourceFactory.java:47)
        ... 58 common frames omitted

要使用Apache JDBC数据源,您不需要添加任何依赖项,但必须将默认工厂类更改为 org.apache.tomcat.jdbc.pool.DataSourceFactory.
您可以在资源声明中执行此操作: resource.setProperty("factory", "org.apache.tomcat.jdbc.pool.DataSourceFactory"); 我将在下面解释添加此行的位置.
要使用DBCP 2数据源,需要依赖关系:

<dependency> <groupId>org.apache.tomcat</groupId> <artifactId>tomcat-dbcp</artifactId> <version>8.5.4</version> </dependency>

当然,根据您的Spring Boot Tomcat嵌入式版本调整工件版本.

要使用HikariCP,请添加所需的依赖项(如果您的配置中尚未存在)(可能是您依赖于Spring Boot的持久性启动程序),例如:

<dependency> <groupId>com.zaxxer</groupId> <artifactId>HikariCP</artifactId> <version>3.1.0</version> </dependency>

并指定资源声明中的工厂:

resource.setProperty("factory", "com.zaxxer.hikari.HikariDataSource");

Run Code Online (Sandbox Code Playgroud)

数据源配置/声明

您必须自定义创建TomcatServletWebServerFactory实例的bean .
要做的两件事:

启用默认禁用的JNDI命名
在服务器上下文中创建和添加JNDI资源

例如,对于PostgreSQL和DBCP 2数据源,请执行以下操作:

@Bean
public TomcatServletWebServerFactory tomcatFactory() {
    return new TomcatServletWebServerFactory() {
        @Override
        protected TomcatWebServer getTomcatWebServer(org.apache.catalina.startup.Tomcat tomcat) {
            tomcat.enableNaming(); 
            return super.getTomcatWebServer(tomcat);
        }

        @Override 
        protected void postProcessContext(Context context) {

            // context
            ContextResource resource = new ContextResource();
            resource.setName("jdbc/myJndiResource");
            resource.setType(DataSource.class.getName());
            resource.setProperty("driverClassName", "org.postgresql.Driver");

            resource.setProperty("url", "jdbc:postgresql://hostname:port/dbname");
            resource.setProperty("username", "username");
            resource.setProperty("password", "password");
            context.getNamingResources()
                   .addResource(resource);          
        }
    };
}

Run Code Online (Sandbox Code Playgroud)

这里是Tomcat JDBC和HikariCP数据源的变体.

在postProcessContext()早期为Tomcat JDBC ds设置工厂属性:

    @Override 
    protected void postProcessContext(Context context) {
        ContextResource resource = new ContextResource();       
        //...
        resource.setProperty("factory", "org.apache.tomcat.jdbc.pool.DataSourceFactory");
        //...
        context.getNamingResources()
               .addResource(resource);          
    }
};

Run Code Online (Sandbox Code Playgroud)

并为HikariCP:

    @Override 
    protected void postProcessContext(Context context) {
        ContextResource resource = new ContextResource();       
        //...
        resource.setProperty("factory", "com.zaxxer.hikari.HikariDataSource");
        //...
        context.getNamingResources()
               .addResource(resource);          
    }
};

Run Code Online (Sandbox Code Playgroud)

使用/注入数据源

您现在应该可以使用标准InitialContext实例在任何地方查找JNDI资源:

InitialContext initialContext = new InitialContext();
DataSource datasource = (DataSource) initialContext.lookup("java:comp/env/jdbc/myJndiResource");

Run Code Online (Sandbox Code Playgroud)

您还可以使用JndiObjectFactoryBeanSpring查找资源:

JndiObjectFactoryBean bean = new JndiObjectFactoryBean();
bean.setJndiName("java:comp/env/jdbc/myJndiResource");
bean.afterPropertiesSet();
DataSource object = (DataSource) bean.getObject();

Run Code Online (Sandbox Code Playgroud)

要利用DI容器,您还可以创建DataSource一个Spring bean:

@Bean(destroyMethod = "")
public DataSource jndiDataSource() throws IllegalArgumentException, NamingException {
    JndiObjectFactoryBean bean = new JndiObjectFactoryBean();
    bean.setJndiName("java:comp/env/jdbc/myJndiResource");
    bean.afterPropertiesSet();
    return (DataSource) bean.getObject();
}

Run Code Online (Sandbox Code Playgroud)

因此,您现在可以在任何Spring bean中注入DataSource,例如:

@Autowired
private DataSource jndiDataSource;

Run Code Online (Sandbox Code Playgroud)

请注意,互联网上的许多示例似乎在启动时禁用了JNDI资源的查找:

bean.setJndiName("java:comp/env/jdbc/myJndiResource");
bean.setProxyInterface(DataSource.class);
bean.setLookupOnStartup(false);
bean.afterPropertiesSet();

Run Code Online (Sandbox Code Playgroud)

但是我认为它是无助的,因为它afterPropertiesSet()在查找之后调用!

首先，非常感谢。这不仅很好地描述了如何让 JNDI 与 spring boot 2 的嵌入式 tomcat 一起工作 - 它也是我发现的唯一类似的资源之一。x100 谢谢。注意 - 我需要 setProxyInterface/setLookupOnState 调用来避免 InstanceAlreadyExistsException 异常。 (2认同)
对我来说它不适用于 Hikari，我不得不将工厂生产线更改为 `resource.setProperty("factory", "com.zaxxer.hikari.HikariJNDIFactory");`（而不是 HikariDataSource） (2认同)

Answer 4

got*_*ero 5

在 SpringBoot 2.1 中，我找到了另一个解决方案。扩展标准工厂类方法 getTomcatWebServer。然后从任何地方将其作为 bean 返回。

public class CustomTomcatServletWebServerFactory extends TomcatServletWebServerFactory {

    @Override
    protected TomcatWebServer getTomcatWebServer(Tomcat tomcat) {
        System.setProperty("catalina.useNaming", "true");
        tomcat.enableNaming();
        return new TomcatWebServer(tomcat, getPort() >= 0);
    }
}

@Component
public class TomcatConfiguration {
    @Bean
    public ConfigurableServletWebServerFactory webServerFactory() {
        TomcatServletWebServerFactory factory = new CustomTomcatServletWebServerFactory();

        return factory;
    }

Run Code Online (Sandbox Code Playgroud)

但是从 context.xml 加载资源不起作用。将尝试找出。

归档时间：	11 年，7 月前
查看次数：	95620 次
最近记录：	7 年，1 月前