Spring-Mybatis
spring是一个大杂烩，可以整合很多第三方的框架；mybatis是一款轻量级的、半自动化的、支持对象关系映射的持久化框架。项目中使用两者的频率比较多，以下是关于spring整合mybatis的步骤：
1、搭建环境
在使用spring整合mybatis之前，先构建以下环境，让整个整合的过程基于以下环境进行：
导入相关的jar包
<dependencies>
<!-- spring相关jar -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.2.0.RELEASE</version>
</dependency>
<!-- junit测试jar -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
<!-- aspectjweaver面向切面相关jar -->
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.9.6</version>
<scope>runtime</scope>
</dependency>
<!-- mysql驱动jar -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.19</version>
</dependency>
<!-- spring jdbc支持的jar -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>5.2.0.RELEASE</version>
</dependency>
<!-- lombok支持的jar -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.16</version>
</dependency>
<!-- mybatis的jar -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.6</version>
</dependency>
<!-- spring整合mybatis的jar-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>2.0.6</version>
</dependency>
</dependencies>
在pom.xml文件配置静态资源导出，否则会出现包内的配置文件无法导出的情况
<build>
<resources>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>false</filtering>
</resource>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>false</filtering>
</resource>
</resources>
</build>
创建一个数据库表
-- 创建一个用户表
CREATE TABLE user
(
id INT AUTO_INCREMENT
COMMENT '自增的用户id'
PRIMARY KEY,
username VARCHAR(20) NOT NULL
COMMENT '用户名',
birthday DATE NULL
COMMENT '注册时间',
gender VARCHAR(7) NULL
COMMENT '性别',
address VARCHAR(256) NULL
COMMENT '地址'
);
编写表对应的pojo类
package com.zero.pojo;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.util.Date;
/**
* 与数据库表对应的User实体类
*/
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
//用户id
private long id;
//用户名
private String username;
//出生日期
private Date birthday;
//性别
private String gender;
//住址
private String address;
}
编写dao接口
package com.zero.dao;
import com.zero.pojo.User;
import org.apache.ibatis.annotations.Param;
import java.util.List;
/**
* 关于User类的dao层接口
*/
public interface UserMapper {
/**
* 获得所有用户
* @return 返回所有用户
*/
List<User> getAllUser();
/**
* 根据用户id获得用户信息
* @param id 用户id
* @return 返回指定id的用户
*/
User getUserById(@Param("id") long id);
}
编写dao层接口对应的mapper.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.zero.dao.UserMapper">
<select id="getAllUser" resultType="user">
SELECT * FROM mybatis.`user`
</select>
<select id="getUserById" resultType="user" parameterType="_long">
SELECT * FROM mybatis.`user`
<where>
id = #{id}
</where>
</select>
</mapper>
2、编写mybatis的核心配置文件
在核心配置文件中只留下配置项和起别名的项，其他的交给spring类管理（如果不想要该配置文件，也可以将里面的配置全交给spring来管理，仅需将其删掉即可）。
<?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>
<!-- 开启日志 -->
<settings>
<setting name="logImpl" value="STDOUT_LOGGING"/>
</settings>
<!-- 给com.zero.pojo包下的所有类起别名，其别名为其类名首字母小写 -->
<typeAliases>
<package name="com.zero.pojo" />
</typeAliases>
</configuration>
3、编写spring关于dao层的配置文件
spring整合mybatis的过程参照以下的流程，只不过在整合的jar包中提供了不同的类来创建以下的对象，主要有以下几点不同：
- 使用SqlSessionFactoryBean类来创建SqlSessionFactory对象，并将读取配置文件当作属性注入该类bean对象中
- 使用SqlSessionTemplate来替代SqlSession对象，线程上更安全
- 使用MapperFactoryBean类来替换SqlSessionTemplate对象获得接口实现类对象的操作
使用spring-jdbc的DriverManagerDataSource类配置数据源(可以使用其他数据源)
<!-- 给org.springframework.jdbc.datasource.DriverManagerDataSource类配置bean对象 -->
<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
<!-- 注入驱动类名 -->
<property name="driverClassName" value="com.mysql.cj.jdbc.Driver"/>
<!-- 注入url-->
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=UTC"/>
<!-- 注入用户名 -->
<property name="username" value="root"/>
<!-- 注入用户密码 -->
<property name="password" value="root"/>
</bean>
给SqlSessionFactory类配置bean对象（通过SqlSessionFactoryBean类实现）
<!-- 配置SqlSessionFactory对象 -->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<!-- 注入数据源 -->
<property name="dataSource" ref="dataSource"/>
<!-- 注入配置文件位置, 没有核心配置文件时可以省略 -->
<property name="configLocation" value="mybatis-config.xml"/>
<!-- 注入mapper文件位置（与mapper配置中的resource方式一样，可以不采用这种方式，按需选择） -->
<!--<property name="mapperLocations" value="com/zero/dao/*.xml"/>-->
</bean>
使用MapperFactoryBean类为每个dao接口配置实现类的bean对象
<!-- 通过MapperFactoryBean来自动生成UserMapper接口的实现类 -->
<bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
<!-- 绑定dao层的接口 -->
<property name="mapperInterface" value="com.zero.dao.UserMapper"/>
<!-- 绑定生成SqlSessionFactory对象 -->
<property name="sqlSessionFactory" ref="sqlSessionFactory"/>
</bean>
- 这中间包含了通过sqlSessionFactory对象去生成sqlSession对象，然后通过该对象获得dao层接口的实现类对象。
- 此方式生成的userMapper对象是线程安全的，创建该对象的是SqlSessionTemplate对象（SqlSession子类）。
- 使用该方式生成dao层接口实现类时，接口所在包必须存在对应的mapper.xml文件（这有点像使用class方式导入mapper配置文件）。
另外两种产生dao层接口实现类的方式
-
自己写实现类
编写实现类
package com.zero.dao; import com.zero.pojo.User; import org.mybatis.spring.SqlSessionTemplate; import java.util.List; /** * UserMapper接口的实现类 */ public class UserMapperImpl implements UserMapper { //组合一个SqlSessionTemplate，该对象相当于SqlSession对象 private SqlSessionTemplate sqlSessionTemplate; //提供构造器注入 public UserMapperImpl(SqlSessionTemplate sqlSessionTemplate){ this.sqlSessionTemplate = sqlSessionTemplate; } @Override public List<User> getAllUser() { //通过sqlSessionTemplate对象加载UserMapper接口，以获得含mapper配置的实现类对象 UserMapper mapper = sqlSessionTemplate.getMapper(UserMapper.class); //调用含mapper配置的实现类对象对应的方法得到真正的结果 return mapper.getAllUser(); } @Override public User getUserById(long id) { UserMapper mapper = sqlSessionTemplate.getMapper(UserMapper.class); return mapper.getUserById(id); } }配置SqlSessionTemplate的bean对象
<!-- 配置SqlSessionTemplate对象，相当于SqlSession对象 --> <bean id="sqlSession" class="org.mybatis.spring.SqlSessionTemplate"> <constructor-arg name="sqlSessionFactory" ref="sqlSessionFactory"/> </bean>将实现类配置到spring容器中
<!--该方式需要在配置sqlSessionFactory时引入mapper文件的路径, 不然会找不到对应的mapper配置文件--> <!-- 配置UserMapper接口的实现类对象，注入sqlSessionTemplate对象 --> <bean id="userMapperImpl" class="com.zero.dao.UserMapperImpl"> <!-- 注入sqlSessionTemplate --> <constructor-arg name="sqlSessionTemplate" ref="sqlSession"/> </bean> -
使用包扫描自动生成实现类对象
引入mybatis命名约束
xmlns:mybatis="http://mybatis.org/schema/mybatis-spring" xsi:schemaLocation="http://mybatis.org/schema/mybatis-spring http://mybatis.org/schema/mybatis-spring.xsd"开启包扫描
<!-- 通过扫描包的方式，将一个包内的mapper接口注册进来，类似于mapper的包扫描， 该方式，扫描到的bean id为类名首字母小写 --> <mybatis:scan base-package="com.zero.dao"/>
最终推荐的xml写法
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:mybatis="http://mybatis.org/schema/mybatis-spring"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
http://mybatis.org/schema/mybatis-spring
http://mybatis.org/schema/mybatis-spring.xsd">
<!--
使用spring-jdbc的DriverManagerDataSource类配置数据源
也可以使用其他数据源
-->
<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/mybatis?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=UTC"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</bean>
<!-- 配置SqlSessionFactory对象 -->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<!-- 注入数据源 -->
<property name="dataSource" ref="dataSource"/>
<!-- 注入配置文件位置 -->
<property name="configLocation" value="mybatis-config.xml"/>
</bean>
<!-- 通过MapperFactoryBean来自动生成UserMapper接口的实现类 -->
<bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
<property name="mapperInterface" value="com.zero.dao.UserMapper"/>
<property name="sqlSessionFactory" ref="sqlSessionFactory"/>
</bean>
<!--也可以选择：
通过扫描包的方式，将一个包内的mapper接口注册进来，类似于mapper的包扫描
该方式，扫描到的bean id为类名首字母小写
<mybatis:scan base-package="com.zero.dao"/>
-->
</beans>
4、测试
基于推荐方式的测试
测试用例：
@Test
public void test(){
ApplicationContext context = new ClassPathXmlApplicationContext("applicationConfig.xml");
UserMapper userMapper = context.getBean("userMapper", UserMapper.class);
List<User> users = userMapper.getAllUser();
for (User user : users) {
System.out.println(user);
}
}
测试结果(表中数据需要另行插入)：
Checking to see if class com.zero.pojo.User matches criteria [is assignable to Object]
Creating a new SqlSession
SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@2892dae4] was not registered for synchronization because synchronization is not active
JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@48e1f6c7] will not be managed by Spring
==> Preparing: SELECT * FROM mybatis.`user`
==> Parameters:
<== Columns: id, username, birthday, gender, address
<== Row: 1, kkkk, 2020-02-24, 男, 广州市白云区
<== Row: 2, tom, 2020-02-23, 男, 广州市番禺区
<== Row: 3, zero, 2020-02-25, 男, 广州市海珠区
<== Total: 3
新手上路，恐有错漏，望各位看官看看即可，还得参照其他各路大神博文，以免被我误入歧途。谢谢_
扫一扫
1040
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
