Mybatis笔记（一）：第一个Mybatis程序

时间：2021/10/11

本文是学习了b站狂神老师的视频后的一个总结，总结了一下编写一个mybatis项目所需的基本流程和可能遇到的一些bug。

首先展示一下项目的整体结构，如下图：

 

然后项目的具体流程如下所示： 

一.创建数据库和相应的表

这里我使用的mysql，创建了一个mybatis数据库，数据库中有一个user表，表中插入了两条记录。

二.在maven项目的配置文件中插入依赖 

这个项目中使用的依赖主要有mysql驱动、mybatis和junit。具体配置代码如下：

<!--导入依赖-->
    <dependencies>
        <!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.46</version>
        </dependency>
        <!--mybatis-->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.6</version>
        </dependency>
        <!--junit-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13.1</version>
            <scope>test</scope>
        </dependency>

    </dependencies>

三.编写mysql配置文件

在写url时要注意后面的参数，比如时区什么的。

<?xml version="1.0" encoding="UTF8" ?>
<!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.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=false&amp;useUnicode=true&amp;characterEncoding=UTF-8&amp;serverTimezone=GMT"/>
                <property name="username" value="root"/>
                <property name="password" value="123456789.a"/>
            </dataSource>
        </environment>
    </environments>

    <mappers>
        <mapper resource="bupt/machi/dao/UserMapper.xml"/>
    </mappers>
</configuration>

四.编写获取SqlSession对象的工具类

这段代码首先要读取mysql配置文件，然后通过输入流获取到SqlSessionFactory对象，最后获取SqlSession对象。

package bupt.machi.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;

//mybatis工具类，返回一个SqlSession对象
public class MybatisUtils {

    private static SqlSessionFactory sqlSessionFactory;

    static{
        try{
            String resource = "mybatis_config.xml";
            InputStream inputStream =  Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        }catch (IOException e){
            e.printStackTrace();
        }
    }

    public static SqlSession getSqlSession(){
        //获取SqlSession对象
        return sqlSessionFactory.openSession();
    }
}

五.编写实体类

这里编写一个User实体类，属性必须与数据库中属性一一对应。

package bupt.machi.pojo;

//实体类
public class User {

    private int id;
    private String name;
    private String pwd;

    public User(){

    }

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

    public int getId(){
        return id;
    }

    public String getName() {
        return name;
    }

    public String getPwd(){
        return pwd;
    }

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

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

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

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

六.编写dao/mapper接口

package bupt.machi.dao;

import bupt.machi.pojo.User;

import java.util.List;

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

七.编写sql操作的配置文件

该文件起到了dao/mapper接口实现类的作用。

<?xml version="1.0" encoding="UTF8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!--绑定一个Dao接口，使用xml文件代替之前的实现类-->
<mapper namespace="bupt.machi.dao.UserDao">
    <!--id对应方法名字-->
    <select id="getUserList" resultType="bupt.machi.pojo.User">
        select * from mybatis.user
    </select>
</mapper>

这里要注意resultType中写的是范型中的类型。

八.编写测试类

要注意这里测试类的路径要与被测试类的路径相同，最后要记得关闭SqlSession对象。

package bupt.machi.dao;

import bupt.machi.pojo.User;
import bupt.machi.utils.MybatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;

import java.util.List;

public class UserDaoTest {

    @Test
    public void test(){
        //获取SqlSession对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();

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

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

        sqlSession.close();
    }
}

九.可能出现的bug以及解决方法

1）在mysql配置文件中，需要通过mapper标签引入你编写的sql配置文件，每一个都必须引入。

<mappers>
　　<mapper resource="bupt/machi/dao/UserMapper.xml"/>
</mappers>

2）如果出现找不到sql配置文件的问题，可能是由于maven的资源过滤机制，要在父项目和子项目的配置文件中添加build标签。

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

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