初识Mybatis -- Mybatis快速入门保姆级教程（一）

---

前言

为了巩固所学的知识，作者尝试着开始发布一些学习笔记类的博客，方便日后回顾。当然，如果能帮到一些萌新进行新技术的学习那也是极好的。作者菜菜一枚，文章中如果有记录错误，欢迎读者朋友们批评指正。
（博客的参考源码以可以在我主页的资源里找到，如果在学习的过程中有什么疑问欢迎大家在评论区向我提出）

---

一、认识mybatis

1.mybatis是什么

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

2.jdbc缺点

• 数据库连接，使用时就创建，不使用就释放，对数据库进行频繁连接开关和关闭，造成数据库资源浪费，影响数据库的性能

• sql语句使用硬编码在java程序中，修改sql语句，就需要重新编译java代码，不利于系统维护

• 向预编译语句PreparedStatement中设置参数，对占位符位置和设置参数值，硬编码，修改sql语句也不需要重新编译java代码

• 从result中遍历结果集数据时，存在硬编码，将获取表的字段进行硬编码

• 示例代码

3.mybatis优点

• 灵活性：MyBatis允许您直接编写原生的SQL语句，提供了很高的灵活性。您可以根据需要编写任何复杂的SQL，从而满足各种业务需求。

• 易于使用：MyBatis通过XML配置文件和注解，让您可以轻松地将SQL语句与Java代码分离，使得代码结构更清晰、易于维护。

• 映射简单：MyBatis提供了简单的映射方式，可以将数据库表中的字段自动映射到Java对象的属性上，降低了数据转换的复杂性。

• 良好的扩展性：MyBatis提供了丰富的插件接口，您可以通过编写自定义插件来扩展MyBatis的功能，以满足特定需求。

• 与其他框架集成：MyBatis可以与Spring、Spring Boot等流行框架无缝集成，提供更加完整的解决方案。

• 社区支持：MyBatis有一个活跃的开发者社区，为使用者提供了丰富的文档、教程和支持。这有助于在遇到问题时快速找到解决方案。

4.MyBatis框架解决JDBC劣势

针对JDBC编程的劣势，MyBatis提供了以下解决方案，具体如下。

• 问题一：数据库链接创建、释放频繁会造成系统资源浪费，从而影响系统性能。

解决方案：在SqlMapConfig.xml中配置数据链接池，使用连接池管理数据库链接。

• 问题二：SQL语句在代码中硬编码，造成代码不易维护。在实际应用的开发中，SQL变化的可能较大。在传统JDBC编程中，SQL变动需要改变Java代码，违反了开闭原则。

解决方案：MyBatis将SQL语句配置在MyBatis的映射文件中，实现了与Java代码的分离。

• 问题三：使用preparedStatement向占位符传参数存在硬编码，因为SQL语句的where条件不一定，可能多也可能少，修改SQL需要修改代码，造成系统不易维护。

解决方案：MyBatis自动将Java对象映射至SQL语句，通过Statement中的parameterType定义输入参数的类型。

• 问题四：JDBC对结果集解析存在硬编码（查询列名），SQL变化导致解析代码变化，造成系统不易维护。

解决方案：MyBatis自动将SQL执行结果映射至Java对象，通过Statement中的resultType定义输出结果的类型。

• 示例代码

二、mybatis入门案例

(详细代码见个人主页mybatis源码re_mb_mapper模块)

1.需求分析与操作步骤

2.创建表tb_user、实体类和Mapper接口

1. 创建数据库表

• 查询语句

create database mybatis;
use mybatis;

drop table if exists tb_user;

create table tb_user(
	id int primary key auto_increment,
	username varchar(20),
	password varchar(20),
	gender char(1),
	addr varchar(30)
);

INSERT INTO tb_user VALUES (1, 'zhangsan', '123', '男', '北京');
INSERT INTO tb_user VALUES (2, '李四', '234', '女', '天津');
INSERT INTO tb_user VALUES (3, '王五', '11', '男', '西安');

• 效果展示

2. 创建实体类及其对应的Mapper接口

• 创建实体类

//省略setter、getter方法和toString方法
public class User {
    
    

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

• 创建对应的实体类user的Mapper接口

public interface UserMapper {
    
    

}

3.创建maven模块re_mb_demon

4.在pom.xml配置文件中导入相关依赖

<dependencies>
        <!--mybatis 依赖-->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.5</version>
        </dependency>

        <!--mysql 驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.46</version>
        </dependency>

        <!--junit 单元测试-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13</version>
            <scope>test</scope>
        </dependency>


        <!-- 添加slf4j日志api -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.20</version>
        </dependency>
        
        <!-- 添加logback-classic依赖 -->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>
        
        <!-- 添加logback-core依赖 -->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-core</artifactId>
            <version>1.2.3</version>
        </dependency>
    </dependencies>

5. 配置相关文件

1. 创建并配置控制台输出日志logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!--
        CONSOLE ：表示当前的日志信息是可以输出到控制台的。
    -->
    <appender name="Console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>[%level]  %cyan([%thread]) %boldGreen(%logger{
    
    15}) - %msg %n</pattern>
        </encoder>
    </appender>

    <logger name="org.example" level="DEBUG" additivity="false">
        <appender-ref ref="Console"/>
    </logger>


    <!--

      level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF
     ， 默认debug
      <root>可以包含零个或多个<appender-ref>元素，标识这个输出位置将会被本日志级别控制。
      -->
    <root level="DEBUG">
        <appender-ref ref="Console"/>
    </root>
</configuration>

2. 创建并配置数据库连接信息mabatis_config.xml

<?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="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql:///mybatis?useSSL=false"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>
    
<!--指定映射配置文件的位置-->
    <mappers>
        <mapper resource="UserMapper.xml"/>
    </mappers>
    
</configuration>

3. 创建并配置映射配置文件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:名称空间-->
<mapper namespace="org.example.mapper.UserMapper">

<!--id: select标签的唯一标识符-->
<!--resultType: 返回值类型-->
    <select id="selectAll" resultType="org.example.pojo.User">
        select *
        from tb_user;
    </select>
    
</mapper>

6.创建并编写模拟测试类MybatisDemon

/**
 * Mybatis 快速入门代码
 */
public class MyBatisDemo {
    
    

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

        //1. 加载mybatis的核心配置文件，获取 SqlSessionFactory
        //定义配置文件路径
        String resource = "mybatis-config.xml";
        //通过mybatis提供的resources资源加载类对象返回一个字节输入流
        InputStream inputStream = Resources.getResourceAsStream(resource);
        //将字节输入流传入SqlSessionFactoryBuilder()的build()方法，返回一个SqlSessionFactory对象
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

        //2. 获取SqlSession对象，用它来执行sql
        SqlSession sqlSession = sqlSessionFactory.openSession();

        //3. 执行sql
        //参数：名称空间 + id
        List<User> users = sqlSession.selectList("org.example.mapper.UserMapper.selectAll");
        System.out.println(users);

        //4. 释放资源
        sqlSession.close();

    }
}

7.运行结果与文件结构

• 运行结果

• 文件结构

8. 解决配置SQL语句警告提示

1. 问题描述

2. 解决方案

（还需要填写数据库名）

三.mybatis mapper代理开发

(在mybatis入门案例的基础上进行编码，详细代码见个人主页mybatis源码re_mb_mapper模块)

1.初识mapper代理开发

• 方法一 ：在一个 XML 映射文件（如案例中的UserMapper.xml）中，可以定义无数个映射语句，这样一来，XML 头部和文档类型声明部分就显得微不足道了。文档的其它部分很直白，容易理解。 它在命名空间 “org.example.mapper.UserMapper” 中定义了一个名为 “selectAll” 的映射语句，这样你就可以用全限定名 “org.example.mapper.UserMapper.selectAll” 来调用映射语句了，就像入门案例模拟测试类中那样：

 List<User> users = sqlSession.selectList("org.example.mapper.UserMapper.selectAll");

• 方法二 ：你可能会注意到，这种方式和用全限定名调用 Java 对象的方法类似。这样，该命名就可以直接映射到在命名空间中同名的映射器类，并将已映射的 select 语句匹配到对应名称、参数和返回类型的方法。因此你就可以像上面那样，不费吹灰之力地在对应的映射器接口调用方法，就像下面这样：

 UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        List<User> users = userMapper.selectAll();

第二种方法有很多优势，首先它不依赖于字符串字面值，会更安全一点；其次，如果你的 IDE 有代码补全功能，那么代码补全可以帮你快速选择到映射好的 SQL 语句。

2.mybatis mapper代理开发规则

3.根据代理开发规则编码示例

1. 定义与 SQL映射文件同名的Mapper接口，并将Mapper接口和SQL映射文件放置在同一个目录下

• 步骤一

• 步骤二

2. 设置SQL映射文件（UserMapper.xml）的namespace属性为Mapper接口全限定名

3. 在Maper接口中定义方法，方法名就是SQL文件中sql语句的id，并保持参数类型和返回值类型一致

public interface UserMapper {
    
    
    List<User> selectAll();
}

4.编码（模拟测试类MybatisDemon）

5. 模拟测试类运行结果

6.包扫描的方式扫描mapper映射文件(mybatis_config.xml)

四、mybatis核心配置文件

1.配置

MyBatis 的配置文件包含了会深深影响 MyBatis 行为的设置和属性信息。 配置文档的顶层结构如下：

.configuration（配置）
   .properties（属性）
   .settings（设置）
   .typeAliases（类型别名）
   .typeHandlers（类型处理器）
   .objectFactory（对象工厂）
   .plugins（插件）
   .environments（环境配置）
       .environment（环境变量）
           .transactionManager（事务管理器）
           .dataSource（数据源）
   .databaseIdProvider（数据库厂商标识）
   .mappers（映射器）

注意：配置各个标签时，需要遵守前后顺序

2.环境配置（environments）

1. 应用场景讲解

MyBatis 可以配置成适应多种环境，这种机制有助于将 SQL 映射应用于多种数据库之中， 现实情况下有多种理由需要这么做。例如，开发、测试和生产环境需要有不同的配置；或者想在具有相同 Schema 的多个生产数据库中使用相同的 SQL 映射。还有许多类似的使用场景。

不过要记住：尽管可以配置多个环境，但每个 SqlSessionFactory 实例只能选择一种环境。

2. 环境配置操作简介

所以，如果你想连接两个数据库，就需要创建两个 SqlSessionFactory 实例，每个数据库对应一个。而如果是三个数据库，就需要三个实例，依此类推，记起来很简单：

每个数据库对应一个 SqlSessionFactory 实例

为了指定创建哪种环境，只要将它作为可选的参数传递给 SqlSessionFactoryBuilder 即可。可以接受环境配置的两个方法签名是：

   SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment);
   SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment, properties);

如果忽略了环境参数，那么将会加载默认环境，如下所示：

   SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader);
   SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, properties);

environments 元素定义了如何配置环境。

<!--environments：配置数据库连接环境信息。可以配置多个environment-->
<!--default: 切换不同的environment-->
<environments default="development">
<environment id="development">
  <transactionManager type="JDBC">
    <property name="..." value="..."/>
  </transactionManager>
  <dataSource type="POOLED">
    <property name="driver" value="${driver}"/>
    <property name="url" value="${url}"/>
    <property name="username" value="${username}"/>
    <property name="password" value="${password}"/>
  </dataSource>
</environment>
</environments>

注意一些关键点:

   默认使用的环境 ID（比如：default="development"）。
   每个 environment 元素定义的环境 ID（比如：id="development"）。
   事务管理器的配置（比如：type="JDBC"）。
   数据源的配置（比如：type="POOLED"）。

默认环境和环境 ID 顾名思义。 环境可以随意命名，但务必保证默认的环境 ID 要匹配其中一个环境 ID。

3.类型别名（typeAliases）

1. 通过配单个配类型别名

类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置，意在降低冗余的全限定类名书写。例如：

<typeAliases>
  <typeAlias alias="Author" type="domain.blog.Author"/>
  <typeAlias alias="Blog" type="domain.blog.Blog"/>
  <typeAlias alias="Comment" type="domain.blog.Comment"/>
  <typeAlias alias="Post" type="domain.blog.Post"/>
  <typeAlias alias="Section" type="domain.blog.Section"/>
  <typeAlias alias="Tag" type="domain.blog.Tag"/>
</typeAliases>

当这样配置时，Blog 可以用在任何使用 domain.blog.Blog 的地方。

2. 通过配包配置类型别名

也可以指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean，比如：

<typeAliases>
  <package name="domain.blog"/>
</typeAliases>

• 示例

（mybatis_config.xml）

(UserMapper.xml)

3. 有注解的情况下类型别名的配置

每一个在包 domain.blog 中的 Java Bean，在没有注解的情况下，会使用 Bean 的首字母小写的非限定类名来作为它的别名。 比如 domain.blog.Author 的别名为 author；若有注解，则别名为其注解值。见下面的例子：

@Alias("author")
public class Author {
    
    
    ...
}

总结

欢迎各位留言交流以及批评指正，如果文章对您有帮助或者觉得作者写的还不错可以点一下关注,点赞，收藏支持一下。
（博客的参考源码可以在我主页的资源里找到，如果在学习的过程中有什么疑问欢迎大家在评论区向我提出）