自己定制spring的数据源

说明：本文摘自优快云的一位网友的博客。

最近在做项目，开发时是通过driver创建datasource的，配置如下

 

[xml] view plain copy print ?

1. <beanid="dataSource"class="org.springframework.jdbc.datasource.DriverManagerDataSource"> 
2.  
3.     <propertyname="driverClassName"value="${dataSource.driverClassName}"/> 
4.  
5.     <propertyname="url"value="${dataSource.url}"/> 
6.  
7.     <propertyname="username"value="${dataSource.username}"/> 
8.  
9.     <propertyname="password"value="${dataSource.password}"/> 
10.  
11. </bean> 

<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">

    <property name="driverClassName" value="${dataSource.driverClassName}" />

    <property name="url" value="${dataSource.url}" />

    <property name="username" value="${dataSource.username}" />

    <property name="password" value="${dataSource.password}" />

</bean>

实施时是通过jndi查找得到datasource，配置如下：

[xml] view plain copy print ?

1. <beanid="dataSource"class="org.springframework.jndi.JndiObjectFactoryBean"> 
2.  
3.     <propertyname="jndiName"value="${dataSource.jndiName}"/> 
4.  
5. </bean> 

<bean id="dataSource" class="org.springframework.jndi.JndiObjectFactoryBean">

    <property name="jndiName" value="${dataSource.jndiName}" />

</bean>

其中属性文件是通过propertyConfigurer导入的：

[xml] view plain copy print ?

1. <beanid="propertyConfigurer"  
2.  
3.     class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer" 
4.  
5.     dependency-check="none"> 
6.  
7.     <propertyname="fileEncoding"value="UTF-8"/> 
8.  
9.     <propertyname="locations"> 
10.  
11.         <list> 
12.  
13.             <value>classpath:spring-app.properties</value> 
14.  
15.         </list> 
16.  
17.     </property> 
18.  
19. </bean> 

<bean id="propertyConfigurer" 

    class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"

    dependency-check="none">

    <property name="fileEncoding" value="UTF-8" />

    <property name="locations">

        <list>

            <value>classpath:spring-app.properties</value>

        </list>

    </property>

</bean>

属性 文件的内容如下：

[java] view plain copy print ?

1. dataSource.jndiName=jdbc/myDataSource 
2.  
3. dataSource.driverClassName=oracle.jdbc.driver.OracleDriver 
4.  
5. dataSource.url=jdbc:oracle:thin:@localhost:1521:myServId 
6.  
7. dataSource.username=myUser 
8.  
9. dataSource.password=myPassword 

dataSource.jndiName=jdbc/myDataSource

dataSource.driverClassName=oracle.jdbc.driver.OracleDriver

dataSource.url=jdbc:oracle:thin:@localhost:1521:myServId

dataSource.username=myUser

dataSource.password=myPassword

　　采用上面这种方式，在每次部署的时候都要修改applicationContext.xml的dataSource配置，有点麻烦 通过学习 JndiObjectFactoryBean 的代码，自己写了一个数据源的工厂类：

[java] view plain copy print ?

1. package laochake.spring.datasource; 
2.  
3. import javax.naming.NamingException; 
4.  
5. import javax.sql.DataSource; 
6.  
7. import org.springframework.beans.factory.FactoryBean; 
8.  
9. import org.springframework.beans.factory.InitializingBean; 
10.  
11. import org.springframework.jdbc.datasource.DriverManagerDataSource; 
12.  
13. import org.springframework.jndi.JndiLocatorSupport; 
14.  
15. import org.springframework.util.StringUtils; 
16.  
17. /**
19. * 数据源工厂bean，通过 jndi 属性判断是从jndi取得数据源还是用jdbc驱动创建数据源<br>
21. * 设计此类的目的是简化部署时的配置，即只同过设置定jndi的值就可以自动切换数据源的获取方式
23. * @author laochake
25. * @since 2007-12-13 下午01:26:46
27. */ 
28.  
29. public class DataSourceFactoryBeanimplements FactoryBean,InitializingBean { 
30.  
31.    
32.  
33. /**缓存数据源对象*/ 
34.  
35. private DataSource dataSource; 
36.  
37. /**是否jndi数据源*/ 
38.  
39. private boolean jndi; 
40.  
41. /**数据源的名字（如果是jndi数据源）*/ 
42.  
43. private String jndiName; 
44.  
45. /**jdbc驱动类(非jndi的情况)*/ 
46.  
47. private String driverClassName; 
48.  
49. /**数据库的url(非jndi的情况)*/ 
50.  
51. private String url; 
52.  
53. /**用户名(非jndi的情况)*/ 
54.  
55. private String username; 
56.  
57. /**密码(非jndi的情况)*/ 
58.  
59. private String password; 
60.  
61.  
62.  
63. //TODO:此处省略了属性的set方法 
64.  
65.  
66.  
67. /**
69. * 初始化
71. * @author laochake
73. * @since 2007-12-13 下午01:48:03
75. * @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet()
77. */ 
78.  
79. public void afterPropertiesSet()throws Exception { 
80.  
81.    if(this.isJndi()){ 
82.  
83.     if (!StringUtils.hasText(this.jndiName)) { 
84.  
85.      throw new IllegalArgumentException("jndiName is required"); 
86.  
87.     } 
88.  
89.    }else{ 
90.  
91.     if (!StringUtils.hasText(this.driverClassName)) { 
92.  
93.      throw new IllegalArgumentException("driverClassName is required"); 
94.  
95.     } 
96.  
97.     if (!StringUtils.hasText(this.url)) { 
98.  
99.      throw new IllegalArgumentException("url is required"); 
100.  
101.     } 
102.  
103.     if (!StringUtils.hasText(this.username)) { 
104.  
105.      throw new IllegalArgumentException("username is required"); 
106.  
107.     } 
108.  
109.     if (!StringUtils.hasText(this.password)) { 
110.  
111.      throw new IllegalArgumentException("password is required"); 
112.  
113.     } 
114.  
115.    } 
116.  
117.    //在初始化时就创建数据源 
118.  
119.    this.createDataSource(); 
120.  
121. } 
122.  
123. /**
125. * 实现 FactoryBean 的方法，取得对象
127. * @author laochake
129. * @since 2007-12-13 下午01:33:35
131. * @see org.springframework.beans.factory.FactoryBean#getObject()
133. */ 
134.  
135. public Object getObject() { 
136.  
137.    DataSource ds = this.createDataSource(); 
138.  
139.    return ds; 
140.  
141. } 
142.  
143.  
144.  
145. /**
147. * 创建数据源对象，并保存到 this.dataSource属性
149. * @author laochake
151. * @since 2007-12-13 下午01:46:44
153. * @return
155. */ 
156.  
157. protected DataSource createDataSource(){ 
158.  
159.    DataSource ds = this.dataSource; 
160.  
161.    if(ds==null){ 
162.  
163.     try{ 
164.  
165.      if(this.isJndi()){ 
166.  
167.       ds = new JndiDataSourceSupport().lookupDataSource(this.jndiName); 
168.  
169.      }else{ 
170.  
171.       ds=new DriverManagerDataSource(driverClassName, url, username, password); 
172.  
173.      } 
174.  
175.     }catch(Throwable err){ 
176.  
177.      throw new RuntimeException(err); 
178.  
179.     } 
180.  
181.    } 
182.  
183.    this.dataSource=ds; 
184.  
185.    return ds; 
186.  
187. } 
188.  
189. /**
191. * 实现 FactoryBean 的方法，取得工厂创建的对象类型
193. * @author laochake
195. * @since 2007-12-13 下午01:42:57
197. * @see org.springframework.beans.factory.FactoryBean#getObjectType()
199. */ 
200.  
201. public Class getObjectType() { 
202.  
203.    return javax.sql.DataSource.class; 
204.  
205. } 
206.  
207.  
208.  
209. /**
211. * 实现 FactoryBean 的方法，是否单例模式(始终返回true)
213. * @author laochake
215. * @since 2007-12-13 下午01:43:29
217. * @see org.springframework.beans.factory.FactoryBean#isSingleton()
219. */ 
220.  
221. public boolean isSingleton() { 
222.  
223.    return true; 
224.  
225. } 
226.  
227. /**
229. * jndi数据源查找类(内部私有类)
231. * @author laochake
233. * @since 2007-12-13 下午01:49:09
235. */ 
236.  
237. private class JndiDataSourceSupportextends JndiLocatorSupport{ 
238.  
239.    public DataSource lookupDataSource(String jndiName)throws NamingException{ 
240.  
241.     return (DataSource)super.lookup(jndiName, javax.sql.DataSource.class); 
242.  
243.    } 
244.  
245. } 
246.  
247.  
248.  
249. } 

package laochake.spring.datasource;

import javax.naming.NamingException;

import javax.sql.DataSource;

import org.springframework.beans.factory.FactoryBean;

import org.springframework.beans.factory.InitializingBean;

import org.springframework.jdbc.datasource.DriverManagerDataSource;

import org.springframework.jndi.JndiLocatorSupport;

import org.springframework.util.StringUtils;

/**

* 数据源工厂bean，通过 jndi 属性判断是从jndi取得数据源还是用jdbc驱动创建数据源<br>

* 设计此类的目的是简化部署时的配置，即只同过设置定jndi的值就可以自动切换数据源的获取方式

* @author laochake

* @since 2007-12-13 下午01:26:46

*/

public class DataSourceFactoryBean implements FactoryBean,InitializingBean {

  

/**缓存数据源对象*/

private DataSource dataSource;

/**是否jndi数据源*/

private boolean jndi;

/**数据源的名字（如果是jndi数据源）*/

private String jndiName;

/**jdbc驱动类(非jndi的情况)*/

private String driverClassName;

/**数据库的url(非jndi的情况)*/

private String url;

/**用户名(非jndi的情况)*/

private String username;

/**密码(非jndi的情况)*/

private String password;



//TODO:此处省略了属性的set方法



/**

* 初始化

* @author laochake

* @since 2007-12-13 下午01:48:03

* @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet()

*/

public void afterPropertiesSet() throws Exception {

   if(this.isJndi()){

    if (!StringUtils.hasText(this.jndiName)) {

     throw new IllegalArgumentException("jndiName is required");

    }

   }else{

    if (!StringUtils.hasText(this.driverClassName)) {

     throw new IllegalArgumentException("driverClassName is required");

    }

    if (!StringUtils.hasText(this.url)) {

     throw new IllegalArgumentException("url is required");

    }

    if (!StringUtils.hasText(this.username)) {

     throw new IllegalArgumentException("username is required");

    }

    if (!StringUtils.hasText(this.password)) {

     throw new IllegalArgumentException("password is required");

    }

   }

   //在初始化时就创建数据源

   this.createDataSource();

}

/**

* 实现 FactoryBean 的方法，取得对象

* @author laochake

* @since 2007-12-13 下午01:33:35

* @see org.springframework.beans.factory.FactoryBean#getObject()

*/

public Object getObject() {

   DataSource ds = this.createDataSource();

   return ds;

}



/**

* 创建数据源对象，并保存到 this.dataSource属性

* @author laochake

* @since 2007-12-13 下午01:46:44

* @return

*/

protected DataSource createDataSource(){

   DataSource ds = this.dataSource;

   if(ds==null){

    try{

     if(this.isJndi()){

      ds = new JndiDataSourceSupport().lookupDataSource(this.jndiName);

     }else{

      ds=new DriverManagerDataSource(driverClassName, url, username, password);

     }

    }catch(Throwable err){

     throw new RuntimeException(err);

    }

   }

   this.dataSource=ds;

   return ds;

}

/**

* 实现 FactoryBean 的方法，取得工厂创建的对象类型

* @author laochake

* @since 2007-12-13 下午01:42:57

* @see org.springframework.beans.factory.FactoryBean#getObjectType()

*/

public Class getObjectType() {

   return javax.sql.DataSource.class;

}



/**

* 实现 FactoryBean 的方法，是否单例模式(始终返回true)

* @author laochake

* @since 2007-12-13 下午01:43:29

* @see org.springframework.beans.factory.FactoryBean#isSingleton()

*/

public boolean isSingleton() {

   return true;

}

/**

* jndi数据源查找类(内部私有类)

* @author laochake

* @since 2007-12-13 下午01:49:09

*/

private class JndiDataSourceSupport extends JndiLocatorSupport{

   public DataSource lookupDataSource(String jndiName) throws NamingException{

    return (DataSource)super.lookup(jndiName, javax.sql.DataSource.class);

   }

}



}

　　使用以上定义类，新的dataSource定义方式如下：

 

[xml] view plain copy print ?

1. <beanid="dataSource"class="com.gdcn.spring.datasource.DataSourceFactoryBean"> 
2.  
3.     <description><![CDATA[ 数据源定义 ]]></description> 
4.  
5.     <propertyname="jndi"value="${dataSource.IS_JNDI}"/> 
6.  
7.     <propertyname="jndiName"value="${dataSource.jndiName}"/> 
8.  
9.     <propertyname="driverClassName"value="${dataSource.driverClassName}"/> 
10.  
11.     <propertyname="url"value="${dataSource.url}"/> 
12.  
13.     <propertyname="username"value="${dataSource.username}"/> 
14.  
15.     <propertyname="password"value="${dataSource.password}"/> 
16.  
17. </bean> 

<bean id="dataSource" class="com.gdcn.spring.datasource.DataSourceFactoryBean">

    <description><![CDATA[ 数据源定义 ]]></description>

    <property name="jndi" value="${dataSource.IS_JNDI}" />

    <property name="jndiName" value="${dataSource.jndiName}" />

    <property name="driverClassName" value="${dataSource.driverClassName}" />

    <property name="url" value="${dataSource.url}" />

    <property name="username" value="${dataSource.username}" />

    <property name="password" value="${dataSource.password}" />

</bean>

修改后的属性 文件的内容如下：

[java] view plain copy print ?

1. dataSource.IS_JNDI=true 
2.  
3. dataSource.jndiName=jdbc/myDataSource 
4.  
5. dataSource.driverClassName=oracle.jdbc.driver.OracleDriver 
6.  
7. dataSource.url=jdbc:oracle:thin:@localhost:1521:myServId 
8.  
9. dataSource.username=myUser 
10.  
11. dataSource.password=myPassword 
12. 　　 

dataSource.IS_JNDI=true

dataSource.jndiName=jdbc/myDataSource

dataSource.driverClassName=oracle.jdbc.driver.OracleDriver

dataSource.url=jdbc:oracle:thin:@localhost:1521:myServId

dataSource.username=myUser

dataSource.password=myPassword
　　

　　在部署应用时，如果使用jdbc驱动创建数据源，则IS_JNDI=false 如果使用jndi查找得到数据源，则IS_JNDI=true。

　　可见第二种方式的配置简单了很多，只通过修改dataSource.IS_JNDI就能实现 datasource获取方式的切换。