前言
學過SpringBoot的話,整合Mybatis顯得十分容易,但是我們對它的實現卻十分迷茫,其實它是對Spring整合MyBatis的過程做了進一步封裝,今天我們從Spring整合MyBatis的過程說起。
1. Sping整合MyBatis
[1] 新建一個普通的Maven項目,並導入jar包
pom.xml
<dependencies>
<!--junit的測試包-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13</version>
</dependency>
<!--mysql的連接驅動包-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.47</version>
</dependency>
<!--mybatis的包-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.2</version>
</dependency>
<!--spring的相關包-->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.2.6.RELEASE</version>
</dependency>
<!--Spring操作數據庫的話,還需要一個spring-jdbc-->
<!-- https://mvnrepository.com/artifact/org.springframework/spring-jdbc -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>5.2.6.RELEASE</version>
</dependency>
<!--aop的切面包-->
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.9.1</version>
</dependency>
<!--mybatis整合Spring的包-->
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis-spring -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>2.0.3</version>
</dependency>
<!--lombok方便我們pojo類的編寫-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.4</version>
</dependency>
</dependencies>
Tips: 如果我們編寫接口實現的xml文件位於src下而不是resources下的話,我們還得加上這段關於打包的構建
<build>
<resources>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.xml</include>
</includes>
<filtering>true</filtering>
</resource>
</resources>
</build>
[2] 在resources下編寫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">
<configuration>
<typeAliases>
<package name="com.gs.pojo"/>
</typeAliases>
</configuration>
這裏我們只配置了實體類的別名,因爲我們是以Spring爲主體,所以把關於數據源的配置,Mapper包的掃描都放在Spring的配置文件上。
[3] 編寫Spring的核心配置文件
spring-dao.xml
主要步驟:
<1> 編寫數據源(這裏使用的是Spring提供的數據源)
<2> 注入SqlSessionFactoryBean(和我們mybatis所學的SqlSessionFactory功能是一致的),這裏需要以數據源作爲參數 (這裏還可以綁定我們mybatis的配置文件,可以說mybatis的配置項都可以在這裏面進行配置)
<3> 注入SqlSessionTemplate(和我們mybatis所學的SqlSession的功能是一致的),這裏需要以SqlSessionFactory作爲參數。
【由於它沒有set方法,只有通過構造器注入該參數】
作用:在我們接口的實現類中可以通過這個SqlSessionTemplate獲取相關接口下的方法。
<?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"
xsi:schemaLocation="http://www.springframework.org/schema/beans
https://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/aop
https://www.springframework.org/schema/aop/spring-aop.xsd">
<!--DataSource:使用Spring的數據源來替換Mybatis的配置 c3p0 dbcp druid
我們這裏使用Spring提供的JDBC: org.springframework.jdbc.datasource.DriverManagerDataSource
-->
<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/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8"/>
<property name="username" value="root"/>
</bean>
<!--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/gs/mapper/*.xml"/>
</bean>
<!--SqlSessionTemplate:就是我們使用的sqlSession-->
<bean id="sqlSession" class="org.mybatis.spring.SqlSessionTemplate">
<constructor-arg index="0" ref="sqlSessionFactory"/>
</bean>
</beans>
[4] 編寫pojo類及相關的接口
這裏我們在已經建立一個mybatis的數據庫和一張關於用戶的user1的表
User.class
package com.gs.pojo;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private int id;
private String name;
private String pwd;
}
UserMapper.class
package com.gs.mapper;
import com.gs.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">
<mapper namespace="com.gs.mapper.UserMapper">
<select id="selectUser" resultType="user">
select * from mybatis.user1;
</select>
</mapper>
[5] 這裏和我們直接使用Mybatis有一個很大的區別點,Mybatis的話直接new出相關的SqlSession就可以獲取這個接口的相關實現,但是Spring提倡以bean的形式注入容器,所以萬物都以對象的形式編寫後注入,這裏還需要編寫一個關於SqlSession及Mapper接口獲取操作的類
UserMapperImpl.class
作用:
1.注入SqlSessionTemplate (SqlSession)這個屬性
2.調用Mapper接口的方法
package com.gs.mapper;
import com.gs.pojo.User;
import org.mybatis.spring.SqlSessionTemplate;
import java.util.List;
/**
* @Auther: Gs
* @Date: 2020/6/17
* @Description: com.gs.mapper
* @version: 1.0
*/
public class UserMapperImpl implements UserMapper {
//在原來,我們所有的操作都使用sqlSession執行,現在使用SqlSessionTemplate
private SqlSessionTemplate sqlSession;
//這裏以set形式方便bean對於屬性的注入
public void setSqlSession(SqlSessionTemplate sqlSession) {
this.sqlSession = sqlSession;
}
@Override
public List<User> selectUser() {
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
return mapper.selectUser();
}
}
最後我們以bean的形式把這個實現類注入到我們Spring容器中
applicationContext.xml
作用:
1.整合spring的配置文件(目的是爲了解耦,後期我們如果要編寫SpringMVC的配置文件,也可以通過import的方式注入,那麼這個xml的文件的作用就非常的單一了,就是完成bean的注入)
2.完成Mapper實現類的注入
<?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"
xsi:schemaLocation="http://www.springframework.org/schema/beans
https://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/aop
https://www.springframework.org/schema/aop/spring-aop.xsd">
<!--導入spring的配置包,主要是爲了解耦。把這個類的作用歸爲bean實體類的注入-->
<import resource="spring-dao.xml"/>
<!--註冊Mapper接口的實現類,並注入參數-->
<bean id="userMapper" class="com.gs.mapper.UserMapperImpl">
<property name="sqlSession" ref="sqlSession"/>
</bean>
</beans>
[6] 編寫測試類
MyTest.class
import com.gs.mapper.UserMapper;
import com.gs.pojo.User;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
/**
* @Auther: Gs
* @Date: 2020/6/17
* @Description: PACKAGE_NAME
* @version: 1.0
*/
public class MyTest {
@Test
public void test() {
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中還提到了另一種關於整合的簡便方式-----通過SqlSessionDaoSupport完成對SqlSessionFactory以及SqlSessionTemplate的注入
第二種實現方式: 通過編寫實現類去繼承SqlSessionDaoSupport (這個類可以通過getSqlSession()獲取會話後得到Mapper接口)
UserMapperImpl2.class
package com.gs.mapper;
import com.gs.pojo.User;
import org.mybatis.spring.support.SqlSessionDaoSupport;
import java.util.List;
public class UserMapperImpl2 extends SqlSessionDaoSupport implements UserMapper {
@Override
public List<User> selectUser() {
return getSqlSession().getMapper(UserMapper.class).selectUser();
}
}
這裏我們也需要把這個類注入到容器中,並設置sqlSessionFactory這個參數
applicationContext.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"
xsi:schemaLocation="http://www.springframework.org/schema/beans
https://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.gs.mapper.UserMapperImpl">
<property name="sqlSession" ref="sqlSession"/>
</bean>
<!--注入實現類,並設置sqlSessionFactory這個參數-->
<bean id="userMapper2" class="com.gs.mapper.UserMapperImpl2">
<property name="sqlSessionFactory" ref="sqlSessionFactory"/>
</bean>
</beans>
編寫測試類:
import com.gs.mapper.UserMapper;
import com.gs.pojo.User;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class MyTest {
@Test
public void test() {
ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
UserMapper userMapper = context.getBean("userMapper2", UserMapper.class);
for (User user : userMapper.selectUser()) {
System.out.println(user);
}
}
}
這就是Spring整合mybatis的兩種方式,可能我們開發中已經不那麼常見,因爲在SpringBoot眼裏很多隻需要要一句配置或一個註解就能完成,但它底層的實現依舊是通過SqlSessionFactory和SqlSession去完成相關的步驟的,只不過它進行了高度封裝。