Spring框架内的JNDI支持

1.JNDI简单回顾

JNDI(Java Naming and Directory Interface，Java命名与目录接口)，主要目的是为了统一各种命名与目录服务的访问接口。整个JNDI的架构由API和SPI(Service Provider Interface)两部分组成。

JNDI API主要公开给Java应用程序使用，它为Java应用程序访问各种命名与目录服务提供了统一的接口。不管Java应用程序将访问的命名和目录服务如何变换，只要Java应用程序是通过JNDI API进行命名和目录服务访问的，就可以“无视”各种具体命名和目录服务的差异和变更。JNDI SPI主要公开给具体命名或者目录服务提供商使用，它为各种具体的命名和目录服务产品提供了一个扩展层。JNDI的架构设计拥有良好的通用性(从API角度)和扩展性(从SPI角度)。在JavaEE平台上，JNDI更多的是为资源的访问和部署提供一个隔离层。

 

2.Spring框架内JNDI访问的基石-JndiTemplate

 通常情况下的JNDI API的使用示例

public DataSource getDataSourceInTraditionalStyle() throws NamingException{

      HashTable env = new HashTable();

      env.put(Context.INITIAL_CONTEXT_FACTORY,"...");

      env.put(Context.PROVIDER_URL,"...");

      //其他可能的设置...

      Context context = null;

      try{

            context = new InitialContext(env);

            return (DataSource)context.lookup("jdbc/yourDataSource");

      }finally{

            if(context != null){

                   try{context.close();}

                   catch(NamingException e){e.printStackTrace();//不要这样做}

            }

      }

}

Spring框架提供了org.springframework.jndi.JndiTemplate这一Helper类以帮助我们简化一系列JNDI操作，包括对象的查找、绑定或者解除绑定等

JndiTemplate核心模板方法定义代码摘录

public Object execute(JndiCallback contextCallback)throws NamingException{

      Context ctx = createInitialContext();

      try{

            return contextCallback.doInContext(ctx);

      }finally{

            try{ctx.close();}

            catch(NamingException ex){logger.debug("Could not close JNDI InitialContext",ex);}

      }

}

JndiCallback回调接口负责提供具体的JNDI访问逻辑，而底层的JNDI基础设施管理则由当前模板方法来负责

演示使用JndiTemplate进行JNDI资源访问与传统API使用模式上的差别

public DataSource getDataSourceViaJndiTemplate() throws NamingException{

      Properties env = new Properties();

      env.setProperty(Context.INITIAL_CONTEXT_FACTORY,"...");

      env.setProperty(Context.PROVIDER_URL,"...");

      //其他可能的设置...

      JndiTemplate jndiTemplate = new JndiTemplate(env);

      return (DataSource) jndiTemplate.lookup("jdbc/yourDataSource");

}

配置代码

<bean id="jndiTemplate" class="org.springframework.jndi.JndiTemplate">

      <property name="environment">

             <props>

                    <prop key="java.naming.factory.initial">...</prop>

                    <prop key="java.naming.provider.url">...</prop>

             </props>

      </property>

</bean>

 

3.JNDI对象的依赖注入-JndiObjectFactoryBean

Spring框架提供的org.springframework.jndi.JndiObjectFactoryBean帮助我们完成更完美的任务。JndiObjectFactoryBean是Spring的FactoryBean实现类，负责根据请求的jndi名称，查找并返回绑定到JNDI服务的相应资源引用。帮助JndiObjectFactoryBean完成所有JNDI访问操作的，自然就是JndiTemplate。

public class DataDourceRequired{

     private DataSource dataSource;

     //相应的getter和setter等方法定义

     ...

}

如下的Bean定义将保证对象获取来自JNDI的DataSource引用：

<bean id="dataSource" class="org.springframework.jndi.JndiObjectFactoryBean" p:jndiName="jdbc/yourDataSource" />

<bean id="target" class="...DataSourceRequired" p:dataSource-ref="dataSource">

Spring2.0以后，以上配置内容在引入jee命名空间的XSD配置文件中可以进一步简化

<jee:jndi-lookup id="dataSource" jndi-name="jdbc/yourDataSource" />

<bean id="target" class="...DataSourceRequired" p:dataSource-ref="dataSource" />

JndiObjectFactoryBean的存在，让对象与其所依赖的对象与JNDI不发生任何的耦合

JndiObjectFactoryBean属性：

lookupOnStartup

cache

defaultObject