MyBatis初级入门

目录：

• 一、简介
• 二、创建项目
  • step 1：导入Maven依赖
  • step 2：创建mybatis核心配置文件
  • step 3：编写工具类
  • step 4：编写代码
  • step 5：测试

官方文档： mybatis – MyBatis 3 | 简介

github地址： GitHub - mybatis/mybatis-3: MyBatis SQL mapper framework for Java

Maven仓库地址： Maven Repository: org.mybatis » mybatis (mvnrepository.com)

一、简介

• MyBatis 是一款优秀的持久层框架
• 它支持自定义SQL、存储过程以及高级映射。
• MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。
• MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。
• MyBatis 本是apache的一个开源项目iBatis，2010年这个项目由apache software foundation迁移到了google code，并且改名为MyBatis。
• 2013年11月迁移到Github。

二、创建项目

先准备数据库，执行SQL语句：

// 创建表
CREATE TABLE user(id INT NOT NULL AUTO_INCREMENT primary key,name char(20),updateTime datetime);

// 插入两条数据
INSERT INTO user(name,updateTime) value("张三",sysdate());
INSERT INTO user(name,uddateTime) value("李四",sysdate());

建好一个Maven项目。

step 1：导入Maven依赖

<dependencies>
    <!--Mybatis-->
    <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.3</version>
    </dependency>

    <!--mysql驱动-->
    <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.47</version>
    </dependency>

    <!--Junit-->
    <!-- https://mvnrepository.com/artifact/org.junit.jupiter/junit-jupiter-api -->
    <dependency>
        <groupId>org.junit.jupiter</groupId>
        <artifactId>junit-jupiter-api</artifactId>
        <version>5.7.0</version>
        <scope>test</scope>
    </dependency>
</dependencies>

step 2：创建mybatis核心配置文件

文件名：mybatis-config / mybatis-cfg

文件内容：mybatis – MyBatis 3 | 入门

<?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="jdbc:mysql://localhost:3306/mybatis?setUnicode=true&amp;characterEncoding=utf8"/>
        <property name="url" value="${url}"/>
        <property name="username" value="root"/>
        <property name="password" value="root"/>
      </dataSource>
    </environment>
  </environments>
  <!--    每一个mapper.xml配置文件都需要在mybaits核心文件中注册-->
  <mappers>
    <!--    使用文件路径的方式配置-->
    <mapper resource="com/langp/dao/UserMapper.xml"></mapper>
  </mappers>
</configuration>

在这个过程中配置数据库信息，或者可以在同一目录下再新建一个数据库配置文件jdbc.properties，里面写入数据库信息：

# 与JDBC中的配置十分类似
driver:com.mysql.jdbc.Driver
url:jdbc:mysql://localhost:3306/mybatis?setUnicode=true&characterEncoding=utf8
username:root
password:root

step 3：编写工具类

将加载Sqlsession的过程写成一个工具类，方便调用

public class Utils {
    private static SqlSessionFactory sqlSessionFactory;
    static{
        try {
            String resource = "mybatis-config.xml";
            // 使用mybatis
            // 1.获取SqlSessionFactory对象
            InputStream is = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    /**
     * 获取SqlSession的实例
     * SqlSession完全包含了面向数据库执行SQL命令所需的所有方法
     * @return sqlSessinFactory
     */
    public static SqlSession getSession() {
        if (sqlSessionFactory != null) {
            return sqlSessionFactory.openSession();
        }
        return null;
    }
}

为了更节省内存空间，使用单例模式来定义工具类会更好：

public class Util {
    // 懒汉式单例
    private static Util util;
    static SqlSessionFactory sqlSessionFactory;


    private Util() {
        String resource = "mybatis-config.xml";
        InputStream is = null;
        try {
            is = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    // 单例模式下获取Util实例
    public static Util getInstance(){
        if (util == null) {
            util = new Util();
        }
        return util;
    }

    // 获取Session实例
    // Session中包含了执行SQL语句的所有方法
    public static SqlSession getSession() {
        if (sqlSessionFactory != null) {
            return sqlSessionFactory.openSession();
        }
        return null;
    }
}

step 4：编写代码

• 实体类

  即业务中涉及到的类

  public class User {
      private int id;
      private String name;
      private String pwd;
      private Date updateTime;
  
      public User() {
      }
  
      public User(int id, String name, String pwd, Date updateTime) {
          this.id = id;
          this.name = name;
          this.pwd = pwd;
          this.updateTime = updateTime;
      }
  
      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 Date getUpdateTime() {
          return updateTime;
      }
  
      public void setUpdateTime(Date updateTime) {
          this.updateTime = updateTime;
      }
  
      @Override
      public String toString() {
          return "User{" +
                  "id=" + id +
                  ", name='" + name + '\'' +
                  ", pwd='" + pwd + '\'' +
                  ", updateTime=" + updateTime +
                  '}';
      }
  }

• Dao接口 —— 实现类Mapper

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

• 接口实现类 —— Mapper文件

  原来的UserDaoImpl转换为一个接口的Mapper配置文件

  <?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">
  <!--namespace绑定一个Dao/mapper接口-->
  <mapper namespace="com.langp.dao.UserMapper">
  <!--    查询语句-->
  <!--    注意其中的id，和resultType返回类型的名称-->
      <select id="getUserList" resultType="com.langp.pojo.User">
          SELECT * FROM mybatis.user;
      </select>
  </mapper>

step 5：测试

创建测试类

class UserMapperTest {
    @org.junit.jupiter.api.Test
    void getUserList() {
        // 获取sqlSession对象
        SqlSession sqlSession = MybatisUtils.getSession();
        // 执行sql
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        List<User> userList = mapper.getUserList();
        for (User user : userList) {
            System.out.println(user);
        }
        // 关闭sqlSession
        sqlSession.close();
    }
}