【SSM框架学习一】Mybatis使用步骤及相关配置——xml文件篇

首次使用Mybatis框架

在学完Servlet和JSP之后，不论是创建DAO相关的工具还是其他方式，在代码中对数据库进行操作时，可能还是无法避免出现较多的重复性工作。又或者是学习的冲动(也许是工作的需要)，往往还需要学习Mybatis。在这里写下这篇文章，不仅是为了方便以后自己的使用，也希望能够帮助到第一次使用Mybatis的小伙伴。

所需工具及准备

在使用Mybatis之前我们需要做的准备工作如下：

1. IDEA编辑器 ；
   没有的小伙伴可以在官网进行下载安装：https://www.jetbrains.com/idea/
2. 使用环境为：Win10；
3. 本地有安装Mysql或者在某个可正常建立连接的地方安装有Mysql（如服务器上）；如果未安装可以在此链接下载安装，也可参考其他文章进行安装。 https://dev.mysql.com/downloads/mysql/

1、准备数据

1. 由于我本机上已经装了Mysql5.7.29版本，且安装了直接操作数据库的软件：SQLyog，因此我将直接使用该软件来建立一个表格，以备后续的使用；该软件建立表格的方式此处先略过。
2. 最后建好的表格如下图所示，其中数据库名称为：students，表名为：users。里面一共有五列，分别为：userId、userName、password、sex、email；其中userId设为主键，自增。
   

2、建立一个Maven项目

1. 打开IDEA编辑器，创建一个新的Maven工程；
   
2. 创建成功后，可以将该工程中的src文件删除，让其成为一个父工程。
3. 同时再右键该父工程，选择创建新的maven工程，即可。
   
4. 创建完成后，将会出现如下目录结构：
   
5. 到此，建立Maven工程的准备步骤已经完成

3、编写配置文件pom.xml

1. 父工程中的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.jungle</groupId>
    <artifactId>mybatis_test</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>
    <modules>
        <module>mybatis-01</module>
    </modules>

    <!-- 添加依赖 -->
    <dependencies>
        <!-- 添加mybatis依赖 -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.2</version>
        </dependency>

        <!-- 添加Mysql的依赖 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.22</version>
        </dependency>

        <!-- 添加Junit测试依赖 -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>

    </dependencies>
	
	<!-- 下面的resource配置，是为了在编译或执行程序时将工程目录下的xml和properties文件存放到target目录下的对应位置-->
    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>

</project>

2. 子工程中的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">
    <parent>
        <artifactId>mybatis_test</artifactId>
        <groupId>com.jungle</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>mybatis-01</artifactId>
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
    </properties>
	
	<!--以免父工程的这部分配置未生效，此处也添加上-->
    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>

</project>

4、项目的文件说明

1. 文件目录如下图所示：
   
2. 首先在resources目录下创建Mybatis的核心配置文件mybatis-config.xml，其中该配置文件的名字可自取。并在其中加入如下内容：

<?xml version="1.0" encoding="GBK" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>

    <environments default="mydev">
        <environment id="mydev">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
            	<!-- 由于在pom.xml文件中mysql的依赖是8.0.x版本，所以对于使用mysql5.1.x版本的小伙伴下面两行需要注意修改 -->
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/students?serverTimezone=Asia/Shanghai&amp;useUnicode=true&amp;characterEncoding=utf-8&amp;useSSL=true"/>
                <!-- 以下的用户名和密码写为自己mysql对应的即可 -->
                <property name="username" value="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>
    </environments>

    <!-- 每个Mapper.xml都需要在Mybatis核心配置文件中注册 -->
    <!-- 此处引入接口的Mapper文件位置 -->
    <mappers>
        <mapper resource="com/jungle/dao/UserMapper.xml"/>
    </mappers>
</configuration>
    

3. 创建实体类。建议该实体类中的属性和mysql中待操作的表中的列名一致。此处实体类名称为User
   注意写上构造方法、set和get方法、toString()方法。

package com.jungle.pojo;

public class User {

    private int userId;
    private String userName;
    private String password;
    private String sex;
    private String email;

    public User() {
    }

    public User(int userId, String userName, String password, String sex, String email) {
        this.userId = userId;
        this.userName = userName;
        this.password = password;
        this.sex = sex;
        this.email = email;
    }

    public int getUserId() {
        return userId;
    }

    public void setUserId(int userId) {
        this.userId = userId;
    }

    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 String getSex() {
        return sex;
    }

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

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    @Override
    public String toString() {
        return "User{" +
                "userId=" + userId +
                ", userName='" + userName + '\'' +
                ", password='" + password + '\'' +
                ", sex='" + sex + '\'' +
                ", email='" + email + '\'' +
                '}';
    }
}

4. Mybatis工具类MybatisUtils

package com.jungle.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;

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. 接口UserDao

package com.jungle.dao;

import com.jungle.pojo.User;
import java.util.List;

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

}

6. 接口类对应的Mapper文件UserMapper.xml

<?xml version="1.0" encoding="GBK" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<!--绑定一个对应的Dao或者Mapper-->
<!-- 对应接口类的全限定名称 -->
<mapper namespace="com.jungle.dao.UserDao">

    <!-- id 对应 Dao/Mapper中的方法，即接口中对应的方法-->
    <!-- resultType 对应 返回值类型，实体类的全限定名称-->
    <!-- select是对数据库的查询操作 -->
    <select id="getUserList" resultType="com.jungle.pojo.User">
        select * from users
    </select>

</mapper>

5、使用测试类对本次代码进行验证

1. 测试类所在位置如下图所示：
   
2. 测试类test01

package com.jungle;

import com.jungle.dao.UserDao;
import com.jungle.pojo.User;
import com.jungle.utils.MybatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;

import java.util.List;

public class test01 {

    @Test
    public void test(){
        //获取SqlSession
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        //执行sql
        UserDao userDao = sqlSession.getMapper(UserDao.class);
        List<User> userList = userDao.getUserList();

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

        //关闭SqlSession
        sqlSession.close();
    }
}

3. 执行测试类，得到结果：
   

6、总结

• 在pom.xml中加入：mybatis、mysql、Junit的相关依赖；
• 还需在pom.xml加入resources标签，以便编译或运行时自动将配置文件放入target目录下；
• 在src/main/resources中，创建mybatis-config.xml核心配置文件；
• 创建实体类xxx.java，其中的属性名建议与所要操作的表中列名一致；
• 创建工具类MybatisUtils.java，参考mybatis官方文档，自定义一个Mybatis工具类；
• 创建接口xxxDao.java，接口中的方法为操作数据库对应的方法；
• 创建接口对应的配置文件xxxMapper.xml，与6中的xxxDao.java绑定，以便于框架进行实现。

写在最后

• 本文仅供大家参考，如有错误还望大佬指出，将会长期更新；
• 另外，本文仅记录了Mybatis操作中使用xml配置文件的方式。