MyBatis的介绍、快速入门，Mapper代理开发，动态SQL的使用

什么是MyBatis

• MyBatis是一款优秀的持久层框架，用于简化JDBC开发
• MyBatis本是Apache的一个开源项目iBatis，2010年这个项目由apache software foundation迁移到了google code，并改名为MyBatis。2013年11月迁移到Github
• 官网：https://mybatis.org/mybatis-3/zh/index.html

持久层

• 负责将数据保存到数据库的那一层代码
• JavaEE三层架构：表现层、业务层、持久层

框架

• 框架就是一个半成品软件，是一套可重用的、通用的、软件基础代码模型
• 在框架的基础上构建软件编写更加高效、规范、通用、可扩展

JDBC的缺点

1. 硬编码
   • 注册驱动，获取连接
   • SQL语句
2. 操作繁琐
   • 手动设置参数
   • 手动封装结果集

MyBatis免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作

Mybatis快速入门

需求：查询user表中所有的数据

• 创建user表，添加数据

  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', '男', '西安');
  

• 创建模块，导入坐标

  在创建好的模块中的 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>
  

  注意：需要在项目的 resources 目录下创建logback的配置文件

• 编写 MyBatis 核心配置文件 – > 替换连接信息 解决硬编码问题

  在模块下的 resources 目录下创建mybatis的配置文件 mybatis-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>
  
      <typeAliases>
          <package name="com.itheima.pojo"/>
      </typeAliases>
      
      <!--
      environments：配置数据库连接环境信息。可以配置多个environment，通过default属性切换不同的environment
      -->
      <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="1234"/>
              </dataSource>
          </environment>
  
          <environment id="test">
              <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="1234"/>
              </dataSource>
          </environment>
      </environments>
      <mappers>
         <!--加载sql映射文件-->
         <mapper resource="UserMapper.xml"/>
      </mappers>
  </configuration>
  

• 编写 SQL 映射文件 --> 统一管理sql语句，解决硬编码问题

  在模块的 resources 目录下创建映射配置文件 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">
  <mapper namespace="test">
      <select id="selectAll" resultType="com.itheima.pojo.User">
          select * from tb_user;
      </select>
  </mapper>
  

• 编码

  • 在 com.itheima.pojo 包下创建 User类

    public class User {
        private int id;
        private String username;
        private String password;
        private String gender;
        private String addr;
        
        //省略了 setter 和 getter
    }
    

  • 在 com.itheima 包下编写 MybatisDemo 测试类

    public class MyBatisDemo {
    
        public static void main(String[] args) throws IOException {
            //1. 加载mybatis的核心配置文件，获取 SqlSessionFactory
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    
            //2. 获取SqlSession对象，用它来执行sql
            SqlSession sqlSession = sqlSessionFactory.openSession();
            //3. 执行sql
            List<User> users = sqlSession.selectList("test.selectAll"); //参数是一个字符串，该字符串必须是映射配置文件的namespace.id
            System.out.println(users);
            //4. 释放资源
            sqlSession.close();
        }
    }
    

解决SQL映射文件的警告提示：

在入门案例映射配置文件中存在报红的情况。问题如下：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-RbRu37Mb-1684557460015)(.\img\sql映射文件的警告.png)]

• 产生的原因：Idea和数据库没有建立连接，不识别表信息。但是大家一定要记住，它并不影响程序的执行。
• 解决方式：在Idea中配置MySQL数据库连接。

Mapper代理开发

目的

• 解决原生方式中的硬编码
• 简化后期执行SQL

使用Mapper代理方式完成入门案例

使用Mapper代理方式，必须满足以下要求：

• 定义与SQL映射文件同名的Mapper接口，并且将Mapper接口和SQL映射文件放置在同一目录下。如下图：

• 设置SQL映射文件的namespace属性为Mapper接口全限定名

实现：

• 在 com.itheima.mapper 包下创建 UserMapper接口，代码如下：

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

• 在 resources 下创建 com/itheima/mapper 目录，并在该目录下创建 UserMapper.xml 映射配置文件

  <!--
      namespace:名称空间。必须是对应接口的全限定名
  -->
  <mapper namespace="com.itheima.mapper.UserMapper">
      <select id="selectAll" resultType="com.itheima.pojo.User">
          select *
          from tb_user;
      </select>
  </mapper>
  

• 在 com.itheima 包下创建 MybatisDemo2 测试类，代码如下：

  /**
   * Mybatis 代理开发
   */
  public class MyBatisDemo2 {
  
      public static void main(String[] args) throws IOException {
  
          //1. 加载mybatis的核心配置文件，获取 SqlSessionFactory
          String resource = "mybatis-config.xml";
          InputStream inputStream = Resources.getResourceAsStream(resource);
          SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
  
          //2. 获取SqlSession对象，用它来执行sql
          SqlSession sqlSession = sqlSessionFactory.openSession();
          //3. 执行sql
          //3.1 获取UserMapper接口的代理对象
          UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
          List<User> users = userMapper.selectAll();
  
          System.out.println(users);
          //4. 释放资源
          sqlSession.close();
      }
  }
  

注意：

如果Mapper接口名称和SQL映射文件名称相同，并在同一目录下，则可以使用包扫描的方式简化SQL映射文件的加载。也就是将核心配置文件的加载映射配置文件的配置修改为

<mappers>
    <!--加载sql映射文件-->
    <!-- <mapper resource="com/itheima/mapper/UserMapper.xml"/>-->
    <!--Mapper代理方式-->
    <package name="com.itheima.mapper"/>
</mappers>

Mybatis核心配置文件

多环境配置

在核心配置文件的 environments 标签中其实是可以配置多个 environment ，使用 id 给每段环境起名，在 environments 中使用 default='环境id' 来指定使用哪儿段配置。我们一般就配置一个 environment 即可。

<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="1234"/>
    </dataSource>
</environment>

<environment id="test">
    <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="1234"/>
    </dataSource>
</environment>
</environments>

类型别名

在映射配置文件中的 resultType 属性需要配置数据封装的类型（类的全限定名）。而每次这样写是特别麻烦的，Mybatis 提供了 类型别名(typeAliases) 可以简化这部分的书写。

首先需要现在核心配置文件中配置类型别名，也就意味着给pojo包下所有的类起了别名（别名就是类名），不区分大小写。内容如下：

<typeAliases>
    <!--name属性的值是实体类所在包-->
    <package name="com.itheima.pojo"/> 
</typeAliases>

通过上述的配置，我们就可以简化映射配置文件中 resultType 属性值的编写

<mapper namespace="com.itheima.mapper.UserMapper">
    <select id="selectAll" resultType="user">
        select * from tb_user;
    </select>
</mapper>

配置文件完成增删改查

MyBatisX插件

• MybatisX是一款基于IDEA的快速开发插件，为效率而生
• 主要功能
  • XML和接口方法相互跳转
  • 根据接口方法生成statement

resultMap

实体类属性名 和 数据库表列名 不一致，不能自动封装数据

• ==起别名：==在SQL语句中，对不一样的列名起别名，别名和实体类属性名一样
  • 可以定义 片段，提升复用性
• ==resultMap：==定义 完成不一致的属性名和列名的映射

而我们最终选择使用 resultMap的方式。查询映射配置文件中查询所有的 statement 书写如下：

 <resultMap id="brandResultMap" type="brand">
     <!--
            id：完成主键字段的映射
                column：表的列名
                property：实体类的属性名
            result：完成一般字段的映射
                column：表的列名
                property：实体类的属性名
        -->
     <result column="brand_name" property="brandName"/>
     <result column="company_name" property="companyName"/>
</resultMap>



<select id="selectAll" resultMap="brandResultMap">
    select *
    from tb_brand;
</select>

主键返回

在 insert 标签上添加如下属性：

• useGeneratedKeys：是够获取自动增长的主键值。true表示获取
• keyProperty ：指定将获取到的主键值封装到哪儿个属性里

动态SQL

动态SQL

上述功能实现存在很大的问题。用户在输入条件时，肯定不会所有的条件都填写，这个时候我们的SQL语句就不能那样写的

例如用户只输入 当前状态 时，SQL语句就是

select * from tb_brand where status = #{status}

而用户如果只输入企业名称时，SQL语句就是

select * from tb_brand where company_name like #{companName}

而用户如果输入了 当前状态 和 企业名称 时，SQL语句又不一样

select * from tb_brand where status = #{status} and company_name like #{companName}

针对上述的需要，Mybatis对动态SQL有很强大的支撑：

• if

• choose (when, otherwise)

• trim (where, set)

• foreach

我们先学习 if 标签和 where 标签：

• if 标签：条件判断

  • test 属性：逻辑表达式

  <select id="selectByCondition" resultMap="brandResultMap">
      select *
      from tb_brand
      where
          <if test="status != null">
              and status = #{status}
          </if>
          <if test="companyName != null and companyName != '' ">
              and company_name like #{companyName}
          </if>
          <if test="brandName != null and brandName != '' ">
              and brand_name like #{brandName}
          </if>
  </select>
  

  如上的这种SQL语句就会根据传递的参数值进行动态的拼接。如果此时status和companyName有值那么就会值拼接这两个条件。

  但是它也存在问题，如果此时给的参数值是

  Map map = new HashMap();
  // map.put("status" , status);
  map.put("companyName", companyName);
  map.put("brandName" , brandName);
  

  拼接的SQL语句就变成了

  select * from tb_brand where and company_name like ? and brand_name like ?
  

  而上面的语句中 where 关键后直接跟 and 关键字，这就是一条错误的SQL语句。这个就可以使用 where 标签解决

• where 标签

  • 作用：
    • 替换where关键字
    • 会动态的去掉第一个条件前的 and
    • 如果所有的参数没有值则不加where关键字

  <select id="selectByCondition" resultMap="brandResultMap">
      select *
      from tb_brand
      <where>
          <if test="status != null">
              and status = #{status}
          </if>
          <if test="companyName != null and companyName != '' ">
              and company_name like #{companyName}
          </if>
          <if test="brandName != null and brandName != '' ">
              and brand_name like #{brandName}
          </if>
      </where>
  </select>
  

  注意：需要给每个条件前都加上 and 关键字。

• set 标签可以用于动态包含需要更新的列，忽略其它不更新的列。

  <update id="update">
      update tb_brand
      <set>
          <if test="brandName != null and brandName != ''">
              brand_name = #{brandName},
          </if>
          <if test="companyName != null and companyName != ''">
              company_name = #{companyName},
          </if>
          <if test="ordered != null">
              ordered = #{ordered},
          </if>
          <if test="description != null and description != ''">
              description = #{description},
          </if>
          <if test="status != null">
              status = #{status}
          </if>
      </set>
      where id = #{id};
  </update>
  

• foreach 标签

  用来迭代任何可迭代的对象（如数组，集合）。

  • collection 属性：
    • mybatis会将数组参数，封装为一个Map集合。
      • 默认：array = 数组
      • 使用@Param注解改变map集合的默认key的名称
  • item 属性：本次迭代获取到的元素。
  • separator 属性：集合项迭代之间的分隔符。foreach 标签不会错误地添加多余的分隔符。也就是最后一次迭代不会加分隔符。
  • open 属性：该属性值是在拼接SQL语句之前拼接的语句，只会拼接一次
  • close 属性：该属性值是在拼接SQL语句拼接后拼接的语句，只会拼接一次

  <delete id="deleteByIds">
      delete from tb_brand where id
      in
      <foreach collection="array" item="id" separator="," open="(" close=")">
          #{id}
      </foreach>
      ;
  </delete>
  

  假如数组中的id数据是{1,2,3}，那么拼接后的sql语句就是：

  delete from tb_brand where id in (1,2,3);
  

MyBatis参数传递

MyBatis接口方法中可以接收各种各样的参数，Mybatis底层对于这些参数进行不同的封装处理方式

• 单个参数
  • POJO类型：直接使用，实体类属性名和参数占位符名称一致
  • Map集合：直接使用，键名和参数占位符名称一致
  • Collection：封装为Map集合
  • List：封装为Map集合
  • Array：封装为Map集合
  • 其他类型：直接使用
• 多个参数：封装为Map集合

MyBatis提供了ParamNameResolver类来进行参数封装

建议：将来都使用@Param注解来修改Map集合中默认的键名，并使用修改后的名称来获取值，这样可读性更高

注解完成增删改查

使用注解开发会比配置文件开发更加方便

@Select("slelct * from tb_user where id = #{id}")
public User selectBuId(int id);

• 查询：@Select
• 添加：@Insert
• 修改：@Update
• 删除：@Delete

提示：

注解完成简单功能

配置完成复杂功能