MyBatis入门——第一个MyBatis项目搭建

简介

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

学习文档：https://mybatis.org/mybatis-3/zh

具体操作

1. 搭建maven项目，删除src，新建“mybatis-01”子模块(Module)，两个pom文件，在父pom文件写依赖，子pom文件自动生成。
2. 添加依赖（最基本的mysql、mybatis、junit测试需要有，根据实际情况写依赖）：

<dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.6</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.6</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13.1</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.12</version>
        </dependency>
    </dependencies>

3. 在resources下新建“mybatis-config.xml”，按照mybatis官方中文文档(https://mybatis.org/mybatis-3/zh/)的来。

注意：

1. uesSSL=false&useUnicode=true&characterEncoding=UTF-8
2. mapper resource：

<mappers>
        <mapper resource="com/twy/dao/UserMapper.xml"/>
</mappers>

详细代码如下：

<?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="mysql">
        <environment id="mysql">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/example?uesSSL=false&amp;useUnicode=true&amp;characterEncoding=UTF-8"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/twy/dao/UserMapper.xml"/>
    </mappers>
</configuration>

4. 在子模块中，main/java中，com.twy.utils中新建“MybatisUtils.java”。

① 从 XML 中构建 SqlSessionFactory

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

String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

② 既然有了 SqlSessionFactory，顾名思义，我们可以从中获得 SqlSession 的实例。SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。

public static SqlSession getSqlSession(){
        return sqlSessionFactory.openSession();
}

详细代码如下：

package com.twy.utils;

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;

/**
 * Create By Tang on 2021/3/25.
 */
public class MybatisUtils {
    private static SqlSessionFactory sqlSessionFactory;
    static {
        try{
            //使用Mybatis第一步：获取SqlSessionFactory对象
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        }   catch(IOException e){
            e.printStackTrace();
        }
    }

    public static SqlSession getSqlSession(){
        return sqlSessionFactory.openSession();
    }
}

5. 实体类：在子模块中，main/java中，com.twy.pojo中新建实体类“User.java”，具体根据数据库声明。

生成getter/setter/toString方法时可直接引用lombok中的注解@data，省略generate操作。

package com.twy.pojo;
import lombok.Data;
/**
 * Create By Tang on 2021/3/25.
 */
@Data
public class User {
    private int id;
    private String name;
    private int age;
    private String sex;
    private String addr;
}

6. Dao接口：在子模块中，main/java中，com.twy.dao中新建实体类“UserDao.java”(interface)

package com.twy.dao;

import com.twy.pojo.User;

import java.util.List;

/**
 * Create By Tang on 2021/3/25.
 */
public interface UserDao {
    List<User> getUserList();
}

7. 接口实现类：在main/resources下新建com.twy.dao，与UserDao保持一致，新建“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.twy.dao.UserDao">
    <select id="getUserList" resultType="com.twy.pojo.User">
        select * from user
  </select>
</mapper>

8. 编写测试类：在test下新建“UserDaoTest.java”

① 获取SqlSession对象

SqlSession sqlSession = MybatisUtils.getSqlSession();

② 执行SQL

方式一：getMapper

UserDao userDao = sqlSession.getMapper(UserDao.class);
List<User> userList = userDao.getUserList();

方式二(不推荐)：

List<User> userList = sqlSession.selectList("com.twy.dao.UserDao.getUserList");

③ 关闭SqlSession

sqlSession.close();

详细代码如下：

package com.twy.dao;

import com.twy.pojo.User;
import com.twy.utils.MybatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;
import java.util.List;

/**
 * Create By Tang on 2021/3/25.
 */
public class UserDaoTest {
    @Test
    public void test(){
        //第一步：获得SqlSession对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();

        try {
            //方式一：getMapper
            UserDao userDao = sqlSession.getMapper(UserDao.class);
            List<User> userList = userDao.getUserList();

            //方式二：
            //List<User> userList = sqlSession.selectList("com.twy.dao.UserDao.getUserList");

            for (User user : userList){
                System.out.println(user);
            }
        }
        catch(Exception e){
            e.printStackTrace();
        }finally{
            //关闭SqlSession
            sqlSession.close();
        }
    }
}