你所不知的spring與mybatis整合方法

時間 2019-12-06

原文原文鏈接

內容目錄

一、採用MapperScannerConfigurer 二、採用接口org.apache.ibatis.session.SqlSession的實現類org.mybatis.spring.SqlSessionTemplate 三、採用抽象類org.mybatis.spring.support.SqlSessionDaoSupport提供SqlSessionjava

1、採用MapperScannerConfigurer

它將會查找類路徑下的映射器並自動將它們建立成MapperFactoryBean。spring

spring-mybatis.xml:sql

<?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:p="http://www.springframework.org/schema/p"
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    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://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd">
    <!-- 自動掃描 -->
    <context:component-scan base-package="com.hua.saf" />
    <!-- 引入配置文件 -->
    <bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
        <property name="location" value="classpath:jdbc.properties" />
    </bean>

    <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
        <property name="driverClassName" value="${driver}" />
        <property name="url" value="${url}" />
        <property name="username" value="${username}" />
        <property name="password" value="${password}" />
        <!-- 初始化鏈接大小 -->
        <property name="initialSize" value="${initialSize}" />
        <!-- 鏈接池最大數量 -->
        <property name="maxActive" value="${maxActive}" />
        <!-- 鏈接池最大空閒 -->
        <property name="maxIdle" value="${maxIdle}" />
        <!-- 鏈接池最小空閒 -->
        <property name="minIdle" value="${minIdle}" />
        <!-- 獲取鏈接最大等待時間 -->
        <property name="maxWait" value="${maxWait}" />
    </bean>

    <!-- spring和MyBatis完美整合，不須要mybatis的配置映射文件 -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource" />
        <!-- 自動掃描mapping.xml文件，**表示迭代查找 -->
        <property name="mapperLocations" value="classpath:com/hua/saf/**/*.xml" />
    </bean>

    <!-- DAO接口所在包名，Spring會自動查找其下的類 ,包下的類須要使用@MapperScan註解,不然容器注入會失敗 -->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <property name="basePackage" value="com.hua.saf.*" />
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
    </bean>

    <!-- (事務管理)transaction manager, use JtaTransactionManager for global tx -->
    <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <property name="dataSource" ref="dataSource" />
    </bean>    
</beans>
複製代碼

UserMapper.xml:apache

<?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，namespace的值習慣上設置成包名+sql映射文件名，這樣就可以保證namespace的值是惟一的
例如namespace="me.gacl.mapping.userMapper"就是me.gacl.mapping(包名)+userMapper(userMapper.xml文件去除後綴)
-->
<mapper namespace="com.hua.saf.dao.UserDao">
&emsp;&emsp;<!-- 
&emsp;&emsp;在select標籤中編寫查詢的SQL語句， 設置select標籤的id屬性爲getUser，id屬性值必須是惟一的，不可以重複,
&emsp;&emsp;使用parameterType屬性指明查詢時使用的參數類型，resultType屬性指明查詢返回的結果集類型
&emsp;&emsp;resultType="com.hua.saf.User"就表示將查詢結果封裝成一個User類的對象返回,User類就是t_user表所對應的實體類
&emsp;&emsp;-->
&emsp;&emsp;<!-- 根據id查詢獲得一個user對象-->
&emsp;&emsp;<select id="getUser" parameterType="int" resultType="com.hua.saf.pojo.User">
&emsp;&emsp;&emsp;&emsp;select * from t_user where id=#{id}
&emsp;&emsp;</select>
</mapper>
複製代碼

dao類：spring-mvc

/** 
* 這裏的@MapperScan就是上面所講的Mapper掃描器中所須要的配置，會自動生成代理對象。 
* 注意，接口中的方法名稱要和對應的MyBatis映射文件中的語句的id值同樣，由於生成的 
* 動態代理，會根據這個匹配相應的Sql語句執行。另外就是方法的參數和返回值也須要注 
* 意。接口中的方法如何定義，對應的MyBatis映射文件就應該進行相應的定義。 
* 最後，標註中的userDao是用來做爲Spring的Bean的id(或name)進行使用的，方便我 
* 們在Service層進行注入使用。 
*/ 

@MapperScan
public interface UserDao {
&emsp;&emsp;//此處的方法名必須和mapper中的映射文件中的id同名
&emsp;&emsp;//回去映射文件中經過com.hua.saf.dao.UserDao.getUser,即this.getClass().getName()+".getUser"
&emsp;&emsp;public User getUser(int id);
}
複製代碼

service類：bash

@Service("userService")
public class UserServiceImpl implements IUserService {

@Resource
private UserDao userDao;

&emsp;&emsp;public User getUser(int id) {
&emsp;&emsp;&emsp;&emsp;return userDao.getUser(id);
&emsp;&emsp;}
}
複製代碼

2、採用接口org.apache.ibatis.session.SqlSession的實現類org.mybatis.spring.SqlSessionTemplate

mybatis中, sessionFactory可由SqlSessionFactoryBuilder.來建立。MyBatis-Spring 中，使用了SqlSessionFactoryBean來替代。SqlSessionFactoryBean有一個必須屬性dataSource，另外其還有一個通用屬性configLocation（用來指定mybatis的xml配置文件路徑）。session

spring-mybatis.xmlmybatis

<?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:p="http://www.springframework.org/schema/p"
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    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://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd">
    <!-- 自動掃描 -->
    <context:component-scan base-package="com.hua.saf" />
    <!-- 引入配置文件 -->
    <bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
        <property name="location" value="classpath:jdbc.properties" />
    </bean>

    <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
        <property name="driverClassName" value="${driver}" />
        <property name="url" value="${url}" />
        <property name="username" value="${username}" />
        <property name="password" value="${password}" />
        <!-- 初始化鏈接大小 -->
        <property name="initialSize" value="${initialSize}" />
        <!-- 鏈接池最大數量 -->
        <property name="maxActive" value="${maxActive}" />
        <!-- 鏈接池最大空閒 -->
        <property name="maxIdle" value="${maxIdle}" />
        <!-- 鏈接池最小空閒 -->
        <property name="minIdle" value="${minIdle}" />
        <!-- 獲取鏈接最大等待時間 -->
        <property name="maxWait" value="${maxWait}" />
    </bean>

    <!-- spring和MyBatis完美整合，不須要mybatis的配置映射文件 -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource" />
        <property name="configLocation"  value="classpath:sqlMapConfig.xml"/>
        <!-- 自動掃描mapping.xml文件，**表示迭代查找,也可在sqlMapConfig.xml中單獨指定xml文件-->
        <property name="mapperLocations" value="classpath:com/hua/saf/**/*.xml" />
    </bean>

    <!-- mybatis spring sqlSessionTemplate,使用時直接讓spring注入便可 -->
    <bean id="sqlSessionTemplate" class="org.mybatis.spring.SqlSessionTemplate">
        <constructor-arg index="0" ref="sqlSessionFactory"></constructor-arg>
    </bean>

    <!-- (事務管理)transaction manager, use JtaTransactionManager for global tx -->
    <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <property name="dataSource" ref="dataSource" />
    </bean>
</beans>
複製代碼

sqlMapConfig.xmlmvc

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration PUBLIC  
    "-//mybatis.org//DTD Config 3.0//EN"  
    "http://mybatis.org/dtd/mybatis-3-config.dtd">  
<configuration>  
    <typeAliases>
        <typeAlias type="com.hua.saf.pojo.User" alias="User" />
    </typeAliases>
</configuration>
複製代碼

User.javaapp

public class User {

    private int id;
    private String username;
    private String password;
    private int age;

    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
}
複製代碼

UserDao.java

@Repository
public class UserDao{

    @Resource
    private SqlSessionTemplate sqlSessionTemplate;

    public User getUser(int id) {
        return sqlSessionTemplate.selectOne(this.getClass().getName() + ".getUser", 1);
    }   
}
複製代碼

UserService.java

@Service
public class UserService{

    @Resource
    private UserDao userDao;

    public User getUser(int id) {
        return userDao.getUser(id);
    }
}
複製代碼

3、採用抽象類org.mybatis.spring.support.SqlSessionDaoSupport提供SqlSession

spring-mybatis.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:p="http://www.springframework.org/schema/p"
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    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://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd">
    <!-- 自動掃描 -->
    <context:component-scan base-package="com.hua.saf" />
    <!-- 引入配置文件 -->
    <bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
        <property name="location" value="classpath:jdbc.properties" />
    </bean>

    <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
        <property name="driverClassName" value="${driver}" />
        <property name="url" value="${url}" />
        <property name="username" value="${username}" />
        <property name="password" value="${password}" />
        <!-- 初始化鏈接大小 -->
        <property name="initialSize" value="${initialSize}" />
        <!-- 鏈接池最大數量 -->
        <property name="maxActive" value="${maxActive}" />
        <!-- 鏈接池最大空閒 -->
        <property name="maxIdle" value="${maxIdle}" />
        <!-- 鏈接池最小空閒 -->
        <property name="minIdle" value="${minIdle}" />
        <!-- 獲取鏈接最大等待時間 -->
        <property name="maxWait" value="${maxWait}" />
    </bean>

    <!-- spring和MyBatis完美整合，不須要mybatis的配置映射文件 -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource" />
        <property name="configLocation"  value="classpath:sqlMapConfig.xml"/>
        <!-- 自動掃描mapping.xml文件，**表示迭代查找,也可在sqlMapConfig.xml中單獨指定xml文件-->
        <property name="mapperLocations" value="classpath:com/hua/saf/**/*.xml" />
    </bean>

    <!-- (事務管理)transaction manager, use JtaTransactionManager for global tx -->
    <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <property name="dataSource" ref="dataSource" />
    </bean>
</beans>
複製代碼

sqlMapConfig.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration PUBLIC  
    "-//mybatis.org//DTD Config 3.0//EN"  
    "http://mybatis.org/dtd/mybatis-3-config.dtd">  
<configuration>  
    <typeAliases>
        <typeAlias type="com.hua.saf.pojo.User" alias="User" />
    </typeAliases>
</configuration>
複製代碼

User.java

public class User {

    private int id;
    private String username;
    private String password;
    private int age;


    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
}
複製代碼

UserDao.java

@Repository
public class UserDao extends SqlSessionDaoSupport{

    public User getUser(int id) {
        return this.getSqlSession().selectOne(this.getClass().getName() + ".getUser", 1);
    }
&emsp;&emsp;//使用SqlSessionDaoSupport必須注意，此處源碼1.1.1中有自動注入，1.2中取消了自動注入，須要手工注入，侵入性強
&emsp;&emsp;//也可在spring-mybatis.xml中以下配置，可是這種有多少個dao就要配置到少個，多個dao就很麻煩。
&emsp;&emsp;//<bean id="userDao" class="com.hua.saf.dao.UserDao">
&emsp;&emsp;//    <property name="sqlSessionFactory" ref="sqlSessionFactory"/>
&emsp;&emsp;//</bean>
    @Resource
    public void setSqlSessionFactory(SqlSessionFactory sqlSessionFactory) {
        // TODO Auto-generated method stub
        super.setSqlSessionFactory(sqlSessionFactory);
    }
}
複製代碼

UserService.java

@Service
public class UserService{

    @Resource
    private UserDao userDao;

    public User getUserss(int id) {
        return userDao.getUser(1);
    }
}
複製代碼