MyBatis框架 入门案例

二刷复习

简介

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

这里给没接触过框架的同学解释一下什么是框架。框架就是一个半成品软件，是一套可重用的、通用的、软件基础代码模型，在框架的基础之上构建软件编写更加高效、规范、通用、可扩展。比如在学后端之前，web前端的学习时我们应该都听说或者接触过Vue框架，React框架，还有一些简化代码的框架，例如jQuery和bootstrap。

入门案例

我们以一个案例来熟悉mybatis开发的具体步骤。

既然是有关数据库的开发框架，首先要有一个数据库，如下图：

创建新模块导入坐标

mybatis的导入有两种方式，第一种是导入jar包，就是我们之前学习JDBC时那种操作；第二种是在pox文件里导入坐标。我们既然学习Mave下的框架开发，那么就是用导入坐标的方式导入mybatis。

<dependency>
    <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.6</version><!--这里我们使用3.5.6版本即可-->
    </dependency>
    
    <dependency>    
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.28</version>
    </dependency>
    
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.11</version>
    <scope>test</scope>
</dependency>

后面两个是基本坐标导入，分别是数据库模块和单元测试模块。

核心配置文件的编写

就是配置一个xml文件。这个文件是干什么的呢？就是解决JDBC的硬编码问题，也是来你接数据库操作的关键。我们通常给其文件命名为"mybatis-config.xml"位置在这里：

下面这些代码就是模板我们来分析一下这些代码都代表那些含义。

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "https://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <typeAliases>
        <!--路径-->
    </typeAliases>

    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <!--数据库连接信息-->
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=false&amp;serverTimezone=UTC"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>

    <mappers>
        <!--路径-->
    </mappers>
</configuration>

通过观察我们不难发现在dataSource标签下有着url，username等与数据库连接的相关字眼，没错，这里正是配置连接数据库的代码。其中

<property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=false&amp;serverTimezone=UTC"/>

这条语句的mybatis是数据库名称，这里要注意的我的语法是基于mysql配置坐标8.0.28版本的语法。

typeAliases里面的路径配置我们之后再说，我们先说mappers 标签下映射文件的编写。

这里的映射文件即是SQL语句的映射文件，主要管理编写SQL语句的，是xml类型的文件，所以也要放到resources配置包下。这里我们的命名规则是以表名+mapper的驼峰命名法，例如我们之前刚建立的一个数据库名为user，那么映射文件名就可以以"UserMapper.xml"命名。所以上面mappers标签里的路径应为：

<mappers>
    <package name="UserMapper.xml"/>
</mappers>

注意路径是相对路径，由于在一个包里所以直接写文件名即可。

UserMapper文件里的配置内容：

<?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="test">
    <select id="selectAll" resultType="sdut.jsjxy.pojo.User">
        select * from tb_user;
    </select>
</mapper>

这里就是编写sql语句的地方。在mapper标签下，还有一个select标签，这就对应着查找语句，相应的还可以写insert和update标签。上面的resultType里面的路径就是之后返回数据结果的类型包装文件的路径，是一个java文件。

编码

首先创建实体类的对象，要先创建一个名为pojo的包，然后再创建java文件。这里直接以表的名字命名即可。这个文件的作用就是包装数据库返回值的类型。

package sdut.jsjxy.pojo;

public class User {

    private String id;
    private String username;
    private String password ;
    private String gender;
    private String addr;

    public String getId() {
        return id;
    }

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

    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 getGender() {
        return gender;
    }

    public void setGender(String gender) {
        this.gender = gender;
    }

    public String getAddr() {
        return addr;
    }

    public void setAddr(String addr) {
        this.addr = addr;
    }

    @Override
    public String toString() {
        return "User{" +
                "id='" + id + '\'' +
                ", username='" + username + '\'' +
                ", password='" + password + '\'' +
                ", gender='" + gender + '\'' +
                ", addr='" + addr + '\'' +
                '}';
    }
}

这样我的实体类就写完了

获取sqlSession对像执行sql语句

新建一个文件，作为主类获取SqlsessionFactory对象。

package sdut.jsjxy;

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 sdut.jsjxy.pojo.User;

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

public class MyBatisDemo {
    public static void main(String[] args) throws IOException {

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

        SqlSession sqlSession = sqlSessionFactory.openSession();
        List<User> users = sqlSession.selectList("test.selectAll");

        System.out.println(users);
        sqlSession.close();

    }
}

其中，16-18行代码是以流的的方式获取数据，20-21行是把返回的数据库的值放到一个列表对象里，获取路径为"test.selectAll"，随后输出列表：

成功从数据库读取到信息。

最后给大家看一下文件结构，以免出错：

以上就是mybatis框架一个基础案例，我们主要了解其工作流程，了解文件的建立结构和规范为目的，下一篇文章将讲解mybatsi的重头戏：Mapper代理开发和核心配置文件。