本文介绍了MyBatis的基础知识及其在SSM框架中数据库后端操作的应用。首先，简要概述了JDBC和MyBatis的关系，强调MyBatis作为持久层框架简化了JDBC的开发。接着，详细描述了创建SpringBoot项目的准备工作，包括数据库配置、定义Mapper接口、执行SQL操作及单元测试等步骤。文中还阐述了数据库连接池的概念，介绍了Lombok工具以提高Java开发效率，以及如何进行基础的CRUD操作和动态SQL处理。最后，提到XML映射文件的使用规范和动态SQL构建的标签。

MyBatis官网：https://blog.mybatis.org

1 数据库后端操作概述

JDBC（Java DataBase Connectivity）是sun公司官方定义的一套使用Java语言操作所有关系型数据库的API（规范）。各个数据库厂商去实现这套接口，提供数据库驱动jar包。我们可以使用这套接口（JDBC）编程，真正执行的代码是驱动jar包中的实现类。
MyBatis（官网：https://mybatis.org/mybatis-3/zh_CN/index.html）是一款优秀的持久层框架，用于简化JDBC的开发。

快速入门：

1. 准备工作（创建SpringBoot工程、数据库表user、实体类User）

2. 在application.properties中配置数据库连接：引入MyBatis的相关依赖，配置数据库的连接信息——四要素

# application.properties
# 驱动类名称
spring.datasource.driver-class-name = com.mysql.cj.jdbc.Driver
# 数据库连接的url
spring.datasource.url = jdbc:mysql://localhost:3306/数据库
# 连接数据库的用户名
spring.datasource.username = 用户名
# 连接数据库的密码
spring.datasource.password = 密码

3. 用注释@Mapper定义mapper接口，并在操作注释中编写SQL语句（或者用XML映射文件）：运行时会自动生成该接口的实体类对象（代理对象），并将该对象成为Bean交给IOC容器管理

/* mapper.UserMapper.java */
@Mapper
public interface UserMapper {
    @Select("select * from user")
    public List<User> list(); // 查询全部用户信息
}

4. 单元测试：使用依赖注入（DI）

/* SpringbootMybatisQuickstartApplicationTests.java */
@SpringBootTest
class SpringbootMybatisQuickstartApplicationTests {
    @Autowired
    private UserMapper userMapper;

    @Test
    public void testListUser() {
        List<User> userList = userMapper.list();
        userList.stream().forEach(System.out::println);
    }
}

默认在MyBatis中编写SQL语句是不识别的，可如下图右键配置，并在Idea中配置MySQL数据库的连接（参见MySQL数据库基础教程）以识别表信息

要想查看MyBatis的日志，可以在application.properties中添加以下内容：

# 指定mybatis输出日志的位置，输出控制台
mybatis.configuration.log-impl = org.apache.ibatis.logging.stdout.StdOutImpl

---

2 数据库连接池

数据库连接池是负责分配、管理数据库连接（Connection）的容器。它允许应用程序重复使用一个现有的数据库连接，而不是再重新建立一个。释放空闲时间超过最大空闲时间的连接，来避免因为没有释放连接而引起的数据库连接遗漏。

优势：资源重用、提升系统响应速度、避免数据库连接遗漏

DataSource：sun公司官方提供的数据库连接池标准接口，由第三方组织实现此接口，用于获取连接

Connection getConnection() throws SQLException;

Hikari连接池是SpringBoot默认的连接池。

Druid（德鲁伊）连接池是阿里巴巴开源的数据库连接池项目，功能强大，性能优秀，是Java语言最好的数据库连接池之一。切换成Druid数据库连接池只需引入起步依赖druid-spring-boot-starter，详见：官方文档。

---

3 lombok工具包

Lombok是一个实用的lava类库，能通过注解的形式自动生成构造器、getter/setter、equals、hashCode、toString等方法，并可以自动化生成日志变量，简化java开发、提高效率。Lombok会在编译时自动生成对应的java代码，使用时需要安装一个lombok的插件（Idea自带）并引入依赖lombok。

常用的Lombok注解	作用
@Getter/@Setter	为所有的属性提供 get/set 方法
@ToString	会给类自动生成易阅读的 toString 方法
@EqualsAndHashCode	根据类所拥有的非静态字段自动重写 equals 方法和 hashCode 方法
@Data	提供了更综合的生成代码功能（@Getter+@Setter+@ToString+@EqualsAndHashCode）
@NoArgsConstructor	为实体类生成无参构造器
@AllArgsConstructor	为实体类生成除了static修饰的字段外的全参构造器

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Emp {
    private Integer id;
    private String username;
    private String password;
    private String name;
    private Short gender;   // 性别：1男，2女
    private String image;   // 图像url
    private Short job;      // 职位：1班主任，2讲师，3保安
    private LocalDate entrydate;    // 对应表中entrydate为date类型
    private Integer deptId;
    private LocalDateTime createTime;   // 对应表中create_time为datetime类型
    private LocalDateTime updateTime;   // 对应表中update_time为datetime类型
}

---

4 基础操作

案例：用MyBatis对员工表emp和部门表dept进行操作，相关的数据类Emp等参照MySQL基础教程中数据库表定义。

4.1 占位符

参数占位符	说明	使用时机
#{...}	执行SQL时会被预编译为?，会自动设置参数值	参数传递时使用
${...}	直接将参数拼接在SQL语句中，存在SQL注入问题	对表名、列表进行动态设置时使用

预编译SQL性能更高，更安全（防止SQL注入）。#{...}会被预编译为?。

SQL注入是通过操作输入的数据来修改事先定义好的SQL语句，以达到执行代码对服务器进行攻击的方法。

4.2 删除

可以获取返回值，为删除的记录数量，不需要时设置返回值为void即可（插入、更新等操作同理）。

/* com.hyplus.mapper.EmpMapper.java */
@Mapper
public interface EmpMapper {
    // 例：删除指定ID的所有数据
    @Delete("delete from emp where id = #{id}")
    public int delete(Integer id);
}

/* SpringbootMybatisCrudApplicationTests.java */
@SpringBootTest
class SpringbootMybatisCrudApplicationTests {
    @Autowired
    private EmpMapper empMapper;

    @Test
    public void testDelete() {
        int cnt = empMapper.delete(37);     // 例：删除ID为37的数据
        System.out.println(cnt);
    }
}

4.3 新增

可直接用POJO替换冗长的形参列表，占位符中的参数即为同名的对象属性。

主键返回：在数据添加成功后，需要获取插入数据库数据的主键。想获取主键可以在上述mapper接口方法上追加注释@Options并在其中设置参数，其中useGeneratedKeys = true表示想获取生成的主键值，keyProperty为获取的主键所封装到的POJO属性。

/* com.hyplus.mapper.EmpMapper.java */
@Mapper
public interface EmpMapper {
    // 例：新增员工
    @Options(keyProperty = "id", useGeneratedKeys = true) // 自动将主键赋给emp对象的id属性
    @Insert("insert into emp (username, name, gender, image, job, entrydate, dept_id, create_time, update_time) " + 
            "values (#{username}, #{name}, #{gender}, #{image}, #{job}, #{entrydate}, #{deptID}, #{createTime}, #{updateTime})")
    public void insert(Emp emp);
}

/* SpringbootMybatisCrudApplicationTests.java */
@SpringBootTest
class SpringbootMybatisCrudApplicationTests {
    @Autowired
    private EmpMapper empMapper;

    @Test
    public void testInsert() {
        // 新建员工对象
        Emp emp = new Emp();
        emp.setUsername("hyplus");
        emp.setName("Akira");
        emp.setImage("my_pfp.jpg");
        emp.setGender((short)2);
        emp.setJob((short)1);
        emp.setEntrydate(LocalDate.of(2000, 1, 1));
        emp.setCreateTime(LocalDateTime.now());
        emp.setUpdateTime(LocalDateTime.now());
        emp.setDeptId(1);

        // 添加员工
        empMapper.insert(emp);
    }
}

LocalDate.of(年, 月, 日)：返回指定日期。LocalDateTime.now()返回当前日期时间。

4.4 更新

/* com.hyplus.mapper.EmpMapper.java */
@Mapper
public interface EmpMapper {
    // 例：更新员工
    @Update("update emp set username = #{username}, name = #{name}, gender = #{gender}, image = #{image}, job = #{job}, entrydate = #{entrydate}, " +
            "dept_id = #{deptId}, create_time = #{createTime}, update_time = #{updateTime} where id = #{id}")
    public void update(Emp emp);
}

/* SpringbootMybatisCrudApplicationTests.java */
@SpringBootTest
class SpringbootMybatisCrudApplicationTests {
    @Autowired
    private EmpMapper empMapper;

    @Test
    public void testUpdate() {
        // 设置更新后的员工对象
        Emp emp = new Emp();
        emp.setId(18);      // 例：设置ID为18的员工
        emp.setUsername("hyplus");
        emp.setName("Akira");
        emp.setImage("my_pfp.jpg");
        emp.setGender((short)2);
        emp.setJob((short)1);
        emp.setEntrydate(LocalDate.of(2000, 1, 1));
        emp.setUpdateTime(LocalDateTime.now());     // 每次更新必须将updateTime更新为当前时间
        emp.setDeptId(1);

        // 更新员工
        empMapper.update(emp);
    }
}

4.5 查询

4.5.1 根据ID查询

数据封装：若实体类属性名和数据库表查询返回的字段名一致，MyBatis会自动封装；若不一致，则不能自动封装。
解决不一致的方法：

1. 直接给字段起别名
2. 使用注解@Results、@Result手动映射封装
3. 开启MyBatis的驼峰命名自动映射开关：a_column $\rightarrow$ aColumn

# application.properties
# 开启驼峰命名自动映射
mybatis.configuracion.map-underscore-to-canel-case = true

【例】根据ID查询员工

/* com.hyplus.mapper.EmpMapper.java */
@Mapper
public interface EmpMapper {
    // 例：根据ID查询员工
    @Select("select * from emp where id = #{id}")
    public Emp getById(Integer id);

    // 发生不匹配时的解决方法
    // 法1：给字段起别名，让别名与实体类属性一致
    // @Select("select id, username, password, name, gender, image, job, entrydate, " + 
    //      "dept_id deptId, create_time createTime, update_time updateTime from emp where id = #{id}")
    // public Emp getById(Integer id);

    // 法2：通过@Results, @Result注解手动映射封装（column -> property）
    // @Results({
    //      @Result(column = "dept_id", property = "deptId"),
    //      @Result(column = "create_time", property = "createTime"),
    //      @Result(column = "update_time", property = "updateTime"),
    // })
    // @Select("select * from emp where id = #{id}")
    // public Emp getById(Integer id);

    // 法3：开启驼峰命名自动映射，无需改动
}

/* SpringbootMybatisCrudApplicationTests.java */
@SpringBootTest
class SpringbootMybatisCrudApplicationTests {
    @Autowired
    private EmpMapper empMapper;

    @Test
    public void testGetByID() {
        Emp emp = empMapper.getByID(20);
        System.out.println(emp);
    }
}

4.5.2 条件查询

#{...}预编译为?后无法出现在单引号(' ')之内，有两种替代方式：

1. 占位符改用${...}。性能低、不安全、存在SQL注入问题。
2. 使用MySQL提供的函数concat(str1, str2, ...)拼接字符串。推荐用这种方式。

/* com.hyplus.mapper.EmpMapper.java */
@Mapper
public interface EmpMapper {
    // 例：查询指定的姓名含某字符串、性别、入职日期范围的所有员工
    @Select("select * from emp where name like concat('%', #{name}, '%') and gender = #{gender} and " +
            "entrydate between #{begin} and #{end} order by update_time desc")
    public List<Emp> list(String name, Short gender, LocalDate begin, LocalDate end);
}

在SpringBoot的1.x版本或单独使用MyBatis时，每个形参前都需追加注释@Param并在其中指定字段名

---

5 XML映射文件

MyBatis的XML映射文件约束请查阅官网：https://mybatis.org/mybatis-3/zh_CN/getting-started.html

建议安装MyBatisX插件

规范：

1. XML映射文件的名称与Mapper接口名称一致，并且将XML映射文件和Mapper接口放置在相同包下（同包同名）。
2. XML映射文件的namespace属性与Mapper接口全限定名一致。
3. XML映射文件中SQL语句中的标签名与SQL操作名一致（<select ...>、<update ...>等），id属性值与Mapper接口中的方法名一致，resultType属性也与接口方法的返回类型中的单条属性类型一致。

上述4.5.2中EmpMapper接口list()方法上的注释可改写为如下的xml映射文件

<!-- src/main/resources/com/hyplus/mapper/EmpMapper.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
    PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
    "https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.hyplus.mapper.EmpMapper">
    <select id="list" resultType="com.hyplus.pojo.Emp">
        select * from emp where name like concat('%', #{name}, '%') and gender = #{gender} 
                 and entrydate between #{begin} and #{end} order by update_time desc
    </select>
</mapper>

/* com.hyplus.mapper.EmpMapper.java */
@Mapper
public interface EmpMapper {
    // 调用该方法时会自动查找对应的xml配置文件中id属性名为该方法名的SQL语句
    public List<Emp> list(String name, Short gender, LocalDate begin, LocalDate end);
}

使用注解来映射简单语句会使代码显得更加简洁，但对于稍微复杂一点的语句，Java注解不仅力不从心，还会让本就复杂的SQL语句更加混乱不堪。 因此，如果需要做一些很复杂的操作，最好用XML来映射语句。
选择何种方式来配置映射，以及是否应该要统一映射语句定义的形式，完全取决于你和你的团队。 换句话说，永远不要拘泥于一种方式，你可以很轻松地在基于注解和XML的语句映射方式间自由移植和切换。

---

6 动态SQL

动态SQL：随着用户的输入或外部条件的变化而变化的SQL语句

6.1 if标签

• <if>：用于判断条件是否成立。使用test属性进行条件判断，其中字段名应与对象属性名一致（不是表字段名），如果条件为true，则拼接SQL
• <where>：替换where关键字，只会在子元素有内容的情况下才插入where子句，同时去除子句开头多余的and或or关键字
• <set>：替换set关键字，将所有更新字段全部包裹，同时去除子句末尾多余的逗号

<!-- 例1：改写5中的xml映射文件，动态改变查询条件 -->
<select id="list" resultType="com.hyplus.pojo.Emp">
    select * from emp 
    <where>
        <if test="name != null">
            name like concat('%', #{name}, '%')
        </if>
        <if test="gender != null">
            and gender = #{gender} 
        </if>
        <if test="begin != null and end != null">
            and entrydate between #{begin} and #{end}
        </if>
    </where>
    order by update_time desc
</select>

<!-- 例2：动态更新员工数据信息 -->
<update id="update">
    update emp
    <set>
        <if test="username != null">
            username = #{username},
        </if>
        <if test="name != null">
            name = #{name},
        </if>
        ...
        <if test="deptId != null">
            dept_id = #{deptID},
        </if>
        <if test="updateTime != null">
            update_time = #{updateTime}
        </if>
    </set>
    where id = #{id}
</update>

6.2 foreach标签

• <foreach>：遍历列表中的所有元素，各属性含义如下：
  • collection：遍历的集合（与接口方法参数名一致）
  • item：集合遍历出来的元素/项（"i"）
  • separator：每一次遍历使用的分隔符，拼接时分隔元素
  • open：遍历开始前拼接的SQL片段
  • close：遍历结束后拼接的SQL片段

<!-- 例：根据ID(主键)批量删除员工 -->
<delete id="deleteByIds">
    delete from emp where id in
    <foreach collection="ids" item="id" separator="," open="(" close=")">
        #{id}
    </foreach>
</delete>

6.3 sql、include标签

• <sql>：定义可重用的SQL片段并设置其id属性。
• <include>：通过属性refid指定包含的SQL片段。

<!-- 例：抽取出查询操作共用的SQL语句段 -->
<sql id="commonSelect">
    select id, username, password, name, gender, image, job, entrytime, dept_id, create_time, update_time
    from emp
</sql>

<select id="list" resultType="com.hyplus.pojo.Emp">
    <include refid="commonSelect">
        ...
</select>