MyBatis配置与简单使用

一、MyBatis简介

• MyBatis 是一款优秀的持久层框架，它支持自定义 SQL、存储过程以及高级映射。
• MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。
• MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。
• MyBatis特点：简单易学；灵活；Sql和程序解耦；提供映射标签；提供关系映射标签；支持动态sql。
• MyBatis官网：https://mybatis.org/mybatis-3/zh/getting-started.html
• MyBatis 本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code，并且改名为MyBatis 。2013年11月迁移到Github。 iBATIS一词来源于“internet”和“abatis”的组合，是一个基于Java的持久层框架。
• MyBatis 支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC代码和手 动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息，将 接口和 Java的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。

二、MyBatis配置与测试

• XML 配置文件中包含了对 MyBatis 系统的核心设置，包括获取数据库连接实例的数据源（DataSource）以及决定事务作用域和控制方式的事务管理器（TransactionManager）。

• 每个基于 MyBatis 的应用都是以一个 SqlSessionFactory 的实例为核心的。SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder 获得。而 SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先配置的 Configuration 实例来构建出 SqlSessionFactory 实例。

• 添加MyBatis的依赖，目前版本是3.4.6，除此之外还有junit和mysql的驱动依赖分别引入到 pom.xml 文件中

  <?xml version="1.0" encoding="UTF-8"?>
  <project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
      <modelVersion>4.0.0</modelVersion>
      <groupId>com.qfedu</groupId>
      <artifactId>Days21Mybatis</artifactId>
      <version>1.0-SNAPSHOT</version>
      <dependencies>
          <dependency>
              <groupId>mysql</groupId>
              <artifactId>mysql-connector-java</artifactId>
              <version>8.0.18</version>
          </dependency>
          <dependency>
              <groupId>junit</groupId>
              <artifactId>junit</artifactId>
              <version>4.12</version>
          </dependency>
          <dependency>
              <groupId>org.mybatis</groupId>
              <artifactId>mybatis</artifactId>
              <version>3.4.6</version>
          </dependency>
      </dependencies>
  </project>
  

• 在resources目录下新增一个MyBatis的配置文件，mybatis.xml

  • 该配置文件中包含一个configuration节点，里面有配置信息，分别是环境和映射，其中环境里有datasource，里面有连接数据库的四个字符串
  • MySQL 5版本及以下driver的value为com.mysql.jdbc.Driver，6.0版本及以上的value为com.mysql.cj.jdbc.Driver，并在url后面加?serverTimezone=UTC来设置时区（不设置可能报错，默认为System）

  <?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>
      <environments default="development">
          <environment id="development">
              <transactionManager type="JDBC"/>
              <dataSource type="POOLED">
                  <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                  <property name="url" value="数据库url?serverTimezone=UTC"/>
                  <property name="username" value="数据库用户名"/>
                  <property name="password" value="数据库密码"/>
              </dataSource>
          </environment>
      </environments>
      <mappers>
          <mapper resource="com/pojo/UserMapper.xml"/>
      </mappers>
  </configuration>
  

• 在com.pojo的包下创建User.java bean文件

  public class User {
      private int uid;
      private String username;
      private String password;
      private int age;
      private String addr;
      public int getUid() { return uid; }
      public void setUid(int uid) { this.uid = uid; }
      public String getUsername() { return username; }
      public void setUsername(String username) { this.username = username; }
      public String getPassword() { return password; }
      public void setPassword(String password) { this.password = password; }
      public int getAge() { return age; }
      public void setAge(int age) { this.age = age; }
      public String getAddr() { return addr; }
      public void setAddr(String addr) { this.addr = addr; }
      @Override
      public String toString() {
          final StringBuffer sb = new StringBuffer("User{");
          sb.append("uid=").append(uid);
          sb.append(", username='").append(username).append('\'');
          sb.append(", password='").append(password).append('\'');
          sb.append(", age=").append(age);
          sb.append(", addr='").append(addr).append('\'');
          sb.append('}');
          return sb.toString();
      }
  }
  

• 在com/pojo的目录下创建 UserMapper.xml 文件

  • 每个mapper文件都将有一个自己的映射的namespace，每个方法对应自己的sql语句，每个sql语句对应有一个id
  • 整个项目中所有的namespace.id必须是唯一的

  <?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.pojo.UserMapper">
        <select id="selectUser" resultType="com.pojo.User">
            select * from user
        </select>
      </mapper>
  

• TestUser.java测试类

  • 1.使用MyBatis的配置文件以及SqlSessionFactoryBuilder建造者模式创建SqlSessionFactory对象
  • 2.使用SqlSessionFactory对象的openSession（）方法来得到一个SqlSession对象，用该对象即可完成对象的所有的crud操作
  • 3.使用SqlSession对象来完成crud操作
  • 4.关闭资源

  public class TestUser {
      @Test
      public void testGetAllUsers(){
          try {
              SqlSessionFactory sf = new SqlSessionFactoryBuilder().build(Resources.getResourceAsStream("mybatis.xml"));
              SqlSession session = sf.openSession();
              // session的crud方法（"namespace.id"）;整个项目中的namespace.id必须唯一
              List<User> users = session.selectList("com.pojo.UserMapper.selectUser");
              for (User u : users) {
                  System.out.println(u);
              }
              if(session != null){
                  session.close();
                  session = null;
              }
          } catch (IOException e) {
              e.printStackTrace();
          }
      }
  }
  

• 执行结果

  User{uid=1, username='aaa', password='111111', age=10, addr='aaaa'}
  User{uid=2, username='bbb', password='222222', age=11, addr='aaaa'}
  User{uid=3, username='ccc', password='333333', age=12, addr='aaaa'}
  User{uid=4, username='ddd', password='444444', age=13, addr='aaaa'}
  User{uid=5, username='eee', password='555555', age=14, addr='aaaa'}
  User{uid=6, username='fff', password='666666', age=15, addr='aaaa'}
  User{uid=7, username='ggg', password='777777', age=16, addr='aaaa'}
  User{uid=8, username='hhh', password='888888', age=17, addr='aaaa'}
  User{uid=9, username='iii', password='999999', age=18, addr='aaaa'}
  User{uid=10, username='jjj', password='000000', age=19, addr='aaaa'}
  User{uid=11, username='kkk', password='000000', age=20, addr='aaaa'}
  

三、MyBatis作用域（Scope）和生命周期

• SqlSessionFactoryBuilder

  • 这个类可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，就不再需要它了。
  • 因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。
  • 你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例，但最好还是不要一直保留着它，以保证所有的 XML 解析资源可以被释放给更重要的事情。

• SqlSessionFactory

  • SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在，没有任何理由丢弃它或重新创建另一个实例。
  • 使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次，多次重建 SqlSessionFactory 被视为一种代码“坏习惯”。
  • 因此 SqlSessionFactory 的最佳作用域是应用作用域。 有很多方法可以做到，最简单的就是使用单例模式或者静态单例模式。

• SqlSession

  • 每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。
  • 绝对不能将 SqlSession 实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。 也绝不能将 SqlSession 实例的引用放在任何类型的托管作用域中，比如 Servlet 框架中的 HttpSession。
  • 如果你现在正在使用一种 Web 框架，考虑将 SqlSession 放在一个和 HTTP 请求相似的作用域中。 换句话说，每次收到 HTTP 请求，就可以打开一个 SqlSession，返回一个响应后，就关闭它。 这个关闭操作很重要，为了确保每次都能执行关闭操作，你应该把这个关闭操作放到 finally 块中。

• 映射器实例

  • 映射器是一些绑定映射语句的接口。映射器接口的实例是从 SqlSession 中获得的。虽然从技术层面上来讲，任何映射器实例的最大作用域与请求它们的 SqlSession 相同。
  • 但方法作用域才是映射器实例的最合适的作用域。 也就是说，映射器实例应该在调用它们的方法中被获取，使用完毕之后即可丢弃。 映射器实例并不需要被显式地关闭。
  • 尽管在整个请求作用域保留映射器实例不会有什么问题，但是你很快会发现，在这个作用域上管理太多像 SqlSession 的资源会让你忙不过来。