MyBatis学习（一）之初探MyBatis大体结构与简单实现

最新推荐文章于 2025-02-10 16:57:33 发布

IPostYellow

最新推荐文章于 2025-02-10 16:57:33 发布

阅读量393

点赞数

分类专栏： # Mybatis学习文章标签： mybatis maven java

本文链接：https://blog.csdn.net/Doraemon_Nobita/article/details/115795402

版权

Mybatis学习专栏收录该内容

10 篇文章 0 订阅

订阅专栏

记录自己在狂神说java中的学习情况，文章里有自己学习的理解和扩展，新手难免有理解偏差或者错误，恳请大佬指正。

Java自学 MyBatis

Java MyBatis

Java MyBatis

环境：

JDK1.8
Mysql 5.7
maven 3.6.1
IDEA

SSM框架：配置文件，最好的方式：看官网文档

需要知识：

JDBC
Mysql
Java基础
Maven
junit

1 简介

1.1什么是MyBatis

MyBatis是一款优秀的持久层框架。
它支持定制化SQL、存储过程以及高级映射。
MyBatis避免了几乎所有的JDBC代码和手动设置参数以及获取结果集。
MyBatis可以使用简单的XML或注解来配置和映射原生类型、接口和Java的POJO（Plain Old Java Objects，普通老式Java对象）为数据库中的记录。
MyBatis本是apache的一个开源项目iBatis，2010年这个项目由apache software foundation迁移到了google code，并且改名为MyBatis。
2013年11月迁移到github。

如何获得Mybatis？

Maven仓库里搜索mybatis

<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.2</version>
</dependency>

在github上下载
中文文档

1.2持久化

持久化就是就是将程序的数据在持久状态和瞬时状态转化的过程。
内存：断电即失。
数据库（jdbc），io文件持久化。
生活中的例子：冷藏，买来的肉，先冷藏起来，要吃的时候才解冻。水果罐头。

为什么需要持久化？

有一些对象，不能被丢掉，比如支付宝里的钱。不能丢！！！
内存成本太贵

1.3持久层

Dao层、Service层、Controller层。。。等等层都有自己的工作。

而持久层是完成持久化工作的代码块
层界限十分明显

1.4为什么需要Mybatis？

帮助程序员将数据存入到数据库中
方便
传统的JDBC代码太复杂。需要简化。所以有了框架。
不用Mybatis也可以。只是Mybatis更容易上手。技术没有高低之分。
优点：
- 简单易学：本身就很小且简单。没有任何第三方依赖，最简单安装只要两个jar文件+配置几个sql映射文件易于学习，易于使用，通过文档和源代码，可以比较完全的掌握它的设计思路和实现。
- 灵活：mybatis不会对应用程序或者数据库的现有设计强加任何影响。 sql写在xml里，便于统一管理和优化。通过sql语句可以满足操作数据库的所有需求。
- 解除sql与程序代码的耦合：通过提供DAO层，将业务逻辑和数据访问逻辑分离，使系统的设计更清晰，更易维护，更易单元测试。sql和代码的分离，提高了可维护性。
- 提供映射标签，支持对象与数据库的orm字段关系映射。
- 提供对象关系映射标签，支持对象关系组建维护。
- 提供xml标签，支持编写动态sql。

2 Mybatis实战

本文所有代码
思路：搭建环境——>导入Mybatis包——>编写代码——>测试

2.1搭建环境

新建数据库：

CREATE DATABASE mybatis;
CREATE TABLE user(id INT(20) NOT NULL,name VARCHAR(30) DEFAULT NULL,pwd VARCHAR(30) DEFAULT NULL)ENGINE=INNODB DEFAULT CHARSET =utf8;
INSERT INTO user(id,name,pwd) VALUES(1,"张三","121231");
INSERT INTO user(id,name,pwd) VALUES(2,"李四","121231");
INSERT INTO user(id,name,pwd) VALUES(3,"王五","121231");

新建项目

1.新建一个普通的maven项目

2.删除src，将其视为父工程。

3.导入依赖包

这里导入如下的依赖包：

<?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>org.example</groupId>
    <artifactId>mybaitsuse</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>
    <modules>
        <module>mybatis-01</module>
    </modules>
    <!--导入依赖-->
    <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.2</version>
        </dependency>
        <!--junit-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>

    </dependencies>

</project>

2.2创建模块

右键新建一个module，创建一个子maven项目

在这里插入图片描述

取名叫mybatis-01。

子项目里的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>mybaitsuse</artifactId>
        <groupId>org.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>mybatis-01</artifactId>
</project>

可以看到他有父工程导入的包，这样就不用再导入那些包了。

现在整个项目的结构如下：

在这里插入图片描述
根据mybatis3文档中的入门教程。

在resources下新建一个file，名称为mybatis-config.xml

并将教程中的内容粘贴进去：

编写mybatis核心配置文件

<?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核心配置文件-->
<configuration>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <!--mysql 8.x 是com.mysql.cj.jdbc.Driver-->
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <!--连接数据库的时候有个url，然后具体到mybatis这个数据库，然后使用ssl，编码utf8等等设置-->
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=false&amp;useUnicode=true&amp;characterEncoding=UTF-8"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>
    <!--每一个Mapper.xml都需要在Mybatis核心配置文件中注册-->
    <mappers>
        <mapper resource="com/hj/dao/UserMapper.xml"/>
    </mappers>
</configuration>

编写mybatis工具类

刚刚完成了mybatis-config.xml。那么现在可以看到每个基于Mybatis的应用都需要有一个SqlSessionFactory的实例为核心，这意味着只要使用MyBatis的应用，都需要这部分代码。那我们可以把这部分代码弄成工具类。

在这里插入图片描述

我们在mybatis-01项目里创建工具类

在这里插入图片描述

然后在MybatisUtils里写好我们的封装代码：

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

//sqlSessionFactory ——>sqlSession
public class MybatisUtils {
    private static SqlSessionFactory sqlSessionFactory; //先定义这个sqlSession工厂对象，这样作用于就在整个类里了
    static {
        try {
            //使用mybatis第一步，获取sqlSession对象
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();+
        }
    }

    //既然有了SqlSessionFactory，顾名思义，我们就可以从中获得SqlSession的实例了
    //sqlSession完全包含了面向数据库执行SQL命令所需的所有方法
    public static SqlSession getSqlSession(){
        return sqlSessionFactory.openSession();
    }
}

2.3编写代码

实体类

//src/main/java/com/hj/pojo/User.java
package com.hj.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 void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

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

    public String getPwd() {
        return pwd;
    }

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

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

Dao接口

//src/main/java/com/hj/dao/UserDao.java
package com.hj.dao;

import com.hj.pojo.User;

import java.util.List;

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

接口实现类

传统基于JDBC的代码需要利用接口实现类去实现Dao接口,多生成一个UserDaoImpl.java文件。现在Mybatis将这一操作简化为编写xml了。下面是官方文档里的描述：

在这里插入图片描述

我们把官方文档的代码拿过来进行简单修改：这样接口实现类由原来的UserDaoImpl转变为一个Mapper配置文件，注意命名空间使用全限定名。

<!--src/main/java/com/hj/dao/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">
<!--namespace=绑定一个对应的Dao/Mapper接口-->
<mapper namespace="com.hj.dao.UserDao">
    <!--select查询语句，这里的id为接口里实现方法的方法名-->
    <select id="getUserList" resultType="com.hj.pojo.User">
    select * from mybatis.user;
  </select>
</mapper>

2.4测试

根据官方文档中所写：

在这里插入图片描述

首先要在所有的pom.xml中的<project>标签里，添加如下代码：

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

不然会出现资源配置错误，报错找不到对应的UserMapper.xml

然后在test文件夹下创建和自己工程目录相似的java文件：

//src/test/java/com/hj/dao/UserDaoTest.java
package com.hj.dao;
import com.hj.pojo.User;
import com.hj.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();
        //方法一：利用getMapper，执行SQL
        UserDao userDao = sqlSession.getMapper(UserDao.class); //获取对应的接口的对象
        List<User> userList = userDao.getUserList();
        for (User user : userList) {
            System.out.println(user);
        }
        //方法二：不推荐这种方法
        List<User> objectList = sqlSession.selectList("com.hj.dao.UserDao.getUserList");
        for (User o : objectList) {
            System.out.println(o);
        }
        //关闭sqlSession
        sqlSession.close();
    }
}

然后运行，即可得到查询User数据库表里的结果

注意点：org.apache.ibatis.binding.BindingException:Type interface com.hj.dao.UserDao is not known to the MapperRegistry

MapperRegistry是什么？

核心配置文件中注册mappers，也就在mybatis-config.xml里的：

<!--每一个Mapper.xml都需要在Mybatis核心配置文件中注册-->
<mappers>
    <mapper resource="com/hj/dao/UserMapper.xml"/>
</mappers>

如果你写的接口和他的mapper没有在这里进行对应的映射，就会报这个错误。

测试中可能会遇到的问题：

1.配置文件没有注册：去mybatis-config.xml里注册

2.绑定接口错误：mapper.xml文件里没有绑定对应的接口或者绑定格式错误

3.方法名不对：同上，然后写错了方法名

4.返回类型不对：同上，返回接口的数据类型不对

3 对于其中的类的作用域和生命周期

在这里插入图片描述

SqlSessionFactoryBuilder一旦创建了SqlSessionFactory就不需要了，而且SqlSessionFactory不需要重复创建多次，所以我们将这两个打包到工具类里，放在静态代码块中，保证执行一次。

然后对于每一个请求，都要实例化一个SqlSession对象。

4 总结：

步骤：

1.先写工具类，实现SqlSessionFactoryBuilder创建SqlSessionFactory，并且实现一个能利用同一个SqlSessionFactory实例来创建不同的SqlSession对象的方法。（这里的代码是写死的，官方要求要这么做的）

2.为了实现工具类里获取Resources，需要在resources文件夹下写一个mybatis核心配置文件，当前例子里核心文件名为mybatis-config.xml。核心配置文件中写了对数据库的连接的一些信息以及对接口的映射mappers。

3.编写实体类，实体类和数据库中的数据表对应起来。

4.编写对实体类操作的接口，然后编写该接口对应的mapper.xml文件。

5.编写测试代码进行测试。

其中，工具类写好就可以不需要改动，核心配置文件里只需要增加mappers里的映射，接下来只需要增加接口和对应的mapper.xml文件就可以实现一些功能了！

本文所有代码

本文所有代码
https://github.com/IPostYellow/mybatisStudyRecords
中的mybatis-01部分