Spring整合MyBatis

清風紫雪發表於2020-12-25
SpringMyBatis

整合流程

匯入相關的包

mybatis；mybatis-spring；spring-webmvc；spring-jdbc；aspectjweaver（AOP面向切面）；mysql；lombok；junit

可以參考mybitis-spring的文件進行學習：http://mybatis.org/spring/zh/index.html

<dependencies>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.3</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <version>2.0.3</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.2.4.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>1.9.4</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>5.2.4.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.18</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.10</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

配置Maven靜態資源過濾問題！

<build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>

字元編碼的問題解決：

<properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

配置資料來源

<!--DateSource:使用Spring的資料來源替換Mybatis的配置  C3P0 -->
    <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
        <property name="driverClassName" value="com.mysql.cj.jdbc.Driver" />
        <property name="url" value="jdbc:mysql://localhost:3306/company_system?useUnicode=true&amp;characterEncoding=UTF-8&amp;serverTimezone=GMT" />
        <property name="username" value="root" />
        <property name="password" value="fengge666" />
    </bean>

建立sqlSessionFactory和對應的sqlSession物件，繫結mybatis配置檔案

在 MyBatis-Spring 中，可使用SqlSessionFactoryBean來建立 SqlSessionFactory。要配置這個工廠 bean，只需要把下面程式碼放在 Spring 的 XML 配置檔案中：

在基礎的 MyBatis 用法中，是通過 SqlSessionFactoryBuilder 來建立 SqlSessionFactory 的。而在 MyBatis-Spring 中，則使用 SqlSessionFactoryBean 來建立。

一個常用的屬性是 configLocation，它用來指定 MyBatis 的 XML 配置檔案路徑。它在需要修改 MyBatis 的基礎配置非常有用。通常，基礎配置指的是 < settings> 或 < typeAliases>元素。

SqlSessionTemplate 是 MyBatis-Spring 的核心。作為 SqlSession 的一個實現，這意味著可以使用它無縫代替你程式碼中已經在使用的 SqlSession。

可以使用 SqlSessionFactory 作為構造方法的引數來建立 SqlSessionTemplate 物件。

<!--sqlSessionFactory-->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource" />
        <!--繫結mybatis配置檔案 -->
        <property name="configLocation" value="classpath:mybatis-config.xml" />
        <property name="mapperLocations" value="classpath:com/xlf/mapper/*.xml" />
    </bean>

    <bean id="sqlSession" class="org.mybatis.spring.SqlSessionTemplate">
        <constructor-arg index="0" ref="sqlSessionFactory" />
    </bean>

mapperLocations指定mapper目錄下的所有xml檔案

configLocation對應mybatis的配置檔案路徑

 

mybatis-config.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">
<!-- mybaties的主配置檔案-->
<configuration>
    <!-- 配置類的別名-->
    <typeAliases>
        <package name="com.xlf.pojo"/>
    </typeAliases>

</configuration>

程式碼編寫

建立使用者類：此處用了lombok的Data註解，便不需要構建get和set方法

package com.xlf.pojo;

import lombok.Data;

@Data
public class User {

    private String corpname;
    private String type;
    private String username;


}

建立介面，對應的xml，以及相應的實現類

UserMapper.java

package com.xlf.mapper;

import com.xlf.pojo.User;

import java.util.List;

public interface UserMapper {

    public List<User> selectUser();

}

UserMapper.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!-- mybaties的主配置檔案-->
<mapper namespace="com.xlf.mapper.UserMapper">
    
    <select id="selectUser" resultType="user">
        select * from qiye
    </select>
    
    
</mapper>

UserMapperImpl.java：私有化sqlSessionTemplate

package com.xlf.mapper;

import com.xlf.pojo.User;
import org.apache.ibatis.session.SqlSession;
import org.mybatis.spring.SqlSessionTemplate;

import java.util.List;

public class UserMapperImpl implements UserMapper {

    private SqlSessionTemplate sqlSession;

    public void setSqlSession(SqlSessionTemplate sqlSession) {
        this.sqlSession = sqlSession;
    }

    @Override
    public List<User> selectUser() {
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        return mapper.selectUser();
    }
}

建立applicationContext.xml來進行xml的整合，以便於之後實現類的註冊，將實現類UserMapperImpl註冊，之後所有的實現類的註冊只需寫到applicationContext.xml即可

spring-dao.xml只需負責資料來源，sqlSessionFactory與sqlSession的建立即可

mybatis-config.xml只需指定類的別名即可，其實也可以直接在sqlSessionFactory內進行繫結，不過為了突出使用了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:aop="http://www.springframework.org/schema/aop"
       xmlns:asp="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/aop https://www.springframework.org/schema/aop/spring-aop.xsd">

    <import resource="spring-dao.xml" />

    <bean id="userMapper" class="com.xlf.mapper.UserMapperImpl">
        <property name="sqlSession" ref="sqlSession" />
    </bean>


</beans>

對於，spring-dao.xml就是一個模板，可能更換專案只需要修改這三個

 

 進行測試：

測試中，只需要取出對應的bean物件，也就是userMapper，然後呼叫其方法即可

@Test
    public void f() throws IOException {

        ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
        UserMapper userMapper = context.getBean("userMapper", UserMapper.class);
        for (User user : userMapper.selectUser()) {
            System.out.println(user);
        }

    }

輸出：

 

 

至此，spring整合mybatis就完畢了。

總結：相較於之前mybatis的編寫，spring整合多出了一個實現類，通過將實現類在spring的xml中註冊，然後通過context獲取bean來呼叫其方法

也不必在寫一個sqlSession物件獲取的類，可以直接使用session物件。

相關文章