Mybatis练习

目标

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

1，配置文件实现CRUD

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

查询
查询所有数据
查询详情
条件查询

添加
修改
修改全部字段
修改动态字段

删除
删除一个
批量删除

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

1.1 环境准备

数据库表（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);

实体类 Brand

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

public class Brand {
    // id 主键
    private Integer id;
    // 品牌名称
    private String brandName;
    // 企业名称
    private String companyName;
    // 排序字段
    private Integer ordered;
    // 描述信息
    private String description;
    // 状态：0：禁用  1：启用
    private Integer status;
    
    //省略 setter and getter。自己写时要补全这部分代码
}

编写测试用例

测试代码需要在 test/java 目录下创建包及测试用例。项目结构如下：

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

1.2 查询所有数据

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

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

1.2.1 编写接口方法

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

public interface BrandMapper {

    
    List selectAll();
}

1.2.2 编写SQL语句

在 reources 下创建 com/itheima/mapper 目录结构，并在该目录下创建名为 BrandMapper.xml 的映射配置文件





    
    select
    id, brand_name as brandName, company_name as companyName, ordered, description, status
    from tb_brand;

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

SQL片段：

将需要复用的SQL片段抽取到 sql 标签中
```
	id, brand_name as brandName, company_name as companyName, ordered, description, status
```
id属性值是唯一标识，引用时也是通过该值进行引用。

在原sql语句中进行引用

使用 include 标签引用上述的 SQL 片段，而 refid 指定上述 SQL 片段的id值。


    select *
    from tb_brand;

1.2.6 小结

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

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

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

 
     
     
     





    select *
    from tb_brand where id = #{id};

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

1.3.3 编写测试方法

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

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

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

    //2. 获取SqlSession对象
    SqlSession sqlSession = sqlSessionFactory.openSession();

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

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

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

执行测试方法结果如下：

1.3.4 参数占位符

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

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

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

${} ：拼接SQL。底层使用的是 Statement，会存在SQL注入问题。如下图将映射配置文件中的 #{} 替换成 ${} 来看效果


    select *
    from tb_brand where id = ${id};

1.3.6 SQL语句中特殊字段处理

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

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

转义字符

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

1.4 多条件查询

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

条件表达式
如何连接

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

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

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

1.4.1 编写接口方法

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

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

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

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

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

1.4.2 编写SQL语句

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


    select *
    from tb_brand
    
        
            
                status = #{status}
            
            
                company_name like #{companyName}
            
            
                brand_name like #{brandName}

1.5.3 编写测试方法

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

@Test
public void testSelectByConditionSingle() throws IOException {
    //接收参数
    int status = 1;
    String companyName = "华为";
    String brandName = "华为";

    // 处理参数
    companyName = "%" + companyName + "%";
    brandName = "%" + brandName + "%";

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

    //1. 获取SqlSessionFactory
    String resource = "mybatis-config.xml";
    InputStream inputStream = Resources.getResourceAsStream(resource);
    SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    //2. 获取SqlSession对象
    SqlSession sqlSession = sqlSessionFactory.openSession();
    //3. 获取Mapper接口的代理对象
    BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
    //4. 执行方法
    List brands = brandMapper.selectByConditionSingle(brand);
    System.out.println(brands);

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

执行测试方法结果如下：

1.6 添加数据

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

编写接口方法

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

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

1.6.1 编写接口方法

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

 
void add(Brand brand);

1.6.2 编写SQL语句

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


    insert into tb_brand (brand_name, company_name, ordered, description, status)
    values (#{brandName}, #{companyName}, #{ordered}, #{description}, #{status});

1.6.3 编写测试方法

在 test/java 下的 com.itheima.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();
}

执行结果如下：

1.6.4 添加-主键返回

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

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

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

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

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

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


    insert into tb_brand (brand_name, company_name, ordered, description, status)
    values (#{brandName}, #{companyName}, #{ordered}, #{description}, #{status});

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

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

1.7 修改

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

接下来我们就具体来实现

1.7.1 编写接口方法

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

 
void update(Brand brand);

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

1.7.2 编写SQL语句

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


    update tb_brand
    
        
            brand_name = #{brandName},
        
        
            company_name = #{companyName},
        
        
            ordered = #{ordered},
        
        
            description = #{description},
        
        
            status = #{status}
        
    
    where id = #{id};

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

1.7.3 编写测试方法

在 test/java 下的 com.itheima.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 标签的作用。

1.8 删除一行数据

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

接下来就来实现该功能。

1.8.1 编写接口方法

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

void deleteById(int id);

1.8.2 编写SQL语句

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


    delete from tb_brand where id = #{id};

1.8.3 编写测试方法

在 test/java 下的 com.itheima.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();
}

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

1.9 批量删除

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

1.9.1 编写接口方法

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

void deleteByIds(int[] ids);

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

1.9.2 编写SQL语句

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

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

foreach 标签

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

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


    delete from tb_brand where id
    in
    
        #{id}
    
    ;

假如数组中的id数据是{1,2,3}，那么拼接后的sql语句就是：
delete from tb_brand where id in (1,2,3);

1.9.3 编写测试方法

在 test/java 下的 com.itheima.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();
}

1.10 Mybatis参数传递

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

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

1.10.1 多个参数

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

User select(@Param("username") String username,@Param("password") String password);


	select *
    from tb_user
    where 
    	username=#{arg0}
    	and password=#{arg1}

或者


	select *
    from tb_user
    where 
    	username=#{username}
    	and password=#{param2}

运行程序结果没有报错。而如果将 #{} 中的 username 还是写成 arg0