Mybatis 到 MyBatisPlus

Mybatis

MyBatis（官网：https://mybatis.org/mybatis-3/zh/index.html ）是一款优秀的持久层（ORM）框架，用于简化JDBC的开发。是 Apache的一个开源项目iBatis，2010年这个项目由apache迁移到了google code，并且改名为MyBatis 。2013年11月迁移到Github。

MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。

MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。

    持久层：指的是就是数据访问层(dao)，是用来操作数据库的。

1. 依赖和配置

引入 mybatis 依赖和数据库连接依赖

<dependency>
	<groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.2.2</version>
</dependency>
 
<dependency>
     <groupId>com.mysql</groupId>
     <artifactId>mysql-connector-j</artifactId>
     <scope>runtime</scope>
 </dependency>

数据源信息和mapper映射扫描配置：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/cloud_user?useSSL=false&allowPublicKeyRetrieval=true&serverTimezone=UTC
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver
  mybatis:
    mapper-locations: classpath:mapper/*.xml

Spring MapperScan自动扫描配置
一般在启动类上新增 MapperScan 注解即可

@MapperScan("com.pjh.apigf.mapper")

本案例使用 mybatis-spring-boot-starter 自动装配依赖，因此 mybatis 会自动读取spring.datasource 下面的数据源配置信息；并会自动扫描 @mapper 注解的类加入Ioc容器中进行管理。

注意：如果使用 spring + mybatis 依赖，则需要在 mybatis-config.xml 中指定数据源信息，mapperScan 目录等，否则会报错。

2. 基本使用

使用时需要创建对应的实体类，对应的 mapper.java 持久层；

2.1 Mapper映射实现

要求 Mapper.xml 与Mapper.java 在相同目录结构下：
在这里插入图片描述
在 Mapper.java 中创建需要的数据操作方法

User getUserById(@Param("userId") String userId) ;

相同的 Mapper.xml 中需要有对应的方法
在这里插入图片描述
常用的标签：

select: 用于查询操作，从数据库中检索数据。
id: 唯一标识符，用于匹配接口方法。
resultType: 查询结果的Java类型，可以是具体类名或别名。
resultMap: 当查询结果需要复杂的映射关系时使用，引用之前定义的<resultMap>。
parameterType: 传入参数的类型，通常是Java Bean类型或基本类型。

insert: 用于插入操作，向数据库插入数据。
id, parameterType, useGeneratedKeys, keyProperty: 类似于<select>，其中useGeneratedKeys和keyProperty用于处理自动生成的主键。

update: 用于更新操作，更新数据库中的数据。
id, parameterType: 同上。

delete: 用于删除操作，从数据库中删除数据。
id, parameterType: 同上。

动态SQL标签:
<if>: 根据条件判断是否包含某段SQL。
<choose>, <when>, <otherwise>: 类似于Java的switch-case语句。
<where>: 动态生成WHERE子句，自动处理第一个条件前的AND或OR。
<set>: 用于动态生成UPDATE语句的SET子句。
<foreach>: 遍历集合，常用于IN语句中。

sql: 定义可重用的SQL片段，提高代码复用性。
id: 片段的唯一标识。

resultMap: 复杂结果集的映射，定义列名到JavaBean属性的映射关系。
id: resultMap的唯一标识。
type: 映射的目标Java类型。
<id>和<result>: 分别定义主键映射和普通属性映射

2.2 注解方式实现

@Select用于标记查询语句。该注解可以在接口方法上使用，也可以在XML文件中使用。使用@Select注解时，需要在注解中指定SQL语句
@Insert用于标记插入语句。该注解可以在接口方法上使用，也可以在XML文件中使用。使用@Insert注解时，需要在注解中指定SQL语句。
@Update用于标记更新语句。该注解可以在接口方法上使用，也可以在XML文件中使用。使用@Update注解时，需要在注解中指定SQL语句。
@Delete用于标记删除语句。该注解可以在接口方法上使用，也可以在XML文件中使用。使用@Delete注解时，需要在注解中指定SQL语句。
@Results用于标记结果集映射，该注解可以用于接口方法或XML文件中，通常与@Select注解一起使用。使用@Results注解时，需要指定Result映射规则。

@Select("SELECT * FROM users WHERE id = #{id}")
@Results(id = "userResultMap", value = {
	@Result(property = "id", column = "id"),
	@Result(property = "name", column = "name"),
	@Result(property = "age", column = "age")
})
User getUserById(@Param("id") Long id);

@Result用于标记单个属性与结果集中的列之间的映射关系。该注解可以用于接口方法或XML文件中，通常与@Results注解一起使用。使用@Result注解时，需要指定映射规则。
@ResultMap用于标记结果集映射规则。该注解可以用于接口方法或XML文件中，通常与@Select注解一起使用。使用@ResultMap注解时，需要指定映射规则。

@Select("SELECT * FROM users WHERE id = #{id}")
@ResultMap("userResultMap")
User getUserById(@Param("id") Long id);

@Options用于指定一些可选的配置项。该注解可以用于接口方法或XML文件中，通常与@Insert、@Update、@Delete等注解一起使用。使用@Options注解时，可以指定一些可选的配置项。
useGeneratedKeys ：自增主键并返回，keyProperty 实体对应的元素

@Insert("INSERT INTO users(name, age) VALUES(#{name}, #{age})")
@Options(useGeneratedKeys = true, keyProperty = "id")
int insertUser(User user);

@SelectKey用于在执行INSERT语句后获取自动生成的主键值。该注解可以用于接口方法或XML文件中，通常与@Insert注解一起使用。使用@SelectKey注解时，需要指定生成主键的SQL语句和将主键值赋给Java对象的哪个属性。

@Insert("INSERT INTO users(name, age) VALUES(#{name}, #{age})")
@SelectKey(statement = "SELECT LAST_INSERT_ID()", keyProperty = "id", before = false, resultType = Long.class)
int insertUser(User user);

@Param用于为SQL语句中的参数指定参数名称。该注解可以用于接口方法或XML文件中，通常与@Select、@Insert、@Update、@Delete等注解一起使用。使用@Param注解时，需要指定参数名称。

@Select("SELECT * FROM users WHERE name = #{name} AND age = #{age}")
List<User> getUsersByNameAndAge(@Param("name") String name, @Param("age") Integer age);

@One用于在一对一关联查询中指定查询结果的映射方式。该注解可以用于XML文件中，通常与和标签一起使用。使用@One注解时，需要指定查询结果映射的Java对象类型和查询结果映射的属性。

<resultMap id="userResultMap" type="User">
	<id column="id" property="id"/>
	<result column="name" property="name"/>
	<result column="age" property="age"/>
	<association property="department" resultMap="departmentResultMap"/>
</resultMap>

<resultMap id="departmentResultMap" type="Department">
	<id column="id" property="id"/>
	<result column="name" property="name"/>
	<result column="description" property="description"/>
	<one property="manager" resultMap="userResultMap"/>
</resultMap>

上述代码中，@One注解用于指定查询结果的映射方式，这里使用了嵌套的标签实现了一对一关联查询。在departmentResultMap中，使用@One注解指定了查询结果映射的Java对象类型为User，查询结果映射的属性为manager，resultMap参数指定了查询结果映射的结果集映射规则为userResultMap。

@Many用于在一对多关联查询中指定查询结果的映射方式。该注解可以用于XML文件中，通常与和标签一起使用。使用@Many注解时，需要指定查询结果映射的Java对象类型和查询结果映射的属性。

<resultMap id="departmentResultMap" type="Department">
<id column="id" property="id"/>
<result column="name" property="name"/>
<result column="description" property="description"/>
<collection property="members" ofType="User" resultMap="userResultMap"/>
</resultMap>

<resultMap id="userResultMap" type="User">
	<id column="id" property="id"/>
	<result column="name" property="name"/>
	<result column="age" property="age"/>
</resultMap>

@ResultType用于指定查询结果的类型。该注解可以用于接口方法或XML文件中，通常与@Select、@Insert、@Update、@Delete等注解一起使用。使用@ResultType注解时，需要指定查询结果的类型。

@Select("SELECT name, age FROM users WHERE id = #{id}")
@ResultType(User.class)
User getUserById(Long id);

@TypeDiscriminator用于在自动映射时指定不同子类型的映射方式。该注解可以用于XML文件中，通常与和标签一起使用。使用@TypeDiscriminator注解时，需要指定类型列的名称和不同子类型的映射方式。

<resultMap id="vehicleResultMap" type="Vehicle">
<id column="id" property="id"/>
<result column="name" property="name"/>
<result column="type" property="type"/>
	<discriminator javaType="String" column="type">
		<case value="car" resultMap="carResultMap"/>
		<case value="truck" resultMap="truckResultMap"/>
		<case value="bus" resultMap="busResultMap"/>
	</discriminator>
</resultMap>
<resultMap id="carResultMap" type="Car">
	<result column="engine" property="engine"/>
	<result column="seats" property="seats"/>
</resultMap>
<resultMap id="truckResultMap" type="Truck">
	<result column="load" property="load"/>
</resultMap>
<resultMap id="busResultMap" type="Bus">
	<result column="capacity" property="capacity"/>
</resultMap>

上述代码中，@TypeDiscriminator注解用于指定不同子类型的映射方式。在vehicleResultMap中，使用@TypeDiscriminator注解指定了类型列的名称为type，javaType参数指定了类型列的Java类型为String，标签中的value属性分别对应不同的子类型（car、truck、bus），resultMap属性用于指定不同子类型的结果集映射规则。

MyBatisPlus

CRUD 操作：MyBatisPlus 提供了丰富的 CRUD 方法（如 insert, update, delete, select），开发者无需编写 SQL 语句，仅通过方法名即可实现基本的数据库操作。而在 MyBatis 中，你需要为每一个 CRUD 操作编写 SQL 语句。
条件构造器：MBP 提供了强大的条件构造器，可以灵活构建复杂的 WHERE 条件，这相比 MyBatis 手动拼接 SQL 更加方便且安全。
分页支持：MBP 内置了分页插件，只需简单配置即可实现物理分页，而 MyBatis 需要手动编写分页逻辑或者集成第三方分页插件。
性能优化：比如自动填充（如创建时间、更新时间）、乐观锁等功能，MBP 提供了开箱即用的解决方案，减少了开发者在这些常规需求上的重复工作。
注解驱动：MBP 强化了注解的使用，很多功能可以通过简单的注解配置实现，降低了 XML 配置文件的依赖，使得项目结构更加清晰。

踩坑

分清 spring 依赖，和 boot 自动装配依赖。使用原生的 mybatis 依赖需要配置mybatis-config.xml 配置文件，大致如下，关键内容为 dataSource、SqlSessionFactoryBean、MapperScannerConfigurer；而使用 boot 自动装配依赖时会将以上配置和bean进行自动装配。

<?xml version="1.0" encoding="UTF-8" ?>

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd"
>

    <context:component-scan base-package="com.pjh.apigf.mapper"></context:component-scan>

    <!-- 加载jdbc.properties配置文件 -->
    <context:property-placeholder location="classpath:jdbc.properties"/>

    <!-- 配置 MyBatis 数据源 -->
    <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
        <property name="driverClassName" value="${database.driver}" />
        <property name="url" value="${database.url}" />
        <property name="username" value="${database.username}" />
        <property name="password" value="${database.password}" />
    </bean>

    <!-- 配置 mybatis Session -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource" />
        <!--<property name="configLocation" value="classpath:mybatis-config.xml"></property>-->
        <property name="mapperLocations" value="classpath:com/pjh/apigf/mapper/*.xml" />
    </bean>

    <!-- 扫描Mapper接口（Spring会使用AOP为其实现具体方法） -->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <property name="basePackage" value="top.yiqifu.study.p061_mybatis" />
    </bean>


</beans>

mybatis-spring-boot-starter 和普通的 mybatis 依赖有以下几个主要区别：

集成便利性：
mybatis-spring-boot-starter 是专为 Spring Boot 应用设计的 Starter，它提供了自动配置的功能，使得在 Spring Boot 应用中集成 MyBatis 变得更加简便。你只需要在 pom.xml 中添加这个 Starter 依赖，无需手动编写大量的配置代码，Spring Boot 会自动配置好 MyBatis 的关键组件，比如 SqlSessionFactory 和 SqlSessionTemplate。
普通的 mybatis 依赖则是 MyBatis 的核心库，不包含任何 Spring 特定的集成代码。在非 Spring Boot 项目或者传统的 Spring 项目中使用时，你需要手动配置数据源、SqlSessionFactory、事务管理器等组件，并且可能需要额外的 mybatis-spring 依赖来桥接 MyBatis 和 Spring。

自动配置：
mybatis-spring-boot-starter 内部集成了自动配置逻辑，可以根据应用的环境和配置文件（如 application.properties 或 application.yml）自动设置 MyBatis 的配置项，比如映射文件的位置、类型别名、数据源等。
使用普通的 mybatis 依赖时，这些配置都需要手动在 Spring 配置类中完成。

依赖管理：
mybatis-spring-boot-starter 作为 Spring Boot 的 Starter，它内部已经管理了必要的依赖关系，例如它会自动引入 mybatis, mybatis-spring 以及可能的其他相关依赖，确保版本兼容性。这减少了 Maven 或 Gradle 依赖冲突的可能性。
使用普通 mybatis 依赖时，你需要自己管理所有相关依赖及其版本兼容性。

约定优于配置：
Spring Boot 的理念是“约定优于配置”，mybatis-spring-boot-starter 遵循这一原则，很多配置都有默认值，开发者只需关注需要改变的部分。而传统方式使用 MyBatis 则需要显式地配置每一部分。

综上所述，mybatis-spring-boot-starter 提供了一种快速、简化的方式来在 Spring Boot 应用中集成 MyBatis，减少了手动配置的工作量，并且通过自动配置和依赖管理提高了开发效率。而普通的 MyBatis 依赖则提供了更多的灵活性，但需要开发者自行处理更多的配置细节。