使用Spring掃描Mybatis的mapper接口的三種配置

Posted on by

Spring掃描Mybatis的mapper接口的配置

1.前言

mybatis支持與spring結合使用，使得mybatis中的mapper接口可以作為spring容器中的bean被應用代碼中相關類，如Service類，通過@Autowired自動註入進來。

在使用方面需要在項目中引入以下包：

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis-spring</artifactId>
    <version>1.3.1</version>
</dependency>

2. 在spring中可以通過三種方式

來自動掃描獲取應用代碼的mybatis相關的mapper接口定義：

2.1在applicationContext.xml中使用<mybatis:scan />

<beans xmlns="http://www.springframework.org/schema/beans"
   xmlns:context="http://www.springframework.org/schema/context"
   xmlns:tx="http://www.springframework.org/schema/tx"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   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
   http://www.springframework.org/schema/tx
   http://www.springframework.org/schema/tx/spring-tx-3.0.xsd">
 
   ...
 
    <!-- mybatis -->
   <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
     <property name="dataSource" ref="dataSource" />
     <property name="mapperLocations" value="classpath:mybatis/mapper/**/*.xml" />
     <property name="configLocation" value="classpath:mybatis/mybitas-config.xml"
        />
   </bean>
   <mybatis:scan base-package="cn.cggeeker.dao"/>
   
   ...
</beans>

2.2在applicationContext.xml中

使用bean標簽註冊MapperScannerConfigurer，即：

<beans xmlns="http://www.springframework.org/schema/beans"
   xmlns:context="http://www.springframework.org/schema/context"
   xmlns:tx="http://www.springframework.org/schema/tx"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   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
   http://www.springframework.org/schema/tx
   http://www.springframework.org/schema/tx/spring-tx-3.0.xsd">
   
   ...
   
    <!-- mybatis -->
   <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
     <property name="dataSource" ref="dataSource" />
     <property name="mapperLocations" value="classpath:mybatis/mapper/**/*.xml" />
     <property name="configLocation" value="classpath:mybatis/mybitas-config.xml"            />
   </bean>
   
   <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
     <property name="basePackage" value="cn.cggeeker.dao" />
   </bean>
   
   ...
   
</beans>

2.3如果應用是使用Java配置方式而不是XML

則在@Configuration配置類使用@MapperScan或者@MapperScans註解：

@Configuration
@MapperScan("cn.cggeeker.dao")
public class AppConfig {
 
    @Bean
    public DataSource dataSource() {
        return new PooledDataSource("com.mysql.jdbc.Driver",
                   "jdbc:mysql://localhost:3306/test", "root", "root");
    }
 
    @Bean
    public SqlSessionFactory sqlSessionFactory() throws Exception {
        SqlSessionFactoryBeansessionFactory = new SqlSessionFactoryBean();
        sessionFactory.setDataSource(dataSource());
        return sessionFactory.getObject();
    }
}

Spring配置掃描mybatis的mapper文件註意

一般會將不業務的mapper文件放到不同的包中：

spring配置掃描就需要配置下面的方式（兩個*）：

<!-- mybatis文件配置，掃描所有mapper文件 -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"
        p:dataSource-ref="dataSource" p:configLocation="classpath:conf/mybatis-config.xml"
        p:mapperLocations="classpath:mapper/**/*.xml" />

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：