Mybatis

Mybatis练习

目标

能够使用映射配置文件实现CRUD操作

如上图所示产品原型，里面包含了品牌数据的 查询 、按条件查询、添加、删除、批量删除、修改 等功能，而这些功能其实就是对数据库表中的数据进行CRUD操作。接下来我们就使用Mybatis完成品牌数据的增删改查操作。以下是我们要完成功能列表：

查询

查询所有数据

查询详情

条件查询

添加

修改

修改全部字段

修改动态字段

删除

删除一个

批量删除

我们先将必要的环境准备一下。

环境准备

数据库表（tb_brand）及数据准备

-- 删除tb_brand表
drop table if exists tb_brand;
-- 创建tb_brand表
create table tb_brand
(
    -- id 主键
    id           int primary key auto_increment,
    -- 品牌名称
    brand_name   varchar(20),
    -- 企业名称
    company_name varchar(20),
    -- 排序字段
    ordered      int,
    -- 描述信息
    description  varchar(100),
    -- 状态：0：禁用  1：启用
    status       int
);
-- 添加数据
insert into tb_brand (brand_name, company_name, ordered, description, status)
values ('三只松鼠', '三只松鼠股份有限公司', 5, '好吃不上火', 0),('华为', '华为技术有限公司', 100, '华为致力于把数字世界带入每个人、每个家庭、每个组织，构建万物互联的智能世界', 1), ('小米', '小米科技有限公司', 50, 'are you ok', 1);

创建maven模块

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.tyhxzy</groupId>
    <artifactId>mybatis-crud</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <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.22</version>
        </dependency>

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

</project>

创建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>

    <settings>
        <!--在控制台显示SQL语句-->
        <setting name="logImpl" value="STDOUT_LOGGING"/>
    </settings>

    <!--定义实体类别名-->
    <typeAliases>
        <package name="com.tyhxzy.pojo"/>
    </typeAliases>

    <environments default="default">
        <!--环境变量-->
        <environment id="default">
            <!--事务管理器-->
            <transactionManager type="JDBC"/>
            <!--数据源-->
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=false&characterEncoding=utf8"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>

    <!--加载其它映射文件-->
    <mappers>
        <package name="com.tyhxzy.mapper"/>
    </mappers>
</configuration>

实体类 Brand

在 com.tyhxzy.pojo 包下创建 Brand 实体类。

package com.tyhxzy.pojo;

public class Brand {
    // id 主键
    private Integer id;
    // 品牌名称
    private String brandName;
    // 企业名称
    private String companyName;
    // 排序字段
    private Integer ordered;
    // 描述信息
    private String description;
    // 状态：0：禁用  1：启用
    private Integer status;

    public Brand() {
    }

    public Brand(Integer id, String brandName, String companyName, Integer ordered, String description, Integer status) {
        this.id = id;
        this.brandName = brandName;
        this.companyName = companyName;
        this.ordered = ordered;
        this.description = description;
        this.status = status;
    }

    public Integer getId() {
        return id;
    }

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

    public String getBrandName() {
        return brandName;
    }

    public void setBrandName(String brandName) {
        this.brandName = brandName;
    }

    public String getCompanyName() {
        return companyName;
    }

    public void setCompanyName(String companyName) {
        this.companyName = companyName;
    }

    public Integer getOrdered() {
        return ordered;
    }

    public void setOrdered(Integer ordered) {
        this.ordered = ordered;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public Integer getStatus() {
        return status;
    }

    public void setStatus(Integer status) {
        this.status = status;
    }

    @Override
    public String toString() {
        return "Brand{" +
                "id=" + id +
                ", brandName='" + brandName + '\'' +
                ", companyName='" + companyName + '\'' +
                ", ordered=" + ordered +
                ", description='" + description + '\'' +
                ", status=" + status +
                '}';
    }
}

编写测试用例

测试代码需要在 test/java 目录下创建包及测试用例。项目结构如下：
安装 MyBatisX 插件
- MybatisX 是一款基于 IDEA 的快速开发插件，为效率而生。
- 主要功能
  - XML映射配置文件和接口方法间相互跳转
  - 根据接口方法生成 statement
- 安装方式
  
  点击 file ，选择 settings ，就能看到如下图所示界面
  
  注意：安装完毕后需要重启IDEA
- 插件效果
  
  红色头绳的表示映射配置文件，蓝色头绳的表示mapper接口。在mapper接口点击红色头绳的小鸟图标会自动跳转到对应的映射配置文件，在映射配置文件中点击蓝色头绳的小鸟图标会自动跳转到对应的mapper接口。也可以在mapper接口中定义方法，自动生成映射配置文件中的 statement ，如图所示

查询所有数据(学员自己完成)

如上图所示就页面上展示的数据，而这些数据需要从数据库进行查询。接下来我们就来讲查询所有数据功能，而实现该功能我们分以下步骤进行实现：

编写接口方法：Mapper接口
- 参数：无
  
  查询所有数据功能是不需要根据任何条件进行查询的，所以此方法不需要参数。
- 结果：List<Brand>
  
  我们会将查询出来的每一条数据封装成一个 Brand 对象，而多条数据封装多个 Brand 对象，需要将这些对象封装到List集合中返回。
- 执行方法、测试

编写接口方法

在 com.tyhxzy.mapper 包写创建名为 BrandMapper 的接口。并在该接口中定义 List<Brand> selectAll() 方法。

package com.tyhxzy.mapper;

import com.tyhxzy.pojo.Brand;
import org.apache.ibatis.annotations.Select;

import java.util.List;

public interface BrandMapper {

    /**
     * 查询所有
     */
    List<Brand> selectAll();
}

编写实体类配置文件，在resources目录下创建目录

创建配置文件

<?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="com.tyhxzy.mapper.BrandMapper">
    <!-- 查询所有品牌 -->
    <select id="selectAll" resultType="com.tyhxzy.pojo.Brand">
        select * from tb_brand
    </select>
</mapper>

创建会话工厂类

在com.tyhxzy.util包下创建工具类

package com.tyhxzy.util;

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 factory;

    static {
        //1.会话工厂的创建类
        SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
        //2.得到配置文件的输入流
        try (InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml")) {
            //3.创建会话工厂
            factory = builder.build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    /**
     * 得到会话对象
     * @return
     */
    public static SqlSession getSession() {
        return factory.openSession();
    }


}

编写测试方法

在 MybatisTest 类中编写测试查询所有的方法

package com.tyhxzy.test;

import com.tyhxzy.mapper.BrandMapper;
import com.tyhxzy.pojo.Brand;
import com.tyhxzy.util.MyBatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;

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

public class MyBatisTest {

    @Test
    public void testSelectAll() {
        //1. 获取SqlSession对象
        SqlSession sqlSession = MyBatisUtils.getSession();

        //2. 获取Mapper接口的代理对象
        BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);

        //3. 执行方法
        List<Brand> brands = brandMapper.selectAll();
        System.out.println(brands);

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

注意：现在我们感觉测试这部分代码写起来特别麻烦，我们可以先忍忍。以后我们只会写上面的第3步的代码，其他的都不需要我们来完成。

执行测试方法结果如下：

从上面结果我们看到了问题，有些数据封装成功了，而有些数据并没有封装成功。为什么这样呢？

这个问题可以通过两种方式进行解决：

给字段起别名
使用resultMap定义字段和属性的映射关系

起别名解决上述问题

从上面结果可以看到 brandName 和 companyName 这两个属性的数据没有封装成功，查询实体类和表中的字段发现，在实体类中属性名是 brandName 和 companyName ，而表中的字段名为 brand_name 和 company_name，如下图所示。那么我们只需要保持这两部分的名称一致这个问题就迎刃而解。

我们可以在写sql语句时给这两个字段起别名，将别名定义成和属性名一致即可。

<select id="selectAll" resultType="brand">
    select
    id, brand_name as brandName, company_name as companyName, ordered, description, status
    from tb_brand;
</select>

而上面的SQL语句中的字段列表书写麻烦，如果表中还有更多的字段，同时其他的功能也需要查询这些字段时就显得我们的代码不够精炼。Mybatis提供了 sql 片段可以提高sql的复用性。

使用resultMap解决上述问题

起别名 + sql片段的方式可以解决上述问题，但是它也存在问题。如果还有功能只需要查询部分字段，而不是查询所有字段，那么我们就需要再定义一个 SQL 片段，这就显得不是那么灵活。

那么我们也可以使用resultMap来定义字段和属性的映射关系的方式解决上述问题。

在映射配置文件中使用resultMap定义字段和属性的映射关系

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

注意：在上面只需要定义字段名和属性名不一样的映射，而一样的则不需要专门定义出来。

SQL语句正常编写

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

在核心配置文件中进行以下配置(推荐)

<settings>
    <!--映射下划线为驼峰命名法-->
    <setting name="mapUnderscoreToCamelCase" value="true"/>
</settings>

那么在实体类映射文件中就可以正常编写

<!-- 查询所有品牌 -->
<select id="selectAll" resultType="brand">
    select * from tb_brand
</select>

小结

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

起别名：在SQL语句中，对不一样的列名起别名，别名和实体类属性名一样
- 可以定义 <sql>片段，提升复用性
resultMap：定义<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>

查询详情

有些数据的属性比较多，在页面表格中无法全部实现，而只会显示部分，而其他属性数据的查询可以通过 查看详情 来进行查询，如上图所示。

查看详情功能实现步骤：

编写接口方法：Mapper接口
- 参数：id
  
  查看详情就是查询某一行数据，所以需要根据id进行查询。而id以后是由页面传递过来。
- 结果：Brand
  
  根据id查询出来的数据只要一条，而将一条数据封装成一个Brand对象即可
编写SQL语句：SQL映射文件
执行方法、进行测试

编写接口方法

在 BrandMapper 接口中定义根据id查询数据的方法

/**
  * 查看详情：根据Id查询
  */
Brand selectById(int id);

编写SQL语句

在 BrandMapper.xml 映射配置文件中编写 statement，使用 resultMap 而不是使用 resultType

<select id="selectById" resultType="brand">
    select *
    from tb_brand
    where id = #{id}
</select>

注意：上述SQL中的 #{id}先这样写，一会我们再详细讲解

编写测试方法

在 test/java 下的 com.tyhxzy.mapper 包下的 MybatisTest类中 定义测试方法

@Test
public void testSelectById() throws IOException {
    //接收参数，该id以后需要传递过来
    int id = 1;

    SqlSession sqlSession = MyBatisUtils.getSession();

    //3. 获取Mapper接口的代理对象
    BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);

    //4. 执行方法
    Brand brand = brandMapper.selectById(id);
    System.out.println(brand);

    //5. 释放资源
    sqlSession.close();
}

执行测试方法结果如下：<img src="https://img2023.cnblogs.com/blog/2147114/202305/2147114-20230517210614871-667266156.png" alt="image-20210729182223137" style="zoom:70%;" />

参数占位符

查询到的结果很好理解就是id为1的这行数据。而这里我们需要看控制台显示的SQL语句，能看到使用？进行占位。说明我们在映射配置文件中的写的 #{id} 最终会被？进行占位。接下来我们就聊聊映射配置文件中的参数占位符。

mybatis提供了两种参数占位符：

{} ：执行SQL时，会将 #{} 占位符替换为？，将来自动设置参数值。从上述例子可以看出使用#{} 底层使用的是 PreparedStatement，如果是字符串会自动加上单引号。
${} ：拼接SQL。底层使用的是 Statement，会存在SQL注入问题。如下图将映射配置文件中的 #{} 替换成 ${} 来看效果，如果是字符串不会加单引号。
```
<select id="selectById" resultType="brand">
    select *
    from tb_brand where id = ${value}
</select>
```
重新运行查看结果如下：

注意：从上面两个例子可以看出，以后开发我们使用 #{} 参数占位符。

SQL语句中特殊字段处理

以后肯定会在SQL语句中写一下特殊字符，比如某一个字段大于某个值，如下图

可以看出报错了，因为映射配置文件是xml类型的问题，而 > < 等这些字符在xml中有特殊含义，所以此时我们需要将这些符号进行转义，可以使用以下两种方式进行转义

转义字符

下图的 < 就是 < 的转义字符。

多条件查询

我们经常会遇到如上图所示的多条件查询，将多条件查询的结果展示在下方的数据列表中。而我们做这个功能需要分析最终的SQL语句应该是什么样，思考两个问题

条件表达式
如何连接

条件字段 企业名称 和 品牌名称 需要进行模糊查询，所以条件应该是：

简单的分析后，我们来看功能实现的步骤：

编写接口方法
- 参数：所有查询条件
- 结果：List<Brand>
在映射配置文件中编写SQL语句
编写测试方法并执行

编写接口方法

在 BrandMapper 接口中定义多条件查询的方法。

而该功能有三个参数，我们就需要考虑定义接口时，参数应该如何定义。Mybatis针对多参数有多种实现

在BrandMapper.java中编写方法

注：mybatis的接口中不支持方法重载，即相同的方法名不能出现2次

使用 @Param("参数名称") 标记每一个参数，在映射配置文件中就需要使用 #{参数名称} 进行占位

List<Brand> selectByCondition(@Param("status") int status, @Param("companyName") String companyName,@Param("brandName") String brandName);

将多个参数封装成一个实体对象，将该实体对象作为接口的方法参数。该方式要求在映射配置文件的SQL中使用 #{内容} 时，里面的内容必须和实体类属性名保持一致。
```
List<Brand> selectByCondition(Brand brand);
```
将多个参数封装到map集合中，将map集合作为接口的方法参数。该方式要求在映射配置文件的SQL中使用 #{内容} 时，里面的内容必须和map集合中键的名称一致。
```
List<Brand> selectByCondition(Map map);
```

注：以上三种方式xml中编写的SQL语句是一样的

编写SQL语句

在 BrandMapper.xml 映射配置文件中编写 statement

注：模糊查询前后加双引号引起%，相当于拼接字符串。

<select id="selectByCondition" resultType="brand">
    select *
    from tb_brand
    where status = #{status}
      and company_name like "%"#{companyName}"%"
      and brand_name like "%"#{brandName}"%"
</select>

编写测试方法

在 test/java 下的 com.tyhxzy.mapper 包下的 MybatisTest类中 定义测试方法

/**
 * 带条件查询
 */
@Test
public void testSelectByCondition() {
    //1. 接收参数
    int status = 1;
    String companyName = "华为";
    String brandName = "华为";

    //2. 获取SqlSession对象
    SqlSession sqlSession = MyBatisUtils.getSession();
    //3. 获取Mapper接口的代理对象
    BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);

    //4. 执行方法
    // 方式一 ：接口方法参数使用 @Param 方式调用的方法
    //List<Brand> brands = brandMapper.selectByCondition(status, companyName, brandName);

    //方式二 ：接口方法参数是 实体类对象 方式调用的方法
    //封装对象
    //Brand brand = new Brand();
    //brand.setStatus(status);
    //brand.setCompanyName(companyName);
    //brand.setBrandName(brandName);

    //List<Brand> brands = brandMapper.selectByCondition(brand);

    //方式三 ：接口方法参数是 map集合对象 方式调用的方法
    Map map = new HashMap();
    map.put("status" , status);
    map.put("companyName", companyName);
    map.put("brandName" , brandName);
    List<Brand> brands = brandMapper.selectByCondition(map);
    System.out.println(brands);
  
    //输出
    brands.forEach(System.out::println);
    //5. 释放资源
    sqlSession.close();
}

动态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

where

choose (when, otherwise)

trim (where, set)

foreach

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

if 标签：条件判断

test 属性：逻辑表达式

<select id="selectByCondition" resultType="brand">
    select *
    from tb_brand
    where
    <if test="status != null">
        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>

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

如上的这种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" resultType="brand">
    select *
    from tb_brand
    <where>
        <if test="status != null">
            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 关键字。

单个条件（动态SQL）

如上图所示，在查询时只能选择 品牌名称、当前状态、企业名称 这三个条件中的一个，但是用户到底选择哪儿一个，我们并不能确定。这种就属于单个条件的动态SQL语句。

这种需求需要使用到 choose（when，otherwise）标签 实现，而 choose 标签类似于Java 中的switch语句。

通过一个案例来使用这些标签

编写接口方法

在 BrandMapper 接口中定义单条件查询的方法。

/**
  * 单条件动态查询
  * @param brand
  * @return
  */
List<Brand> selectByConditionSingle(Brand brand);

编写SQL语句

在 BrandMapper.xml 映射配置文件中编写 statement

<select id="selectByConditionSingle" resultType="brand">
    select *
    from tb_brand
    <where>
        <choose><!--相当于switch-->
            <when test="status != null"><!--相当于case-->
                status = #{status}
            </when>
            <when test="companyName != null and companyName != '' "><!--相当于case-->
                company_name like #{companyName}
            </when>
            <when test="brandName != null and brandName != ''"><!--相当于case-->
                brand_name like #{brandName}
            </when>
            <!-- 也可以使用otherwise，相当于default -->
        </choose>
    </where>
</select>

编写测试方法

在 test/java 下的 com.tyhxzy.mapper 包下的 MybatisTest类中 定义测试方法

/**
 * 带条件查询
 */
@Test
public void testSelectByCondition() {
    //1. 接收参数
    int status = 1;
    String companyName = "华为";
    String brandName = "华为";

    //2. 获取SqlSession对象
    SqlSession sqlSession = MyBatisUtils.getSession();
    //3. 获取Mapper接口的代理对象
    BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);

    //4. 执行方法
    //接口方法参数是 map集合对象 方式调用的方法
    Map map = new HashMap();
    map.put("status", status);
    map.put("companyName", companyName);
    map.put("brandName", brandName);
    List<Brand> brands = brandMapper.selectByCondition(map);
    System.out.println(brands);

    //输出
    brands.forEach(System.out::println);
    //5. 释放资源
    sqlSession.close();
}

执行测试方法结果如下：

添加数据

如上图是我们平时在添加数据时展示的页面，而我们在该页面输入想要的数据后添加 提交 按钮，就会将这些数据添加到数据库中。接下来我们就来实现添加数据的操作。

编写接口方法

参数：除了id之外的所有的数据。id对应的是表中主键值，而主键我们是自动增长生成的。
编写SQL语句
编写测试方法并执行

明确了该功能实现的步骤后，接下来我们进行具体的操作。

编写接口方法

在 BrandMapper 接口中定义添加方法。

 /**
   * 添加
   */
int add(Brand brand);

编写SQL语句

在 BrandMapper.xml 映射配置文件中编写添加数据的 statement

<insert id="add">
    insert into tb_brand (brand_name, company_name, ordered, description, status)
    values (#{brandName}, #{companyName}, #{ordered}, #{description}, #{status});
</insert>

编写测试方法

在 test/java 下的 com.tyhxzy.mapper 包下的 MybatisTest类中 定义测试方法

@Test
public void testAdd() throws IOException {
    //接收参数
    int status = 1;
    String companyName = "波导手机";
    String brandName = "波导";
    String description = "手机中的战斗机";
    int ordered = 100;

    //封装对象
    Brand brand = new Brand();
    brand.setStatus(status);
    brand.setCompanyName(companyName);
    brand.setBrandName(brandName);
    brand.setDescription(description);
    brand.setOrdered(ordered);

    //1. 获取SqlSessionFactory
    String resource = "mybatis-config.xml";
    InputStream inputStream = Resources.getResourceAsStream(resource);
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    //2. 获取SqlSession对象
    SqlSession sqlSession = sqlSessionFactory.openSession();
    //SqlSession sqlSession = sqlSessionFactory.openSession(true); //设置自动提交事务，这种情况不需要手动提交事务了
    //3. 获取Mapper接口的代理对象
    BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
    //4. 执行方法
    brandMapper.add(brand);
    //提交事务
    sqlSession.commit();
    //5. 释放资源
    sqlSession.close();
}

执行结果如下：

添加-主键返回

在数据添加成功后，有时候需要获取插入数据库数据的主键（主键是自增长）。

比如：添加订单和订单项，如下图就是京东上的订单

订单数据存储在订单表中，订单项存储在订单项表中。

添加订单数据
添加订单项数据，订单项中需要设置所属订单的id

明白了什么时候 主键返回 。接下来我们简单模拟一下，在添加完数据后打印id属性值，能打印出来说明已经获取到了。

我们将上面添加品牌数据的案例中映射配置文件里 statement 进行修改，如下

<insert id="add" useGeneratedKeys="true" keyProperty="id">
    insert into tb_brand (brand_name, company_name, ordered, description, status)
    values (#{brandName}, #{companyName}, #{ordered}, #{description}, #{status});
</insert>

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

useGeneratedKeys：是够获取自动增长的主键值。true表示获取

keyProperty ：指定将获取到的主键值封装到哪儿个属性里

后期可以通过以下代码获取新加的主键：

System.out.println("新的主键是：" + brand.getId());

修改

如图所示是修改页面，用户在该页面书写需要修改的数据，点击 提交 按钮，就会将数据库中对应的数据进行修改。注意一点，如果哪儿个输入框没有输入内容，我们是将表中数据对应字段值替换为空白还是保留字段之前的值？答案肯定是保留之前的数据。

接下来我们就具体来实现

编写接口方法

在 BrandMapper 接口中定义修改方法。

 /**
   * 修改
   */
int update(Brand brand);

上述方法参数 Brand 就是封装了需要修改的数据，而id肯定是有数据的，这也是和添加方法的区别。

编写SQL语句

在 BrandMapper.xml 映射配置文件中编写修改数据的 statement。

<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>

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

编写测试方法

在 test/java 下的 com.tyhxzy.mapper 包下的 MybatisTest类中 定义测试方法

@Test
public void testUpdate() throws IOException {
    //接收参数
    int status = 0;
    String companyName = "波导手机";
    String brandName = "波导";
    String description = "波导手机,手机中的战斗机";
    int ordered = 200;
    int id = 6;

    //封装对象
    Brand brand = new Brand();
    brand.setStatus(status);
    //        brand.setCompanyName(companyName);
    //        brand.setBrandName(brandName);
    //        brand.setDescription(description);
    //        brand.setOrdered(ordered);
    brand.setId(id);

    //1. 获取SqlSessionFactory
    String resource = "mybatis-config.xml";
    InputStream inputStream = Resources.getResourceAsStream(resource);
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    //2. 获取SqlSession对象
    SqlSession sqlSession = sqlSessionFactory.openSession();
    //SqlSession sqlSession = sqlSessionFactory.openSession(true);
    //3. 获取Mapper接口的代理对象
    BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
    //4. 执行方法
    int count = brandMapper.update(brand);
    System.out.println(count);
    //提交事务
    sqlSession.commit();
    //5. 释放资源
    sqlSession.close();
}

执行测试方法结果如下：

从结果中SQL语句可以看出，只修改了 status 字段值，因为我们给的数据中只给Brand实体对象的 status 属性设置值了。这就是 set 标签的作用。

删除一行数据

如上图所示，每行数据后面都有一个 删除 按钮，当用户点击了该按钮，就会将改行数据删除掉。那我们就需要思考，这种删除是根据什么进行删除呢？是通过主键id删除，因为id是表中数据的唯一标识。

接下来就来实现该功能。

编写接口方法

在 BrandMapper 接口中定义根据id删除方法。

/**
  * 根据id删除
  */
int deleteById(int id);

编写SQL语句

在 BrandMapper.xml 映射配置文件中编写删除一行数据的 statement

<delete id="deleteById">
    delete from tb_brand where id = #{id};
</delete>

编写测试方法

在 test/java 下的 com.tyhxzy.mapper 包下的 MybatisTest类中 定义测试方法

 @Test
public void testDeleteById() throws IOException {
    //接收参数
    int id = 6;

    //1. 获取SqlSessionFactory
    String resource = "mybatis-config.xml";
    InputStream inputStream = Resources.getResourceAsStream(resource);
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    //2. 获取SqlSession对象
    SqlSession sqlSession = sqlSessionFactory.openSession();
    //SqlSession sqlSession = sqlSessionFactory.openSession(true);
    //3. 获取Mapper接口的代理对象
    BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
    //4. 执行方法
    brandMapper.deleteById(id);
    //提交事务
    sqlSession.commit();
    //5. 释放资源
    sqlSession.close();
}

运行过程只要没报错，直接到数据库查询数据是否还存在。

批量删除

如上图所示，用户可以选择多条数据，然后点击上面的 删除 按钮，就会删除数据库中对应的多行数据。

编写接口方法

在 BrandMapper 接口中定义删除多行数据的方法。

/**
  * 批量删除
  */
int deleteByIds(int[] ids);

参数是一个数组，数组中存储的是多条数据的id

编写SQL语句

在 BrandMapper.xml 映射配置文件中编写删除多条数据的 statement。

编写SQL时需要遍历数组来拼接SQL语句。Mybatis 提供了 foreach 标签供我们使用

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);

编写测试方法

在 test/java 下的 com.tyhxzy.mapper 包下的 MybatisTest类中 定义测试方法

@Test
public void testDeleteByIds() throws IOException {
    //接收参数
    int[] ids = {5,7,8};

    //1. 获取SqlSessionFactory
    String resource = "mybatis-config.xml";
    InputStream inputStream = Resources.getResourceAsStream(resource);
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    //2. 获取SqlSession对象
    SqlSession sqlSession = sqlSessionFactory.openSession();
    //SqlSession sqlSession = sqlSessionFactory.openSession(true);
    //3. 获取Mapper接口的代理对象
    BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
    //4. 执行方法
    brandMapper.deleteByIds(ids);
    //提交事务
    sqlSession.commit();
    //5. 释放资源
    sqlSession.close();
}

Mybatis参数传递

Mybatis 接口方法中可以接收各种各样的参数，如下：

多个参数
单个参数：单个参数又可以是如下类型
- POJO 类型
- Map 集合类型
- Collection 集合类型
- List 集合类型
- Array 类型
- 其他类型

多个参数

如下面的代码，就是接收两个参数，而接收多个参数需要使用 @Param 注解，那么为什么要加该注解呢？这个问题要弄明白就必须来研究Mybatis 底层对于这些参数是如何处理的。

package com.tyhxzy.pojo;

public class User {
    private int id;
    private String username;
    private String password;
    private String gender;
    private String addr;

    public User() {
    }

    public User(int id, String username, String password, String gender, String addr) {
        this.id = id;
        this.username = username;
        this.password = password;
        this.gender = gender;
        this.addr = addr;
    }

    public int getId() {
        return id;
    }

    public void setId(int 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 + '\'' +
                '}';
    }
}

UserMapper接口

public interface UserMapper {

    User login(@Param("username") String username, @Param("password") String password);
}

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="com.tyhxzy.mapper.UserMapper">

    <select id="login" resultType="user">
        select *
        from tb_user
        where username = #{username}
          and password = #{password}
    </select>

</mapper>

测试类

package com.tyhxzy.test;

import com.tyhxzy.mapper.UserMapper;
import com.tyhxzy.pojo.User;
import com.tyhxzy.util.MyBatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;

public class UserMapperTest {

    @Test
    public void testLogin() {
        SqlSession sqlSession = MyBatisUtils.getSession();

        //3. 获取Mapper接口的代理对象
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);

        //4. 执行方法
        User user = userMapper.login("zhangsan","123");
        System.out.println(user);

        //5. 释放资源
        sqlSession.close();
    }
}

我们在接口方法中定义多个参数，Mybatis 会将这些参数封装成 Map 集合对象，值就是参数值，而键在没有使用 @Param 注解时有以下命名规则：

以 arg 开头：第一个参数就叫 arg0，第二个参数就叫 arg1，以此类推。如：

map.put("arg0"，参数值1);

map.put("arg1"，参数值2);
以 param 开头：第一个参数就叫 param1，第二个参数就叫 param2，依次类推。如：

map.put("param1"，参数值1);

map.put("param2"，参数值2);

<font color='red'>注：arg从0开始，param从1开始</font>

代码验证：

在 UserMapper 接口中定义如下方法

User login(String username,String password);

在 UserMapper.xml 映射配置文件中定义SQL

<select id="login" resultType="user">
	select *
    from tb_user
    where 
    	username=#{arg0}
    	and password=#{arg1}
</select>

或者

<select id="login" resultType="user">
	select *
    from tb_user
    where 
    	username=#{param1}
    	and password=#{param2}
</select>

运行代码结果如下

在映射配合文件的SQL语句中使用用 arg 开头的和 param 书写，代码的可读性会变的特别差，此时可以使用 @Param 注解。

在接口方法参数上使用 @Param 注解，Mybatis 会将 arg 开头的键名替换为对应注解的属性值。

代码验证：

在 UserMapper 接口中定义如下方法，在 username 参数前加上 @Param 注解
```
User login(@Param("username") String username, String password);
```
Mybatis 在封装 Map 集合时，键名就会变成如下：

map.put("username"，参数值1);

map.put("arg1"，参数值2);

map.put("param1"，参数值1);

map.put("param2"，参数值2);

在 UserMapper.xml 映射配置文件中定义SQL

<select id="login" resultType="user">
	select *
    from tb_user
    where 
    	username=#{username}
    	and password=#{param2}
</select>

结论：以后接口参数是多个时，在每个参数上都使用 @Param 注解。这样代码的可读性更高。

单个参数

POJO 类型

直接使用。要求 属性名 和 参数占位符名称 一致
Map 集合类型

直接使用。要求 map集合的键名 和 参数占位符名称 一致
Collection 集合类型

Mybatis 会将集合封装到 map 集合中，如下：

map.put("arg0"，collection集合);

map.put("collection"，collection集合);

可以使用 @Param 注解替换map集合中默认的 arg 键名。
List 集合类型

Mybatis 会将集合封装到 map 集合中，如下：

map.put("arg0"，list集合);

map.put("collection"，list集合);

map.put("list"，list集合);

可以使用 @Param 注解替换map集合中默认的 arg 键名。

Array 类型

Mybatis 会将集合封装到 map 集合中，如下：

map.put("arg0"，数组);

map.put("array"，数组);

可以使用 @Param 注解替换map集合中默认的 arg 键名。

/**
 * 批量删除
 */
int deleteByIds(@Param("ids") int[] ids);

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

其他类型

比如int类型，参数占位符名称 叫什么都可以。尽量做到见名知意

posted @ 2023-05-16 21:31 YxinHaaa 阅读(17) 评论(0) 编辑收藏举报

会员力量，点亮园子希望

刷新页面返回顶部

YXH自习室

Mybatis

Mybatis练习

环境准备

查询所有数据(学员自己完成)

编写接口方法

创建会话工厂类

编写测试方法

起别名解决上述问题

使用resultMap解决上述问题

在核心配置文件中进行以下配置(推荐)

小结

查询详情

编写接口方法

编写SQL语句

编写测试方法

参数占位符

{} ：执行SQL时，会将 #{} 占位符替换为？，将来自动设置参数值。从上述例子可以看出使用#{} 底层使用的是 PreparedStatement，如果是字符串会自动加上单引号。

SQL语句中特殊字段处理

多条件查询

编写接口方法

编写SQL语句

编写测试方法

动态SQL

单个条件（动态SQL）

编写接口方法

编写SQL语句

编写测试方法

添加数据

编写接口方法

编写SQL语句

编写测试方法

添加-主键返回

修改

编写接口方法

编写SQL语句

编写测试方法

删除一行数据

编写接口方法

编写SQL语句

编写测试方法

批量删除

编写接口方法

编写SQL语句

foreach 标签

编写测试方法

Mybatis参数传递

多个参数

单个参数

公告

{} ：执行SQL时，会将 #{} 占位符替换为？，将来自动设置参数值。从上述例子可以看出使用#{} 底层使用的是 `PreparedStatement`，如果是字符串会自动加上单引号。