sqlSessionFactory is needed when using mybatis:scan

[sinbadblue]

per the document at: http://mybatis.github.io/spring/mappers.html#scan

"Notice that there is no need to specify a SqlSessionFactory or SqlSessionTemplate because the mybatis:scan/ will create MapperFactoryBeans that can be autowired."

however, I ran into the following exception:

"Invocation of init method failed; nested exception is java.lang.IllegalArgumentException: Property 'sqlSessionFactory' or 'sqlSessionTemplate' are required"

After adding one bean definition of org.mybatis.spring.SqlSessionFactoryBean, the problem is solved.

Is the document wrong? or it only works for certain version?

I am using following version of mybatis and mybatis-spring:

org.mybatis mybatis 3.2.0 org.mybatis mybatis-spring 1.2.0

any idea?

[emacarron]

May you have disabled autowiring in that context?

[sinbadblue]

no, I didn't. for spring part, using 3.1.x. context:annotation-config + context:component-scan for my own components.

<?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"
   xmlns:mybatis="http://mybatis.org/schema/mybatis-spring"
   xsi:schemaLocation="
   http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
   http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.1.xsd
   http://mybatis.org/schema/mybatis-spring http://mybatis.org/schema/mybatis-spring.xsd">

<mybatis:scan base-package="test.data.dao"/>
<context:annotation-config/>
<context:component-scan base-package="test"/>

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

<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
    <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>

[emacarron]

Ok, it looks like a misunderstanding then.

You do not need specify a specify a SqlSessionFactory as an attribute in the mybatis:scan element but there must be an SqlSessionFactory bean in your context.

[sinbadblue]

Thanks for the clarification. But I really feel the statement about mybatis:scan is confusing.

instead of
"Notice that there is no need to specify a SqlSessionFactory or SqlSessionTemplate because the mybatis:scan/ will create MapperFactoryBeans that can be autowired."

better like
"Notice that there is no need to specify a SqlSessionFactory or SqlSessionTemplate as an attribute in the mybatis:scan element, because the mybatis:scan/ will create MapperFactoryBeans that can be autowired (using AbstractBeanDefinition.AUTOWIRE_BY_TYPE)."

something I discovered after digging into source code:

boolean explicitFactoryUsed = false;
if (StringUtils.hasText(this.sqlSessionFactoryBeanName)) {
definition.getPropertyValues().add("sqlSessionFactory", new RuntimeBeanReference(this.sqlSessionFactoryBeanName));
explicitFactoryUsed = true;
} else if (this.sqlSessionFactory != null) {
definition.getPropertyValues().add("sqlSessionFactory", this.sqlSessionFactory);
explicitFactoryUsed = true;
}

    if (StringUtils.hasText(this.sqlSessionTemplateBeanName)) {
      if (explicitFactoryUsed) {
        logger.warn("Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.");
      }
      definition.getPropertyValues().add("sqlSessionTemplate", new RuntimeBeanReference(this.sqlSessionTemplateBeanName));
      explicitFactoryUsed = true;
    } else if (this.sqlSessionTemplate != null) {
      if (explicitFactoryUsed) {
        logger.warn("Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.");
      }
      definition.getPropertyValues().add("sqlSessionTemplate", this.sqlSessionTemplate);
      explicitFactoryUsed = true;
    }

    if (!explicitFactoryUsed) {
      if (logger.isDebugEnabled()) {
        logger.debug("Enabling autowire by type for MapperFactoryBean with name '" + holder.getBeanName() + "'.");
      }
      definition.setAutowireMode(AbstractBeanDefinition.AUTOWIRE_BY_TYPE);
    }

[emacarron]

Updated.

But have ommited mentioning AbstractBeanDefinition.AUTOWIRE_BY_TYPE. It is too low level information for the docs. Will probably confuse more than clarify.

For having such level of detail you went to the right place: the code.