Mybatis整合Spring

本节内容：

整合思路
整合需要的jar包
整合步骤
Dao开发

一、整合思路

SqlSessionFactory对象应该放到spring容器中作为单例存在。
传统dao的开发方式中，应该从spring容器中获得sqlsession对象。
Mapper代理形式中，应该从spring容器中直接获得mapper的代理对象。
数据库的连接以及数据库连接池事务管理都交给spring容器来完成。

二、整合需要的jar包

spring的jar包
Mybatis的jar包
Spring+mybatis的整合包。
Mysql的数据库驱动jar包。
数据库连接池的jar包。

三、整合步骤

1. 创建工程

新建一个java工程，然后在工程下建一个文件夹lib。

2. 导入jar包并加入到classpath中

我这里导入的jar包，包括spring-mvc的包。

我这里用的是 dbcp 连接池。

3. 加入配置文件

在src下创建资源文件夹config，拷贝加入配置文件。

（1）mybatis的配置文件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>
        <!-- 2. 指定扫描包，会把包内所有的类都设置别名，别名的名称就是类名，大小写不敏感 -->
        <package name="com.wisedu.mybatis.pojo" />
    </typeAliases>

</configuration>

（2）Spring的配置文件applicationContext.xml

数据库连接及连接池
事务管理（暂时可以不配置）
sqlsessionFactory对象，配置到spring容器中。SqlSessionFactoryBean属于mybatis-spring这个jar包。
mapeer代理对象或者是dao实现类配置到spring容器中。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:context="http://www.springframework.org/schema/context" xmlns:p="http://www.springframework.org/schema/p"
       xmlns:aop="http://www.springframework.org/schema/aop" xmlns:tx="http://www.springframework.org/schema/tx"
       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-4.0.xsd
	http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd
	http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.0.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd
	http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-4.0.xsd">

    <!-- 加载配置文件 -->
    <context:property-placeholder location="classpath:/config/db.properties" />

    <!-- 数据库连接池 -->
    <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"
          destroy-method="close">
        <property name="driverClassName" value="${jdbc.driver}" />
        <property name="url" value="${jdbc.url}" />
        <property name="username" value="${jdbc.username}" />
        <property name="password" value="${jdbc.password}" />
        <property name="maxActive" value="10" />
        <property name="maxIdle" value="5" />
    </bean>

    <!-- 配置Mybatis的工程 SqlSessionFactory -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <!-- 配置mybatis核心配置文件，原来核心配置文件中是有连接池的，现在交给Spring了 -->
        <property name="configLocation" value="classpath:/config/sqlMapConfig.xml" />
        <!-- 配置数据源 -->
        <property name="dataSource" ref="dataSource" />
    </bean>
</beans>

（3）db.properties

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8
jdbc.username=root
jdbc.password=123456

（4）log4j.properties

# Global logging configuration
log4j.rootLogger=DEBUG, stdout
# Console output...
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

（5）效果

四、Dao开发

两种dao的实现方式：

原始dao的开发方式
使用Mapper代理形式开发方式
- 直接配置Mapper代理
- 使用扫描包配置Mapper代理

【需求】：

实现根据用户id查询
实现根据用户名模糊查询
添加用户

1. 创建pojo

创建包com.wisedu.mybatis.pojo，然后创建pojo类文件 User.java

package com.wisedu.mybatis.pojo;

import java.io.Serializable;
import java.util.Date;
import java.util.List;

public class User implements Serializable {

	private static final long serialVersionUID = 1L;
	private Integer id;
	private String username;// 用户姓名
	private String sex;// 性别
	private Date birthday;// 生日
	private String address;// 地址

	public Integer getId() {
		return id;
	}
	public void setId(Integer id) {
		this.id = id;
	}
	public String getUsername() {
		return username;
	}
	public void setUsername(String username) {
		this.username = username;
	}
	public String getSex() {
		return sex;
	}
	public void setSex(String sex) {
		this.sex = sex;
	}
	public Date getBirthday() {
		return birthday;
	}
	public void setBirthday(Date birthday) {
		this.birthday = birthday;
	}
	public String getAddress() {
		return address;
	}
	public void setAddress(String address) {
		this.address = address;
	}

	@Override
	public String toString() {
		return "User [id=" + id + ", username=" + username + ", sex=" + sex
				+ ", birthday=" + birthday + ", address=" + address + "]";
	}

}

2. 传统dao的开发方式

原始的DAO开发接口+实现类来完成。

需要dao实现类需要继承SqlsessionDaoSupport类。

（1）编写UserDao接口

新建一个包 com.wisedu.mybatis.dao，然后新建接口UserDao.java

package com.wisedu.mybatis.dao;

import com.wisedu.mybatis.pojo.User;

import java.util.List;

/**
 * Created by jkzhao on 12/28/17.
 */
public interface UserDao {

    /**
     * 根据id查询用户
     *
     * @param id
     * @return
     */
    User queryUserById(int id);

    /**
     * 根据用户名模糊查询用户列表
     *
     * @param username
     * @return
     */
    List<User> queryUserByUsername(String username);

    /**
     * 保存
     *
     * @param user
     */
    void saveUser(User user);

}

（2）实现Mapper.xml

在src下新建一个文件夹sqlmap，在sqlmap下编写User.xml配置文件，如下：

<?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="test">
    <!-- 根据用户id查询 -->
    <select id="queryUserById" parameterType="int" resultType="user">
        select * from user where id = #{id}
    </select>

    <!-- 根据用户名模糊查询用户 -->
    <select id="queryUserByUsername" parameterType="string"
            resultType="user">
        select * from user where username like '%${value}%'
    </select>

    <!-- 添加用户 -->
    <insert id="saveUser" parameterType="user">
        <selectKey keyProperty="id" keyColumn="id" order="AFTER"
                   resultType="int">
            select last_insert_id()
        </selectKey>
        insert into user
        (username,birthday,sex,address)
        values
        (#{username},#{birthday},#{sex},#{address})
    </insert>

</mapper>

（3）加载Mapper.xml

在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>
        <!-- 2. 指定扫描包，会把包内所有的类都设置别名，别名的名称就是类名，大小写不敏感 -->
        <package name="com.wisedu.mybatis.pojo" />
    </typeAliases>

    <mappers>
        <mapper resource="sqlmap/User.xml"></mapper>
    </mappers>

</configuration>

（4）实现UserDaoImpl实现类

编写DAO实现类UserDaoImpl.java，实现类必须集成SqlSessionDaoSupport。SqlSessionDaoSupport提供getSqlSession()方法来获取SqlSession。

package com.wisedu.mybatis.dao.impl;

import com.wisedu.mybatis.dao.UserDao;
import com.wisedu.mybatis.pojo.User;
import org.apache.ibatis.session.SqlSession;
import org.mybatis.spring.support.SqlSessionDaoSupport;

import java.util.List;

/**
 * Created by jkzhao on 12/28/17.
 */
public class UserDaoImpl extends SqlSessionDaoSupport implements UserDao {
    @Override
    public User queryUserById(int id) {
        // 获取SqlSession
        SqlSession sqlSession = super.getSqlSession();
        // 使用SqlSession执行操作
        User user = sqlSession.selectOne("queryUserById", id);
        // 不要关闭sqlSession

        return user;
    }

    @Override
    public List<User> queryUserByUsername(String username) {
        // 获取SqlSession
        SqlSession sqlSession = super.getSqlSession();

        // 使用SqlSession执行操作
        List<User> list = sqlSession.selectList("queryUserByUsername", username);

        // 不要关闭sqlSession

        return list;
    }

    @Override
    public void saveUser(User user) {
        // 获取SqlSession
        SqlSession sqlSession = super.getSqlSession();

        // 使用SqlSession执行操作
        sqlSession.insert("saveUser", user);

        // 不用提交,事务由spring进行管理
        // 不要关闭sqlSession

    }
}

（5）配置Dao

把dao实现类配置到spring容器中，在applicationContext.xml中添加配置如下：

    <!--原始方式开发dao，配置dao到spring-->
    <bean name="userDao" class="com.wisedu.mybatis.dao.impl.UserDaoImpl">
        <!--配置sqlSessionFactory-->
        <property name="sqlSessionFactory" ref="sqlSessionFactory" />
    </bean>

（6）测试方法

新建一个包 com.wisedu.mybatis.test，在UserDaoImpl类名上使用快捷键 command+shift+t （windows下是control+shift+t）快速生成一个测试类

生成的代码如下：

package com.wisedu.mybatis.test;

import org.junit.Before;
import org.junit.Test;

import static org.junit.Assert.*;

/**
 * Created by jkzhao on 12/28/17.
 */
public class UserDaoImplTest {
    @Before
    public void setUp() throws Exception {

    }

    @Test
    public void queryUserById() throws Exception {

    }

    @Test
    public void queryUserByUsername() throws Exception {

    }

    @Test
    public void saveUser() throws Exception {

    }

}

编写测试方法，最终代码如下：

package com.wisedu.mybatis.test;

import com.wisedu.mybatis.dao.UserDao;
import com.wisedu.mybatis.pojo.User;
import org.junit.Before;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.stereotype.Component;

import java.util.Date;
import java.util.List;

import static org.junit.Assert.*;

/**
 * Created by jkzhao on 12/28/17.
 */

public class UserDaoImplTest {
    private ApplicationContext context;

    @Before
    public void setUp() throws Exception {
        this.context = new ClassPathXmlApplicationContext("classpath:/config/applicationContext.xml");
    }

    @Test
    public void queryUserById() throws Exception {
        // 获取userDao
        UserDao userDao = this.context.getBean(UserDao.class);

        User user = userDao.queryUserById(1);
        System.out.println(user);
    }

    @Test
    public void queryUserByUsername() throws Exception {
        // 获取userDao
        UserDao userDao = this.context.getBean(UserDao.class);

        List<User> list = userDao.queryUserByUsername("张");
        for (User user : list) {
            System.out.println(user);
        }

    }

    @Test
    public void saveUser() throws Exception {
        // 获取userDao
        UserDao userDao = this.context.getBean(UserDao.class);

        User user = new User();
        user.setUsername("曹操");
        user.setSex("1");
        user.setBirthday(new Date());
        user.setAddress("三国");
        userDao.saveUser(user);
        System.out.println(user);

    }

}

3. Mapper代理形式开发dao

（1）定义UserMapper接口

新建一个包 com.wisedu.mybatis.mapper，在包下面编写接口文件UserMapper.java

package com.wisedu.mybatis.mapper;

import com.wisedu.mybatis.pojo.User;

import java.util.List;

/**
 * Created by jkzhao on 12/28/17.
 */
public interface UserMapper {

    /**
     * 根据id查询用户
     *
     * @param id
     * @return
     */
    User queryUserById(int id);

    /**
     * 根据用户名模糊查询用户列表
     *
     * @param username
     * @return
     */
    List<User> queryUserByUsername(String username);

    /**
     * 保存
     *
     * @param user
     */
    void saveUser(User user);
}

（2）编写Mapper.xml

在包下面编写UserMapper.xml配置文件，如下：

<?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.wisedu.mybatis.mapper.UserMapper">
    <!-- 根据用户id查询 -->
    <select id="queryUserById" parameterType="int" resultType="user">
        select * from user where id = #{id}
    </select>

    <!-- 根据用户名模糊查询用户 -->
    <select id="queryUserByUsername" parameterType="string"
            resultType="user">
        select * from user where username like '%${value}%'
    </select>

    <!-- 添加用户 -->
    <insert id="saveUser" parameterType="user">
        <selectKey keyProperty="id" keyColumn="id" order="AFTER"
                   resultType="int">
            select last_insert_id()
        </selectKey>
        insert into user
        (username,birthday,sex,address) values
        (#{username},#{birthday},#{sex},#{address})
    </insert>
</mapper>

（3）加载Mapper.xml

在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>
        <!-- 2. 指定扫描包，会把包内所有的类都设置别名，别名的名称就是类名，大小写不敏感 -->
        <package name="com.wisedu.mybatis.pojo" />
    </typeAliases>

    <mappers>
        <mapper resource="sqlmap/User.xml"></mapper>
        <package name="com.wisedu.mybatis.mapper" />
    </mappers>

</configuration>

（4）方式一：配置mapper代理

在applicationContext.xml添加配置，MapperFactoryBean也是属于mybatis-spring整合包。

    <!-- Mapper代理的方式开发方式一，配置Mapper代理对象 -->
    <bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
        <!-- 配置sqlSessionFactory，org.mybatis.spring.mapper.MapperFactoryBean这个类没有工厂，得注入工厂，然后生成SqlSession -->
        <property name="sqlSessionFactory" ref="sqlSessionFactory" />
        <!-- 配置Mapper接口
          看看之前写的测试代码：
        // 获取sqlSession，和spring整合后由spring管理
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //SqlSEssion会帮我生成一个实现类  （需要我们给接口，它帮我们生成实现类，返回给我们的还是接口）
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        所以就生成了实现类返回给了接口。这两行代码就是封装在了 org.mybatis.spring.mapper.MapperFactoryBean 这个类中-->
        <property name="mapperInterface" value="com.wisedu.mybatis.mapper.UserMapper" />
    </bean>

测试方法UserMapperTest.java

package com.wisedu.mybatis.test;

import com.wisedu.mybatis.dao.UserDao;
import com.wisedu.mybatis.mapper.UserMapper;
import com.wisedu.mybatis.pojo.User;
import org.junit.Before;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

import java.util.Date;
import java.util.List;

/**
 * Created by jkzhao on 12/28/17.
 */

public class UserMapperTest {
    private ApplicationContext context;

    @Before
    public void setUp() throws Exception {
        this.context = new ClassPathXmlApplicationContext("classpath:/config/applicationContext.xml");
    }

    @Test
    public void testQueryUserById() {
        // 获取Mapper
        UserMapper userMapper = this.context.getBean(UserMapper.class);

        User user = userMapper.queryUserById(1);
        System.out.println(user);
    }

    @Test
    public void testQueryUserByUsername() {
        // 获取Mapper
        UserMapper userMapper = this.context.getBean(UserMapper.class);

        List<User> list = userMapper.queryUserByUsername("张");

        for (User user : list) {
            System.out.println(user);
        }
    }
    @Test
    public void testSaveUser() {
        // 获取Mapper
        UserMapper userMapper = this.context.getBean(UserMapper.class);

        User user = new User();
        user.setUsername("曹操");
        user.setSex("1");
        user.setBirthday(new Date());
        user.setAddress("三国");

        userMapper.saveUser(user);
        System.out.println(user);
    }

}

（5）方式二：动态代理扫描包形式配置mapper

注释上面的那个配置，在applicationContext.xml添加配置：

    <!-- Mapper代理的方式开发方式二，扫描包方式配置代理（不注入工厂也可以，org.mybatis.spring.mapper.MapperScannerConfigurer会自己去Spring容器中去找） -->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <!-- 配置Mapper接口 -->
        <property name="basePackage" value="com.wisedu.mybatis.mapper" />
    </bean>

因为是扫描，所以没给id。每个mapper代理对象的id就是接口的类名，首字母小写。项目中一般用方式二。

测试方法不变。

【注意】：当在applicationContext.xml文件中配置了扫描包mapper，那么原来在sqlMapConfig.xml中就不需要配置：

<mappers>
     <package name="com.wisedu.springmvc.dao.automatic.mapper" />
</mappers>