Spring整合Mybatis方式之注冊(cè)映射器

更新時(shí)間：2024年03月28日 09:47:27 作者：御靈之靈

這篇文章主要介紹了Spring整合Mybatis方式之注冊(cè)映射器,MapperFactoryBean注冊(cè)映射器的最大問(wèn)題,就是需要一個(gè)個(gè)注冊(cè)所有的映射器,而實(shí)際上mybatis-spring提供了掃描包下所有映射器接口的方法,每種方式給大家介紹的非常詳細(xì),需要的朋友參考下吧

前置工作

導(dǎo)包（mybatis-spring、mysql-connector-java、mybatis、spring-webmvc等）
實(shí)體類
DAO層兩個(gè)文件（接口、xml文件）；Service層的接口

編寫Spring管理mybatis的xml-spring-dao.xml

核心代碼（兩種方式實(shí)現(xiàn)）

第一種：xml

<!-- 將會(huì)話工廠對(duì)象托管給spring -->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
  <property name="dataSource" ref="dataSource" />
  <!--  配置MyBatis的全局配置文件:mybatis-config.xml -->
  <property name="configLocation" value="classpath:mybatis-config.xml"/>
  <property name="mapperLocations" value="classpath:com/ylzl/mapper/*.xml"/>
</bean>
<!-- 注冊(cè)映射器：將映射器接口托管到Spring中 -->
<bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
  <property name="sqlSessionFactory" ref="sqlSessionFactory" />
  <property name="mapperInterface" value="com.ylzl.mapper.UserMapper" />
</bean>
<!--    MapperFactoryBean對(duì)象 負(fù)責(zé) SqlSession 的創(chuàng)建和關(guān)閉，
如果使用了 Spring 事務(wù)，當(dāng)事務(wù)完成時(shí)，session 將會(huì)被提交或回滾。
最終任何異常都會(huì)被轉(zhuǎn)換成 Spring 的 DataAccessException 異常-->
<!--    mybatis映射器接口(如：interface UserMapper)：sql部分可以使用mybatis的xml配置，與接口在同一路徑下，會(huì)被 MapperFactoryBean自動(dòng)解析-->

第二種：annotation方式

@Bean
public SqlSessionFactory sqlSessionFactory() throws Exception {
  SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
  factoryBean.setDataSource(dataSource());
  return factoryBean.getObject();
}
@Bean
public MapperFactoryBean<UserMapper> userMapper() throws Exception {
    MapperFactoryBean<UserMapper> factoryBean = new MapperFactoryBean<>(UserMapper.class);
    factoryBean.setSqlSessionFactory(sqlSessionFactory());
    return factoryBean;
}

完整xml文件

<?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
        https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        https://www.springframework.org/schema/context/spring-context.xsd">
    <context:annotation-config/>
<!--    使用Spring配置dataSource 相當(dāng)于MyBatis配置文件的<environments>-->
<!--    需要spring-jdbc包-->
    <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
        <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost:3306/ssmbuild"/>
        <property name="username" value="root"/>
        <property name="password" value="root"/>
    </bean>
<!--    配置SqlSessionFactoryBean 等同于SqlSessionFactory
        做讀取數(shù)據(jù)源以及注冊(cè)mapper.xml的工作-->
<!-- SqlSessionFactoryBean會(huì)調(diào)用類中的getObject()方法，返回SqlSessionFactory-->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"/>
        <property name="mapperLocations" value="classpath:com/ylzl/mapper/BookMapper.xml"/>
    </bean>
<!--    獲得Mapper代理對(duì)象 等同于getMapper()-->
    <bean id="BookMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
        <property name="sqlSessionFactory" ref="sqlSessionFactory" />
        <property name="mapperInterface" value="com.ylzl.mapper.BookMapper" />
    </bean>
<!--    注冊(cè)employeeServiceImpl-->
    <bean id="bookServiceImpl" class="com.ylzl.service.impl.BookServiceImpl"/>
</beans>

重新編寫Service實(shí)現(xiàn)類

public class BookServiceImpl implements BookService{
    private BookMapper bookMapper;
    @Autowired //需要spring-aop包
    public BookServiceImpl(BookMapper bookMapper) {
        this.bookMapper = bookMapper;
    }
    @Override
    public Book getBookById(Integer bookID) {
        return bookMapper.getBookById(bookID);
    }
}

測(cè)試

ApplicationContext context=new ClassPathXmlApplicationContext("spring-dao.xml");
BookService bookServiceImpl = context.getBean("bookServiceImpl", BookService.class);
Book book = bookServiceImpl.getBookById(2);
System.out.println(book);

改進(jìn)注冊(cè)映射器方式：使用發(fā)現(xiàn)映射器方式

MapperFactoryBean注冊(cè)映射器的最大問(wèn)題，就是需要一個(gè)個(gè)注冊(cè)所有的映射器，而實(shí)際上mybatis-spring提供了掃描包下所有映射器接口的方法。

注意：以下兩種配置方法，均可替換上述MapperFactoryBean配置，而其余代碼與配置不變

方式一: 配置掃描器標(biāo)簽

1.與上面配置MapperFactoryBean不同，該配置無(wú)需注入SqlSessionFactory，它會(huì)自動(dòng)匹配已有的會(huì)話工廠bean

2.如果配置了多個(gè)DataSource，也就是多個(gè)sqlSessionFactory時(shí)，可以使用factory-ref參數(shù)指定需要的會(huì)話工廠

<mybatis:scan base-package="com.ylzl.dao" factory-ref="sqlSessionFactory" />
<!-- annotation方式-注解配置類：
@MapperScan(basePackages = "com.ylzl.dao", sqlSessionFactoryRef = "sqlSessionFactory") -->
<!-- 省略其他... -->

方式二: MapperScannerConfigurer類

1.與上面標(biāo)簽的功能差不多，同樣是掃描基準(zhǔn)包，自動(dòng)注入會(huì)話工廠

2.如果要更換注入的會(huì)話工廠，不同于常用的ref引入bean，而是使用value指定bean名，且屬性是sqlSessionFactoryBeanName

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
     <property name="basePackage" value="com.ylyl.mapper" />
     <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
</bean>

annotation方式

@Bean
public MapperScannerConfigurer mapperScannerConfigurer() {
    MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
    mapperScannerConfigurer.setBasePackage("com.ylzl.dao");
    mapperScannerConfigurer.setSqlSessionFactoryBeanName("sqlSessionFactory");
    return mapperScannerConfigurer;
}

圖片：