在mybatis与spring整合中,用原始Dao的方法来开发非常繁琐,要创建相关的接口和实现类,其中也要在每个实现类中注入sqlSessionFactory对象,这样会使项目的代码冗余,所以在与Spring项目整合中一般就不会再用原始Dao的方式来开发了,那么,在该用什么方式与spring整合呢?这里主要是基于mapper代理接口开发与Spring整合,其中与基于mapper代理接口开发的方式有以下两种:
首先引入相关的jar包(Spring框架依赖包、mybatis框架包和spring与mybatis整合包)
- 基于MapperFactoryBean整合
MapperFactoryBean是spring与mybatis整合包所提供的接口,该接口会根据mapper接口生成mapper对象的类,该接口提供了一些几个参数:
• mapperl nterface: 用于指定接口。
• SqlSessionFactory: 用于指定SqlSessionFactory。
• SqlSessionTemplate: 用于指定SqlSessionT emplate。 如果与SqlSessionFactory同时设定,则只会启用SqlSessionTemplate。
如何通过MapperFactoryBean接口把mybatis与Spring整合呢?其步骤如下:
- 在项目的src中创建com.koi.mapper包,然后把创建好的具体接口以及对应的映射文件放在同一个包下,如下图所示:
- 在UserPermissonMapper接口以及对应的sql映射文件编写相关方法:
public interface UserPermissionMapper {
/**
* 查询权限
* @return List<UPermission>
*/
List<UPermission> selectPermission();
}
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.koi.mapper.UserPermissionMapper">
<!-- 查询该用户所拥有的权限 -->
<select id="selectPermission" resultType="UPermission">
SELECT * FROM u_permission
</select>
</mapper>
- 在mybatis配置文件中配置以下配置信息:
<!-- Mapper接口开发方式一〉
<mapper resource="com/koi/mapper/UserPermissionMapper.xml" />
- 在Spring容器中配置MapperFactoryBean接口:
<!-- Mapper代理开发() -->
<bean id="UserPersssionMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
<!-- 指定接口 -->
<property name="mapperInterface" value="com.koi.mapper.UserPermissionMapper" />
<!-- 指定sqlSessionFactory -->
<property name="sqlSessionFactory" ref="sqlSessionFactory" />
</bean>
- 基于MapperScannerConfigurer整合
MapperScannerConfigurer是spring与mybatis整合包所提供的类,该类可以自动扫描的形式来配置mybatis中的映射器
• basePackage:指定映射接口文件所在的包路径,当需要扫描多个包时可以使用分号或逗
号作为分隔符。 指定包路径后,会扫描该包及其子包中的所有文件。
MapperScannerConfigurer的使用非常简单,其使用步骤如下:
- 第一步和第二步与基于MapperFactoryBean整合的前两步一样。
- 第三步,在Spring容器中配置以下信息即可:
<!--基于mapper代理开发 扫描sql映射文件 根据接口自动生成代理对象 -->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.koi.mapper"/>
</bean>
两种基于代理方式的异同点:
mapper接口编程方式只需要程序员编写Mapper接口(相当于DAO接口),然后由MyBatis
框架根据接口的定义创建接口的动态代理对象,虽然使用Mapper接口编程的方式很简单,但是在具体使用时还是需要遵循以下规范。
( 1 ) Mapper接口的名称和对应的Mapper.xml映射文件的名称必须一致。
( 2) Mapper.xml 文件中的namespace与Mapper接口的类路径相同(即接口文件和映射文件需要放在同一个包中)。
(3) Mapper接口中的方法名和Mapper.xml 中定义的每个执行语句的id相同。
(4) Mapper接口中方法的输入参数类型要和Mapper.xml中定义的每个sql 的parameterType
的类型相同。
(5) Mapper接口方法的输出参数类型要和Mapper.xml中定义的每个sql 的resultType的类型相同.
只要遵循了这些开发规范,MyBatis就可以自动生成Mapper接口实现类的代理对象,从而简化我们的开发.