Spring-07-整合MyBatis

前序

• 官网mybatis-spring : http://mybatis.org/spring/zh/index.html

环境准备：

• junit

<dependency>
   <groupId>junit</groupId>
   <artifactId>junit</artifactId>
   <version>4.12</version>
</dependency>

• mybatis

  <dependency>
     <groupId>org.mybatis</groupId>
     <artifactId>mybatis</artifactId>
     <version>3.5.2</version>
  </dependency>

• mysql-connector-java

  <dependency>
     <groupId>mysql</groupId>
     <artifactId>mysql-connector-java</artifactId>
     <version>5.1.47</version>
  </dependency>

• spring相关

  <dependency>
     <groupId>org.springframework</groupId>
     <artifactId>spring-webmvc</artifactId>
     <version>5.1.10.RELEASE</version>
  </dependency>
  
  <dependency>
     <groupId>org.springframework</groupId>
     <artifactId>spring-jdbc</artifactId>
     <version>5.1.10.RELEASE</version>
  </dependency>

• aspectJ AOP 织入器

<!-- https://mvnrepository.com/artifact/org.aspectj/aspectjweaver -->
<dependency>
   <groupId>org.aspectj</groupId>
   <artifactId>aspectjweaver</artifactId>
   <version>1.9.4</version>
</dependency>

• 配置Maven静态资源过滤问题！

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

1. 回忆MyBatis

1. 编写实体类 pojo/User

package com.zhuuu.pojo;


public class User {
    private int id;
    private String name;
    private String pwd;

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", pwd='" + pwd + '\'' +
                '}';
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getPwd() {
        return pwd;
    }

    public void setPwd(String pwd) {
        this.pwd = pwd;
    }

    public User() {
    }

    public User(int id, String name, String pwd) {
        this.id = id;
        this.name = name;
        this.pwd = pwd;
    }
}

2. 编写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.zhuuu.pojo"/>
    </typeAliases>


    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=true&amp;useUnicode=true&amp;characterEncoding=utf8&amp;serverTimezone=GMT%2B8"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>

    
    <mappers>
        <package name="com.zhuuu.dao"/>
    </mappers>
    
</configuration>

3. 编写mapper (dao/UserMapper) (接口)

package com.zhuuu.dao;

import com.zhuuu.pojo.User;
import java.util.List;

public interface UserMapper {
    public List<User> selectUser();
}

4. 编写mapper对应的xml (dao/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.zhuuu.dao.UserMapper">
    <select id="selectUser" resultType="User">
        select * from user
    </select>
</mapper>

5. 测试

public class MyTest {
    public static void main(String[] args) throws IOException {
      	// 1. 加载配置文件，读取数据库信息
        String resource = "mybaits-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
      
      	// 2.打开数据库连接，拿到数据库操作对象
        SqlSession sqlSession = sqlSessionFactory.openSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);

      	// 3. 数据库操作对象mapper , 来获取数据
        List<User> userList = mapper.selectUser();
        for (User user : userList) {
            System.out.println(user);
        }

        sqlSession.close();
    }
}

• 结果显示如下：（当然这是我自己创建的数据库）

User{id=1, name='zhuuu', pwd='123456'}
User{id=2, name='张三', pwd='abcdeft'}
User{id=3, name='李四', pwd='435354353'}
User{id=5, name='李五', pwd='123213123'}
User{id=7, name='小明', pwd='123456'}
User{id=8, name='root', pwd='123456'}

2. MyBatis-Spring

• 官网mybatis-spring: http://mybatis.org/spring/zh/index.html

MyBatis-Spring 需要以下版本：

MyBatis-Spring	MyBatis	Spring 框架	Spring Batch	Java
2.0	3.5+	5.0+	4.0+	Java 8+
1.3	3.4+	3.2.2+	2.1+	Java 6+

• 如果使用 Maven作为构建工具，仅需要在 pom.xml 中加入以下代码即可：

<dependency>
   <groupId>org.mybatis</groupId>
   <artifactId>mybatis-spring</artifactId>
   <version>2.0.2</version>
</dependency>

要和Spring一起使用MyBatis，需要在Spring应用上下文中至少定义两样东西

• sqlSessionFactory : 不需要再写utils工具类
• 数据映射器类

1. 在 MyBatis-Spring 中，可使用 SqlSessionFactoryBean来创建 SqlSessionFactory。 要配置这个工厂 bean，只需要把下面代码放在 Spring 的 XML 配置文件中：

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
  <property name="dataSource" ref="dataSource" />
</bean>

注意：SqlSessionFactory需要一个 DataSource（数据源）。这可以是任意的 DataSource，只需要和配置其它 Spring 数据库连接一样配置它就可以了。

• 在基础的 MyBatis 用法中，是通过 SqlSessionFactoryBuilder 来创建 SqlSessionFactory 的，而在 MyBatis-Spring 中，则使用 SqlSessionFactoryBean 来创建。

• 在 MyBatis 中，你可以使用 SqlSessionFactory 来创建 SqlSession。一旦你获得一个 session 之后，你可以使用它来执行映射了的语句，提交或回滚连接，最后，当不再需要它的时候，你可以关闭 session。

• 一个常用的属性是configLocation，它用来指定 MyBatis 的 XML 配置文件路径。它在需要修改 MyBatis 的基础配置非常有用。通常，基础配置指的是< settings> 或 < typeAliases>元素。

• 需要注意的是，这个配置文件并不需要是一个完整的 MyBatis配置。

• 同时，SqlSessionTemplate是MyBatis-Spring的核心，作为SqlSession的一个实现，这就意味着可以使用它无缝替换你代码中已经使用的sqlSession。

• 模板可以参与到 Spring 的事务管理中，并且由于其是线程安全的，可以供多个映射器类使用，你应该总是用SqlSessionTemplate来替换 MyBatis 默认的 DefaultSqlSession 实现。在同一应用程序中的不同类之间混杂使用可能会引起数据一致性的问题。

3. MyBaits-Spring 整合实现方式一

这些配置大部分都是固定的！！

1. 引入Spring配置文件beans.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"
      xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd">
    
</beans>

2. 配置数据源替换mybaits的数据源 : 不用再写mybatisconfig.xml

<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
  	// 这里是spring自带的数据源
    <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
    <property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=true&amp;useUnicode=true&amp;characterEncoding=utf8&amp;serverTimezone=GMT%2B8"/>
    <property name="username" value="root"/>
    <property name="password" value="123456"/>
</bean>

3. 把数据源作为bean注入到spring, 并关联MyBatis配置文件

<!--配置sqlSessionFactory-->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="dataSource"/>
    <!--关联mybatis-->
  	// 这里的mybatis-config.xml是可以完全省略的
    <property name="configLocation" value="classpath:mybaits-config.xml"/>
    <property name="mapperLocations" value="classpath:com/zhuuu/dao/*.xml"/>
</bean>

4. 注册sqlSessionTemplate，关联sqlSessionFactory ： 数据库连接对象（不用再new sqlSessionFactory()）

<!--注册sqlSessionTemplate并且关联sqlSessionFactory,本质上就是注入sqlSession-->
<bean id="sqlSession" class="org.mybatis.spring.SqlSessionTemplate">
    <!--利用构造器注入：因为sqlSessionTemplate 没有set方法-->
    <constructor-arg index="0" ref="sqlSessionFactory"/>
</bean>

小结

以上spring所有配置截图

• dataSource :从mybatis配置中拉到spring配置到
• sqlSessionFactory :不用再new 出来读取配置文件，spring直接生成
• SqlsessionTemeplate: 代替了sqlSession,里面包含增删改查的功能
  • 同时，SqlSessionTemplate是MyBatis-Spring的核心，作为SqlSession的一个实现，这就意味着可以使用它无缝替换你代码中已经使用的sqlSession。
  • 原来所有的增删改查操作都是使用sqlSession 来执行，现在都是使用SqlSessionTemplate

5. 增加Dao接口的实现类
   • 虽说多了一个实现类，但是这个实现类是为了注入到spring才产生的

package com.zhuuu.dao;

import com.zhuuu.pojo.User;
import org.mybatis.spring.SqlSessionTemplate;

import java.util.List;

public class UserMapperImpl implements UserMapper{
    // sqlSession不用我们自己创建，Spring来自己管理
    private SqlSessionTemplate sqlSession;

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

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

6. 把实现类注入到beans.xml中

<!--注册bean实现-->
<bean id="userMapper" class="com.zhuuu.dao.UserMapperImpl">
    <property name="sqlSession" ref="sqlSession"/>
</bean>

7. 测试

public class MyTestII {
    public static void main(String[] args) {
        ApplicationContext context = new ClassPathXmlApplicationContext("beans.xml");

        UserMapper mapper = context.getBean("userDao", UserMapper.class);

        List<User> users = mapper.selectUser();

        for (User user : users) {
            System.out.println(user);
        }
    }
}

• 结果成功输出！现在我们的Mybatis配置文件的状态！发现都可以被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>

    <typeAliases>
        <package name="com.zhuuu.pojo"/>
    </typeAliases>

</configuration>

4. MyBaits-Spring 整合实现方式二

mybatis-spring1.2.3版以上的才有这个 .

官方文档截图 :

• dao继承Support类 , 直接利用 getSqlSession() 获得 , 然后直接注入SqlSessionFactory . 比起方式1 , 不需要管理SqlSessionTemplate , 而且对事务的支持更加友好 . 可跟踪源码查看

1. 将我们上面写的UserDaoImpl修改一下

public class UserDaoImpl extends SqlSessionDaoSupport implements UserMapper {
   public List<User> selectUser() {
       UserMapper mapper = getSqlSession().getMapper(UserMapper.class);
       return mapper.selectUser();
  }
}

2. 修改bean的配置

<bean id="userDao" class="com.zhuuu.dao.UserDaoImpl">
   <property name="sqlSessionFactory" ref="sqlSessionFactory" />
</bean>

3. 测试

@Test
public void test2(){
   ApplicationContext context = new ClassPathXmlApplicationContext("beans.xml");
   UserMapper mapper = (UserMapper) context.getBean("userDao");
   List<User> user = mapper.selectUser();
   System.out.println(user);
}

总结 : 整合到spring以后可以完全不要mybatis的配置文件，除了这些方式可以实现整合之外，我们还可以使用注解来实现，这个等我们后面学习SpringBoot的时候还会测试整合！

打赏