MyBatis入门

共计 5603 个字符，预计需要花费 15 分钟才能阅读完成。

1、MyBatis 概述

1.1、开发前 MyBatis 准备

1.1.1、什么是 MyBatis

MyBatis 本是 apache 的一个开源项目 iBatis, 2010 年这个项目由 apache software foundation 迁移到了 google code，并且改名为 MyBatis。2013 年 11 月迁移到 Github。

MyBatis 是一款优秀的持久层框架，它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生类型、接口和 Java 的 POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。

1.1.2、MyBatis 下载与安装

第一步：https://mybatis.org/mybatis-3/zh/index.html

第二步：点击“简体中文”

1.2、MyBatis 开发环境搭建

1.2.1、创建项目前的准备

准备好一个数据库表 user

1.2.2、创建 maven 项目

**GroupId:**com.tianyi

**ArtifactId:**mb001

**Version:**1.0-SNAPSHOT

1.2.3、添加 MyBatis，修改 pom.xml

在 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.tianyi</groupId>
    <artifactId>mb001</artifactId>
    <version>1.0-SNAPSHOT</version>
    <dependencies>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.5</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.11</version>
        </dependency>
    </dependencies>
</project>

2、MyBatis 开发实例

2.1、编写 User 实体类

创建 User.java 类（com.tianyi.javabean）

package com.tianyi.javabean;

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

public class User implements Serializable {private Integer id;
    private String username;
    private Date birthday;
    private String sex;
    private String address;

    public Integer getId() {return id;
    }

    public String getUsername() {return username;
    }

    public Date getBirthday() {return birthday;
    }

    public String getSex() {return sex;
    }

    public String getAddress() {return address;
    }

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

    public void setUsername(String username) {this.username = username;
    }

    public void setBirthday(Date birthday) {this.birthday = birthday;
    }

    public void setSex(String sex) {this.sex = sex;
    }

    public void setAddress(String address) {this.address = address;
    }

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

注意：

Mybatis 通过序列化得到对象的新实例，保证多线程安全（因为是从缓存中取数据，速度还是比从数据库获取要快）。具体说就是对象序列化后存储到缓存中，从缓存中取数据时是通过反序列化得到新的实例。

2.2、编写持久层接口

创建 IUserDao 接口（com.tianyi.dao）

package com.tianyi.dao;

public interface IUserDao {List findAll();
}

2.3、编写持久层接口的映射文件

创建 IUserDao.xml 文件（com.tianyi.dao 注：resources 下的包）

<?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.tianyi.dao.IUserDao">
    <!-- 配置查询所有操作 -->
    <select id="findAll" resultType="com.tianyi.javabean.User">
        select * from user
    </select>
</mapper>

2.4、编写 SqlMapConfig.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>
    <!-- 配置 mybatis 的环境 -->
    <environments default="mysql">
    <!-- 配置 mysql 的环境 -->
    <environment id="mysql">
        <!-- 配置事务的类型 -->
        <transactionManager type="JDBC"></transactionManager>
        <!-- 配置连接数据库的信息: 用的是数据源 (连接池) -->
        <dataSource type="POOLED">
            <!-- <property name="driver" value="com.mysql.jdbc.Driver"/>-->
            <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
            <property name="url" value="jdbc:mysql://localhost:3306/mb"/>
            <property name="username" value="root"/>
            <property name="password" value="root1234"/>
        </dataSource>
    </environment>
    </environments>
    <!-- 告知 mybatis 映射配置的位置 -->
    <mappers>
        <mapper resource="com/tianyi/dao/IUserDao.xml"/>
    </mappers>
</configuration>

注意：

可能会出现：新版的数据库使用的时区与本地时区有区别。国际标准失去与本地相差 8 个小时。

jdbc:mysql://localhost:3306/mb?serverTimezone=UTC

2.5、编写测试类

创建测试类 MbTest.java

package com.tianyi.test;

import com.tianyi.dao.IUserDao;
import com.tianyi.javabean.User;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

import java.io.IOException;
import java.io.InputStream;
import java.util.List;

public class MbTest {public static void main(String[] args) throws IOException {//1. 读取配置文件 
        InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
        //2. 创建 SqlSessionFactory 的构建者对象 
        SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
        //3. 使用构建者创建工厂对象 SqlSessionFactory
        SqlSessionFactory factory = builder.build(in);
        //4. 使用 SqlSessionFactory 生产 SqlSession 对象 
        SqlSession session = factory.openSession();
        //5. 使用 SqlSession 创建 dao 接口的代理对象 
        IUserDao userDao = session.getMapper(IUserDao.class); 
        //6. 使用代理对象执行查询所有方法 
        List <User>users = userDao.findAll();

        for(User user : users) {System.out.println(user);
        }
        //7. 释放资源 
        session.close();
        in.close();}
}

3、MyBatis 注解开发

3.1、删除 IUserDao.xml 文件

3.2、使用注解完成 IUserDao.java 查询

package com.tianyi.dao;

import com.tianyi.javabean.User;
import org.apache.ibatis.annotations.Select;

import java.util.List;

public interface IUserDao {@Select("select * from user")// 注解完成查询 
    List<User> findAll();
}

3.3、修改 SqlMapperConfig.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>
    <!-- 配置 mybatis 的环境 -->
    <environments default="mysql">
    <!-- 配置 mysql 的环境 -->
    <environment id="mysql">
        <!-- 配置事务的类型 -->
        <transactionManager type="JDBC"></transactionManager>
        <!-- 配置连接数据库的信息: 用的是数据源 (连接池) -->
        <dataSource type="POOLED">
            <!-- <property name="driver" value="com.mysql.jdbc.Driver"/>-->
            <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
            <property name="url" value="jdbc:mysql://localhost:3306/mb"/>
            <property name="username" value="root"/>
            <property name="password" value="root1234"/>
        </dataSource>
    </environment>
    </environments>
    <!-- 告知 mybatis 映射配置的位置 -->
    <mappers>
				<!--<mapper resource="com/tianyi/dao/IUserDao.xml"/>-->
        <!-- class 指定 IUserDao.class 接口 -->
        <mapper class="com.tianyi.dao.IUserDao"/>
    </mappers>
</configuration>