5.1 MyBatis 3.5+ 版本新特性

5.1 MyBatis 3.5+ 版本新特性

MyBatis 3.5+ 版本新特性详解

5.1.1 延迟加载的改进

延迟加载（Lazy Loading）是 MyBatis 中一个重要的特性，允许我们在需要时才加载关联对象，从而提高查询效率。在 MyBatis 3.5+ 版本中，延迟加载机制得到了进一步的改进，主要体现在以下几个方面：

• 更细粒度的控制： 可以通过配置来更精确地控制哪些关联对象需要延迟加载，哪些需要立即加载。

• 更好的性能： 优化了延迟加载的实现，减少了不必要的数据库查询。

• 更清晰的异常处理： 改进了延迟加载过程中出现异常时的处理方式，使错误信息更易于理解和调试。

代码示例：

假设我们有一个 Order 类和一个 Customer 类，一个订单属于一个客户。

public class Order {
    private Long id;
    private String orderNumber;
    private Customer customer; // 关联客户
    // Getters and setters
}
public class Customer {
    private Long id;
    private String name;
    // Getters and setters
}
​

在 MyBatis 的 Mapper XML 文件中，我们可以配置延迟加载：

<resultMap id="orderResultMap" type="Order">
    <id property="id" column="order_id"/>
    <result property="orderNumber" column="order_number"/>
    <association property="customer" column="customer_id" javaType="Customer"
                 select="com.example.CustomerMapper.getCustomerById"
                 fetchType="lazy"/>
</resultMap>
<select id="getOrderById" parameterType="Long" resultMap="orderResultMap">
    SELECT order_id, order_number, customer_id FROM orders WHERE order_id = #{id}
</select>
​

在这个例子中，fetchType="lazy" 指定了 customer 属性的延迟加载。只有在访问 order.getCustomer() 时，才会执行 com.example.CustomerMapper.getCustomerById 查询来加载客户信息。

详解：

• fetchType="lazy"： 告诉 MyBatis 只有在真正需要访问 customer 属性时，才执行关联的查询。

• select="com.example.CustomerMapper.getCustomerById"：指定了用于加载 Customer 对象的 Mapper 方法。

• column="customer_id"：指定了用于传递给 getCustomerById 方法的参数，也就是客户的 ID。

5.1.2 @Param 注解增强

@Param 注解用于在 Mapper 接口中为参数命名，使得在 XML 文件中可以通过名称引用参数。在 MyBatis 3.5+ 版本中，@Param 注解的功能得到了增强，可以更灵活地处理参数传递。

• 支持多个参数的组合： 可以使用 @Param 注解将多个参数组合成一个 Map 对象，方便在 XML 文件中进行引用。

• 支持复杂类型的参数： 可以直接使用 @Param 注解传递复杂类型的参数，例如 List 或 Map。

代码示例：

public interface UserMapper {
    List<User> findUsersByCriteria(@Param("name") String name, @Param("age") Integer age);
    List<User> findUsersByMap(@Param("params") Map<String, Object> params);
}
​

对应的 XML 文件：

<select id="findUsersByCriteria" resultType="User">
    SELECT * FROM users
    WHERE name LIKE #{name} AND age = #{age}
</select>
<select id="findUsersByMap" resultType="User">
    SELECT * FROM users
    WHERE name LIKE #{params.name} AND age = #{params.age}
</select>
​

详解：

• findUsersByCriteria 方法使用了 @Param 注解为 name 和 age 参数命名，可以在 XML 文件中直接使用 #{name} 和 #{age} 引用它们。

• findUsersByMap 方法使用了 @Param 注解将整个 Map 对象命名为 params，可以在 XML 文件中使用 #{params.name} 和 #{params.age} 引用 Map 中的属性。

5.1.3 增强的 TypeHandler

TypeHandler 是 MyBatis 中用于处理 Java 类型和 JDBC 类型之间转换的组件。在 MyBatis 3.5+ 版本中，TypeHandler 的功能得到了增强，可以更方便地处理自定义类型。

• 支持泛型 TypeHandler： 可以创建泛型的 TypeHandler，使其可以处理多种类型的转换。

• 自动注册 TypeHandler： MyBatis 可以自动注册 classpath 下的 TypeHandler，无需手动配置。

代码示例：

假设我们需要将 Java 中的 EnumType 枚举类型转换为数据库中的字符串类型。

public enum EnumType {
    VALUE1,
    VALUE2,
    VALUE3
}
@MappedTypes(EnumType.class)
@MappedJdbcTypes(JdbcType.VARCHAR)
public class EnumTypeHandler extends BaseTypeHandler<EnumType> {
    @Override
    public void setNonNullParameter(PreparedStatement ps, int i, EnumType parameter, JdbcType jdbcType) throws SQLException {
        ps.setString(i, parameter.name());
    }
    @Override
    public EnumType getNullableResult(ResultSet rs, String columnName) throws SQLException {
        String value = rs.getString(columnName);
        return value == null ? null : EnumType.valueOf(value);
    }
    @Override
    public EnumType getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
        String value = rs.getString(columnIndex);
        return value == null ? null : EnumType.valueOf(value);
    }
    @Override
    public EnumType getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
        String value = cs.getString(columnIndex);
        return value == null ? null : EnumType.valueOf(value);
    }
}
​

在 MyBatis 的配置文件中，可以注册这个 TypeHandler：

<typeHandlers>
    <typeHandler handler="com.example.EnumTypeHandler"/>
</typeHandlers>
​

详解：

• @MappedTypes(EnumType.class)：指定了该 TypeHandler 处理的 Java 类型为 EnumType。

• @MappedJdbcTypes(JdbcType.VARCHAR)：指定了该 TypeHandler 处理的 JDBC 类型为 VARCHAR。

• setNonNullParameter 方法：用于将 Java 对象转换为 JDBC 类型。

• getNullableResult 方法：用于将 JDBC 类型转换为 Java 对象。

5.1.4 ResultMap 的改进

ResultMap 是 MyBatis 中用于定义查询结果和 Java 对象之间映射关系的组件。在 MyBatis 3.5+ 版本中，ResultMap 的功能得到了改进，使其更加灵活和强大。

• 支持构造器注入： 可以使用构造器注入来初始化 Java 对象，而不仅仅是 setter 方法。

• 支持自动映射： MyBatis 可以自动将查询结果中的列名映射到 Java 对象的属性上，无需手动配置。

代码示例：

public class User {
    private Long id;
    private String name;
    private Integer age;
    public User(Long id, String name, Integer age) {
        this.id = id;
        this.name = name;
        this.age = age;
    }
    // Getters
}
​

对应的 XML 文件：

<resultMap id="userResultMap" type="User">
    <constructor>
        <arg column="id" javaType="Long"/>
        <arg column="name" javaType="String"/>
        <arg column="age" javaType="Integer"/>
    </constructor>
</resultMap>
<select id="getUserById" parameterType="Long" resultMap="userResultMap">
    SELECT id, name, age FROM users WHERE id = #{id}
</select>
​

详解：

• <constructor> 标签：用于指定使用构造器注入来初始化 User 对象。

• <arg> 标签：用于指定构造器的参数，column 属性指定了查询结果中的列名，javaType 属性指定了参数的 Java 类型。

5.1.5 MyBatis-Scripting 模块的增强

MyBatis-Scripting 模块允许使用各种脚本语言（例如 OGNL、JRuby、Groovy）来动态生成 SQL 语句。在 MyBatis 3.5+ 版本中，MyBatis-Scripting 模块得到了增强，支持更多的脚本语言和更灵活的脚本配置。

• 支持 Kotlin 脚本： 可以使用 Kotlin 脚本来动态生成 SQL 语句。

• 更灵活的脚本配置： 可以自定义脚本引擎和脚本变量。

代码示例：

假设我们使用 Groovy 脚本来动态生成 SQL 语句：

<select id="findUsersByCondition" parameterType="Map" resultType="User">
    <scriptEngine lang="Groovy">
        SELECT * FROM users
        <where>
            <if test="name != null">
                name LIKE #{name}
            </if>
            <if test="age != null">
                AND age = #{age}
            </if>
        </where>
    </scriptEngine>
</select>
​

详解：

• <scriptEngine lang="Groovy">：指定使用 Groovy 脚本引擎。

• <if test="name != null">：Groovy 脚本中的条件判断语句。

5.1.6 日志增强

MyBatis 3.5+ 版本对日志记录进行了增强，提供了更详细和可配置的日志输出。

• 支持更多的日志框架： 除了 SLF4J 和 Log4j，还支持其他的日志框架，例如 Logback。

• 更详细的日志信息： 可以配置 MyBatis 输出更详细的日志信息，例如 SQL 语句、参数值和执行时间。

配置示例：

在 MyBatis 的配置文件中，可以配置日志框架和日志级别：

<settings>
    <setting name="logImpl" value="LOG4J2"/>
</settings>
​

详解：

• logImpl 属性：指定了使用的日志框架，可选的值包括 SLF4J, LOG4J, LOG4J2, JDK_LOGGING, COMMONS_LOGGING, STDOUT_LOGGING, NO_LOGGING。

5.1.7 其他改进

除了上述几个关键特性之外，MyBatis 3.5+ 版本还包含了一些其他的改进，例如：

• 性能优化： 优化了 MyBatis 的内部实现，提高了查询效率。

• Bug 修复： 修复了之前版本中存在的一些 Bug。

• API 改进： 改进了 MyBatis 的 API，使其更加易于使用。

总结

MyBatis 3.5+ 版本引入了许多令人兴奋的新特性，包括延迟加载的改进、@Param 注解增强、增强的 TypeHandler、ResultMap 的改进、MyBatis-Scripting 模块的增强和日志增强等等。这些特性提升了开发效率、性能以及框架的灵活性，使得 MyBatis 更加强大和易于使用。通过本文的详细解释和代码示例，相信读者能够更好地理解和应用这些新特性，从而在实际项目中发挥 MyBatis 的优势。

Mermaid 图示例 (延迟加载)

Mermaid 图示例 (TypeHandler)

希望这篇文章能够帮助你更好地了解 MyBatis 3.5+ 版本的新特性。 实际应用中，选择使用哪些特性取决于项目的具体需求和场景。 持续关注 MyBatis 的官方文档和社区，可以及时了解最新的发展动态和最佳实践。