使用 Spring JdbcTemplate - 注入数据源与 jdbcTemplate

Posted 2023-02-25

【中文标题】使用 Spring JdbcTemplate - 注入数据源与 jdbcTemplate

【英文标题】：using Spring JdbcTemplate - injecting datasource vs jdbcTemplate

【发布时间】：2013-07-25 22:34:57

【问题描述】：

根据 Spring documentation， Spring JdbcTemplate的使用步骤如下：

    <?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:context="http://www.springframework.org/schema/context"
        xsi:schemaLocation="
            http://www.springframework.org/schema/beans
            http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
            http://www.springframework.org/schema/context
            http://www.springframework.org/schema/context/spring-context-3.0.xsd">

        <!-- Scans within the base package of the application for @Components to configure as beans -->
        <context:component-scan base-package="org.springframework.docs.test" />

        <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
            <property name="driverClassName" value="$jdbc.driverClassName"/>
            <property name="url" value="$jdbc.url"/>
            <property name="username" value="$jdbc.username"/>
            <property name="password" value="$jdbc.password"/>
        </bean>

        <context:property-placeholder location="jdbc.properties"/>

    </beans>

然后，

    @Repository
    public class JdbcCorporateEventDao implements CorporateEventDao 

        private JdbcTemplate jdbcTemplate;

        @Autowired
        public void setDataSource(DataSource dataSource) 
            this.jdbcTemplate = new JdbcTemplate(dataSource);
        

        // JDBC-backed implementations of the methods on the CorporateEventDao follow...
    

基本上，JdbcTemplate 是在 Component 类中使用数据源的 setter 创建的。

以这种方式执行此操作是否有什么问题，以使应用程序中只有一个 jdbcTemplate 实例？

<bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate"
    p:dataSource-ref="dataSource" 
/>

然后将 jdbcTemplate 本身直接注入到组件中

@Repository
public class JdbcCorporateEventDao implements CorporateEventDao 
    @Resource("jdbcTemplate")
    private JdbcTemplate jdbcTemplate;


    // JDBC-backed implementations of the methods on the CorporateEventDao follow...

jdbcTemplate 本身不能直接注入组件类有什么原因吗？

SGB

【问题讨论】：

可能与***.com/q/9460507/309399 重复。但问题没有得到解答。

【参考方案1】：

你可以做你想做的事。 The javadoc of JdbcTemplate 竟然说得很清楚：

可以通过使用 DataSource 引用的直接实例化在服务实现中使用，或者在应用程序上下文中准备好并作为 bean 引用提供给服务。

【讨论】：

++ 链接。感谢您的简洁回答和来自 javadoc 的引用。这个特殊的问题已经困扰了我很长一段时间 - 因为我在网上看到的所有示例似乎都注入了数据源 - 让我想知道我是否遗漏了什么......

这些是微妙的细节，春天可能会误导很多人，如果有人没有读懂字里行间，比如我。

【参考方案2】：

在 spring-context.xml 中添加以下内容

<bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate">
    <property name="dataSource" ref="dataSource"/>
</bean>

你可以直接使用 jdbcTemplate 通过自动装配像

  @Autowired JdbcTemplate jdbcTemplate;

示例：

this.jdbcTemplate.query("select * from ******",new RowMapper());

【讨论】：

如何对多个数据源做同样的事情？我可以这样指定： 和另一个数据源比如 。这是将多个数据源设置为 JDBC 模板的正确方法吗

@Analysts，您应该为每个数据源定义一个单独的 jdbcTemplate。因此，如果您有 2 个数据源，则将 jdbcTemplate1 用于 datasource1，将 jdbcTemplate2 用于 datasource2。并根据需要将 jdbcTemplates 单独注入您的服务层。

@SCB 说的是对的，您必须为多个数据库拥有多个 bean。

【参考方案3】：

你也可以这样做

@Configuration
@Import(PersistenceConfig.class)
@ComponentScan(basePackageClasses =  
    ServiceMarker.class,
    RepositoryMarker.class 
)
public class AppConfig 

    /**
     * To resolve $ in @Values, you must register a static PropertySourcesPlaceholderConfigurer in either XML or 
     * annotation configuration file.
     */
    @Bean
    public static PropertySourcesPlaceholderConfigurer propertyConfigInDev() 
        return new PropertySourcesPlaceholderConfigurer();
    

持久化配置

@Configuration
@PropertySource(value =  "classpath:database/jdbc.properties" )
@EnableTransactionManagement
public class PersistenceConfig 

    @Autowired
    private Environment env;

 /**
  * The @Bean annotation is used to declare a Spring bean and the DI requirements. The @Bean annotation is equivalent to
 *  the <bean> tag, the method name is equivalent to the id attribute within the <bean> tag.
  * 
  * <bean id="mysqlDataSource" class="org.apache.commons.dbcp2.BasicDataSource" destroy-method="close" 
        p:driverClassName="$jdbc.mysql.driverClassName" 
        p:url="$jdbc.mysql.url"   
        p:username="$jdbc.mysql.username" 
        p:password="$jdbc.mysql.password" />
  * 
  * @return
  */
     @Bean(destroyMethod = "close")
     public DataSource mySqlDataSource() 
         BasicDataSource dataSource = new BasicDataSource();
         dataSource.setDriverClassName(env.getProperty("jdbc.mysql.driverClassName"));
         dataSource.setUrl(env.getProperty("jdbc.mysql.url"));
         dataSource.setUsername(env.getProperty("jdbc.mysql.username"));
         dataSource.setPassword(env.getProperty("jdbc.mysql.password"));
         return dataSource;
     

     @Bean(destroyMethod = "close")
     public DataSource ls360DataSource() 
         BasicDataSource dataSource = new BasicDataSource();
         dataSource.setDriverClassName(env.getProperty("jdbc.ls360.driverClassName"));
         dataSource.setUrl(env.getProperty("jdbc.ls360.url"));
         dataSource.setUsername(env.getProperty("jdbc.ls360.username"));
         dataSource.setPassword(env.getProperty("jdbc.ls360.password"));
         return dataSource;
      

MySqlDaoImpl

@Repository
public class MySqlDaoImpl implements MySqlDao

    private static final Logger logger = LogManager.getLogger();

    @Inject
    private DataSource mySqlDataSource;
    private JdbcTemplate mySqlJdbcTemplate;

    @PostConstruct
    public void afterPropertiesSet() throws Exception 
        if (mySqlDataSource == null) 
            throw new BeanCreationException("Must set mySqlDataSource on " + this.getClass().getName());
        
        this.mySqlJdbcTemplate = new JdbcTemplate(mySqlDataSource);
    

    @Override
    public void callStoredProcedure(String storedProcedureName, Map<String, Object> inParamMap) throws Exception 

        SimpleJdbcCall simpleJdbcCall = new SimpleJdbcCall(mySqlJdbcTemplate).withProcedureName(storedProcedureName);
        SqlParameterSource in = new MapSqlParameterSource(inParamMap);

        logger.info("Calling stored Procedure: " + storedProcedureName);
        Map<String, Object> simpleJdbcCallResult = simpleJdbcCall.execute(in);
        logger.info("Stored Procedure Result: " + simpleJdbcCallResult);
    

主要

public static void main(String[] args ) 
    try (GenericApplicationContext springContext = new AnnotationConfigApplicationContext(AppConfig.class)) 
        MySQLDao mySqlDao = springContext.getBean(MySQLDaoImpl.class);
        try 
            Map<String, Object> inParamMap = new HashMap<String, Object>();
            inParamMap.put("iCourseId", 1);
            mySqlCourseRenewalDao.callStoredProcedure("usp_processCourseRenewal", inParamMap);
         catch (Exception e) 
            logger.error("Exception occurs", e);
        
     catch (Exception e) 
        logger.error("Exception occurs in loading Spring context: ", e);
    

谢谢

【参考方案4】：

注入和共享JdbcTemplate 代替底层DataSource 在技术上没有任何问题。

但是，共享JdbcTemplate 存在一些设计缺陷，可能有利于注入DataSource：

JdbcTemplate 的使用是 DAO 的一个实现细节，我们希望隐藏这些细节 JdbcTemplate 是轻量级的，因此为了提高效率而共享它可能是过早的优化 共享JdbcTemplate 并非没有风险，因为它具有一些可变状态（除了底层DataSource 中的可变状态）

这是假设JdbcTemplate 与其默认配置（fetchSize、maxRows 等）一起使用的典型情况。如果需要配置，这可能会推动设计朝着特定方向发展，例如从上下文注入的共享预配置 JdbcTemplate，甚至是单个 DAO 拥有的多个 JdbcTemplate 实例。