MyBatis框架笔记整理

MYBATIS
- 关于Mybatis
- 使用Mybatis框架
- 连接数据库的配置
- 关于设计数据表
- - 关于id
  - 关于编码
  - 关于字符串的字段类型
- 使用Mybatis时定义的抽象方法
- 关于 @Maopper 和 @MapperScan
- 使用Mybatis实现插入数据
- 使用Mybatis实现删除数据
- 使用Mybatis实现批量删除数据
- 使用Mybatis实现修改数据
- 末完待续.......
- 关于异常
- - BindingException

MYBATIS

关于Mybatis

当使用Mybatis框架实现数据库编程时，只需要：ybatis框架解决了数据库编程相关的问题，主要是简化了数据库编程。

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

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

使用Mybatis框架

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

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

所以，在pom.xml中添加：


<dependency>
    <groupId>org.mybatis.spring.bootgroupId>
    <artifactId>mybatis-spring-boot-starterartifactId>
    <version>2.2.2version>
dependency>

<dependency>
    <groupId>mysqlgroupId>
    <artifactId>mysql-connector-javaartifactId>
    <scope>runtimescope>
dependency>

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

spring.datasource.url=jdbc:mysql://localhost:8888

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

连接数据库的配置

在Spring Boot项目中，src/main/resources下的application.properties是默认的配置文件，项目在启动时，Spring Boot会自动从此文件中读取相关的配置信息。
在许多配置过程中，需要在application.properties中的配置的属性的名称是固定的！
在配置数据库的连接信息时，至少需要配置spring.datasource.url、spring.datasource.name、spring.datasource.password这三个属性，分别表示连接数据库的URL、登录数据库的用户名、登录数据库的密码

spring.datasource.url=jdbc:mysql://localhost:3306/mall_pms?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=root

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

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等。
关于抽象方法的声明原则：

方法名称：自定义
- 获取单个对象的方法用get做前缀
- 获取多个对象的方法用list做前缀
- 获取统计值的方法用count做前缀
- 插入的方法使用save/delete做前缀
- 删除的方法使用remove/delete做前缀
- 修改的方法使用update做前缀
参数列表：如果需要执行的SQL语句中的参数数量较多，推荐将多个参数封装在自定义类中

关于 @Maopper 和 @MapperScan

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

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

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

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

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

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

使用Mybatis实现插入数据

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

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类，类中的属性应该与数据表对应：

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接口，并在接口中添加抽象方法：

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语句，此文件模版可以通过点击下载。

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

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

关于此文件的配置：

根节名必须是
根节点必须配置namespace属性，取值为对应的接口的全限定名
在根节点内部，根据需要执行的SQL语句的类型不同，使用、、、