Mybatis

# MYBATIS

## 关于Mybatis框架

 Mybatis框架解决了数据库编程相关的问题，主要是简化了数据库编程。

当使用Mybatis框架实现数据库编程时，只需要：

- 定义数据操作功能的抽象方法（此抽象方法必须在接口中）
- 配置以上抽象方法映射的SQL语句

Mybatis框架在实现过程中，会自动生成各接口的代理对象，所以，开发人员并不需要关注接口的实现问题。



## 使用Mybatis框架

在Spring Boot项目中，当需要使用Mybatis框架实现数据库编程时，需要添加：

- `mybatis-spring-boot-starter`
- 数据库的依赖，例如`mysql-connector-java`

所以，在`pom.xml`中添加：

```xml
<!-- Mybatis框架 -->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.2.2</version>
</dependency>
<!-- MySQL依赖项，仅运行时需要 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>
```

由于添加以上依赖后，Spring Boot在启动时就会读取连接数据库的配置信息，如果未配置，则启动报错且失败，需要在`src/main/resources`下的`application.properties`中添加必要的配置：

```
spring.datasource.url=jdbc:mysql://localhast:8888
```

> 提示：以上配置中，属性名称是固定，以上示例值是错误值，但是，启动Spring Boot只是加载以上配置，并不会执行连接，所以，配置值错误并不影响启动项目。



## 连接数据库的配置

在Spring Boot项目中，`src/main/resources`下的`application.properties`是默认的配置文件，项目在启动时，Spring Boot会自动从此文件中读取相关的配置信息。

在许多配置过程中，需要在`application.properties`中的配置的属性的名称是固定的！

在配置数据库的连接信息时，至少需要配置`spring.datasource.url`、`spring.datasource.username`、`spring.datasource.password`这3个属性，分别表示连接数据库的URL、登录数据库的用户名、登录数据库的密码

```
spring.datasource.url=jdbc:mysql://localhost:3306/xxx?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai

spring.datasource.username=root

spring.datasource.password=root
```

为了检验配置值是否正确，可以在`src/test/java`下默认的包下创建`DatabaseConnectionTests`测试类，在测试类中编写测试方法，以尝试连接数据库，即可检验：

```java
package cn.tedu.csmall.server;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import javax.sql.DataSource;

// 测试类必须：
// 1. 在组件扫描的包下（默认的包及其子孙包）
// 2. 只有添加了@SpringBootTest注解才会加载整个项目的运行环境（包括Spring、读取配置等）
@SpringBootTest
public class DatabaseConnectionTests {

    // Spring Boot自动读取application.properties的配置，并创建了数据源对象
    @Autowired
    DataSource dataSource;

    // 连接数据库，可用于检查application.properties中的连接参数值是否正确
    @Test
    public void testConnection() throws Exception {
        // 获取与MySQL的连接，此方法的调用会实质的连接数据库
        dataSource.getConnection();
        System.out.println("当你看到这句话时，表示在application.properties中的数据库连接参数的值是正确的");
    }

}
```



## 关于设计数据表

## 关于id

阿里巴巴的建议是：每张表都应该有`id`字段，且是`bigint unsigned`类型，其中，`bigint`对应Java中的`long`类型，`unsigned`表示“无符号位”，将使得此字段值不会出现负数，且取值区间是原正数的2倍……以`tinyint`为例，没有添加`unsigned`时，取值区间是[-128, 127]，添加`unsigned`以后，取值区间是[0, 255]。

当把`id`的类型设置为`bigint`时，理论上id值足够使用，即使不添加`unsigned`也不会出现id值不够用的情况，但仍推荐添加，其目的是为了表现语义。

### 关于编码

应该在创建表时指定编码，创建库时可以不指定编码。

在MySQL / MariaDB强烈推荐使用`utf8mb4`。

### 关于字符串的字段类型

如果某个字符串类型的字段的值的长度变化可能较大，应该使用`varchar`类型，例如用户名，如果某个字符串类型的字段的值的长度**变化不大**，应该使用`char`类型。

**注意：某些数据可能是纯数字的，但并不具备算术运算含义，也应该使用字符串类型，不要使用数值类型。**

在使用`varchar`时，指定的长度一定是“大于必要长度”的标准，例如，现行的标准是“用户名最多15个字符”，则建议设计为`varchar(25)`或比`25`更大的值，但是，也不要过于夸张，避免影响语义。



## 使用Mybatis时定义的抽象方法

使用Mybatis时，定义的抽象方法都必须在接口中，通常，接口会使用`Mapper`作为名称的最后一个单词，例如命令为`BrandMapper`等。

关于抽象方法的声明原则：

- 返回值类型：如果需要执行的SQL是增、删、改类型的，统一使用`int`作为返回值类型，表示“受影响的行数”，其实也可以使用`void`，但并不推荐
- 方法名称：自定义
  - 获取单个对象的方法用 get 做前缀
  - 获取多个对象的方法用 list 做前缀
  - 获取统计值的方法用 count 做前缀
  - 插入的方法用 save/insert 做前缀
  - 删除的方法用 remove/delete 做前缀
  - 修改的方法用 update 做前缀
- 参数列表：如果需要执行的SQL语句中的参数数量较多，推荐将多个参数封装到自定义类中



## 关于@Mapper和@MapperScan

Mybatis框架只要求开发人员编写接口和抽象方法，不需要开发人员编写实现类，是因为Mybatis会通过代理模式自动生成接口的实现对象，但是，它需要明确哪些接口是需要生成代理对象的。

可以在各接口上添加`@Mapper`注解，在启动项目时，Mybatis会对整个项目进行扫描，对于已经添加此注解的接口，就会生成代理对象。

也可以在**配置类**上添加`@MapperScan`注解，用于指定各接口所在的包，则Mybatis会扫描此包及其子孙包下的所有接口，并生成这些接口的代理对象。

关于`@Mapper`和`@MapperScan`这2种注解，只需要选择其中1种使用即可，通常推荐`@MapperScan`。

**注意：使用`@MapperScan`时，一定只指向Mapper接口所在的包，并确保此包下无其它接口！**

**提示：Mybatis框架的`@MapperScan`，与Spring框架的`@ComponentScan`没有任何关系，且不会互相影响！**



## 使用Mybatis实现插入数据

以实现“插入品牌数据”为例，需要执行的SQL语句大致是：

```mysql
insert into pms_brand (name, pinyin, logo, description, keywords, sort, sales, product_count, comment_count, positive_comment_count, enable, gmt_create, gmt_modified) values (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?);
```

先在项目的默认包下创建`pojo.entity.Brand`类，类中的属性应该与数据表对应：

```java
public class Brand implements Serializable {

    private Long id;
    private String name;
    private String pinyin;
    private String logo;
    private String description;
    private String keywords;
    private Integer sort;
    private Integer sales;
    private Integer productCount;
    private Integer commentCount;
    private Integer positiveCommentCount;
    private Integer enable;
    private LocalDateTime gmtCreate;
    private LocalDateTime gmtModified;
 
    // 按照POJO规范补充后续代码
    
}
```

接下来，准备接口和抽象方法，在项目的默认包下创建`mapper.BrandMapper`接口，并在接口中添加抽象方法：

```java
package cn.tedu.csmall.server.mapper;

import cn.tedu.csmall.server.pojo.entity.Brand;

public interface BrandMapper {

    /**
     * 插入品牌数据
     * @param brand 品牌数据
     * @return 受影响的行数，成功插入数据时，将返回1
     */
    int insert(Brand brand);

}
```

关于SQL语句，可以使用`@Insert`等注解进行配置，但不推荐！

推荐使用XML文件配置SQL语句，此文件模版可以通过 http://doc.canglaoshi.org/config/Mapper.xml.zip 下载。

然后，在`src/main/resources`下创建`mapper`文件夹，将下载得到的zip文件解压，得到`SomeMapper.xml`文件，将此XML文件复制到`mapper`文件夹中。

先将`SomeMapper.xml`重命名为`BrandMapper.xml`。

关于此文件的配置：

- 根节名必须是`<mapper>`
- 根节点必须配置`namespace`属性，取值为对应的接口的全限定名
- 在根节点内部，根据需要执行的SQL语句的类型不同，使用`<insert>`、`<delete>`、`<update>`、`<select>`节点
- 在`<insert>`等节点上，必须配置`id`属性，取值为抽象方法的名称（不包含括号及参数）
- 在`<insert>`等节点内部，配置SQL语句，SQL语句不需要使用分号结束

例如配置为：

```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="cn.tedu.csmall.server.mapper.BrandMapper">

    <!-- int insert(Brand brand); -->
    <insert id="insert">
        insert into pms_brand (
            name, pinyin, logo, description, keywords,
            sort, sales, product_count, comment_count, positive_comment_count,
            enable, gmt_create, gmt_modified
        ) values (
            #{name}, #{pinyin}, #{logo}, #{description}, #{keywords},
            #{sort}, #{sales}, #{productCount}, #{commentCount}, #{positiveCommentCount},
            #{enable}, #{gmtCreate}, #{gmtModified}
        )
    </insert>

</mapper>
```

最后，还需要补充一个配置，用于告诉Mybatis框架这类XML文件的位置！在`application.properties`中添加：

```
mybatis.mapper-locations=classpath:mapper/*.xml
```

另外，在插入数据时，还可以配置，得到自动编号的ID值，具体做法是在`<insert>`节点上添加配置：

```xml
<!-- int insert(Brand brand); -->
<insert id="insert" useGeneratedKeys="true" keyProperty="id">
    暂不关心此处的SQL语句
</insert>
```



## 练习

目标：实现向`pms_album`表中插入数据，并要求可以获取自动编号的id。

开发步骤：

- 在`entity`包创建`Album`实体类，类中的属性与`pms_album`表保持一致，且符合POJO规范
- 在`mapper`包中创建`AlbumMapper`接口
- 在`AlbumMapper`接口中添加抽象方法：`int insert(Album album);`（记得添加注释）
- 在`src/main/resources`的`mapper`文件夹下，通过复制粘贴得到`AlbumMapper.xml`文件
- 配置`AlbumMapper.xml`中的根节点的`namespace`
- 在`AlbumMapper.xml`中，在根节点内部添加`<insert>`节点，并配置`id`、`useGeneratedKeys`、`keyProperty`属性，在`<insert>`节点内部配置SQL语句
- 在`src/test/java`下的`cn.tedu.csmall.server.mapper`包（你的包名可能不同）下创建`AlbumMapperTests`测试类，在类中自动装配`AlbumMapper`对象，并编写、执行测试方法



## 使用Mybatis实现删除数据

目标：根据id删除某个品牌

需要执行的SQL语句大致是：

```mysql
delete from pms_brand where id=?
```

在`BrandMapper`接口中添加抽象方法：

```java
/**
 * 根据品牌id，删除品牌数据
 * @param id 期望删除的品牌数据的id
 * @return 受影响的行数，当删除成功时，将返回1，如果无此id对应的数据，将返回0
 */
int deleteById(Long id);
```

在`BrandMapper.xml`中配置SQL：

```xml
<!-- int deleteById(Long id); -->
<delete id="deleteById">
    delete from pms_brand where id=#{id}
</delete>
```

在`BrandMapperTests`中编写并执行测试：

```java
@Test
public void testDeleteById() {
    Long id = 1L;
    int rows = mapper.deleteById(id);
    System.out.println("删除完成，受影响的行数=" + rows);
}
```



## 练习

目标：实现根据id删除`pms_album`表中的数据。



## 使用Mybatis实现修改数据

目标：实现根据id修改`pms_brand`表中某条数据的`name`字段值。

需要执行的SQL语句大致是：

```mysql
update pms_brand set name=? where id=?
```

在`BrandMapper`接口中添加抽象方法：

```java
/**
 * 根据id修改品牌的名称
 * @param id 品牌id
 * @param name 新的品牌名称
 * @return 受影响的行数，当修改成功时，将返回1，如果无此id对应的数据，将返回0
 */
int updateNameById(@Param("id") Long id, @Param("name") String name);
```

在`BrandMapper.xml`中配置SQL：

```xml
<!-- int updateNameById(@Param("id") Long id, @Param("name") String name); -->
<update id="updateNameById">
    update pms_brand set name=#{name} where id=#{id}
</update>
```

在`BrandMapperTests`中编写并执行测试：

```java
@Test
public void testUpdateNameById() {
    Long id = 3L;
    String name = "白萝卜";
    int rows = mapper.updateNameById(id, name);
    System.out.println("修改品牌名称完成，受影响的行数=" + rows);
}
```



## 练习

目标：实现根据id修改`pms_album`表中某条数据的`name`字段值。



## 使用Mybatis实现批量删除数据

在Mybatis中，有“动态SQL”的机制，它允许根据调用方法时传入的参数值不同，来生成不同的SQL语句。

目标：根据若干个`id`一次性删除多个品牌。

需要执行的SQL语句大致是：

```mysql
delete from pms_brand where id=? or id=? or id=?;
```

或者：

```mysql
delete from pms_brand where id in (?, ?, ?);
```

注意：以上SQL语句中的`id`的数量是不确定的。

在`BrandMapper`接口中，抽象方法可以是：

```java
int deleteByIds(Long... ids); // 注意：可变参数在处理时，本质上就是数组
```

或者：

```java
int deleteByIds(Long[] ids);
```

或者：

```java
int deleteByIds(List<Long> ids);
```

在`BrandMapper.xml`中配置SQL语句：

```xml
<!-- int deleteByIds(Long... ids); -->
<delete id="deleteByIds">
    delete from pms_brand where id in (
       <foreach collection="array" item="id" separator=",">
            #{id}
       </foreach>
    )
</delete>
```

由于需要对参数`ids`（若干个`id`）进行遍历，需要使用到动态SQL中的`<foreach>`节点，此节点可以对数组或集合进行遍历！关于`<foreach>`的配置：

- `collection`属性：表示被遍历的参数对象，当抽象方法的参数只有1个，且没有添加`@Param`注解时，当参数值的类型是数组时，此属性值为`array`，当参数值的类型是`List`时，此属性值为`list`；否则，此属性值为`@Param`注解中的参数值
- `item`属性：表示被遍历到的元素的名称，是自定义的名称，在`<foreach>`内部，使用`#{}`格式的占位符时，也使用此属性来表示每个元素
- `separator`属性：表示遍历过程中各元素值之间的分隔符号

最后，在`BrandMapperTests`中编写并执行测试：

```java
@Test
public void testDeleteByIds() {
    int rows = mapper.deleteByIds(1L, 3L, 5L, 7L, 9L);
    System.out.println("批量删除完成，受影响的行数=" + rows);
}
```



## 使用Mybatis实现查询数据



## 关于异常

### BindingException

绑定异常，异常提示信息如下：

```
org.apache.ibatis.binding.BindingException: Invalid bound statement (not found): cn.tedu.csmall.server.mapper.BrandMapper.insert
```

出现此异常是因为找不到与抽象方法对应的SQL语句，原因可能有：

- 在XML中配置的接口名有误
  - `<mapper>`节点的`namespace`属性值有误
- 在XML中配置的抽象方法名称有误
  - `<insert>`或类似节点的`id`属性值有误
- 在配置文件中指定的XML路径，此项配置有误
  - `application.properties`中配置的`mybatis.mapper-locations`属性有误
- 如果十分确实以上代码都没有问题，则只可能是依赖项出错
  - 先检查`pom.xml`中的依赖代码是否正确，如果无误，则删除本地仓库并重新下载



## 课后作业（周末，一周内提交到系统）

在当前项目（`jds2203-csmall-server`）中，通过Mybatis实现：

- 向插入`pms_album`表、`pms_attribute`表等共计12张表中插入数据（已完成的不必重复开发，但均需提交）
- 根据`id`删除`pms_album`表、`pms_attribute`表等共计12张表中的数据（已完成的不必重复开发，但均需提交）
- 根据若干个`id`删除`pms_album`表、`pms_attribute`表等共计12张表中的数据（已完成的不必重复开发，但均需提交）

在实现过程中，你可能需要创建必要的类、接口等文件，例如实体类、Mapper接口、XML文件、测试类，请按照课上标准命名，并放在正常的包或文件夹中。

以上所有功能必须有对应的测试。