Mapper 编写方式

一、基于 XML 的 Mapper

基于 XML 的 Mapper 是 MyBatis 最传统和经典的方式之一。在这种方式中，SQL 语句和映射关系定义在 XML 文件中，而 Java 接口仅用于调用这些定义好的 SQL 语句。

1.1 XML Mapper 文件示例

首先，编写一个 Java 接口：

public interface UserMapper {
    
    
    User selectUserById(int id);
}

然后，在 XML 文件中定义 SQL 语句和映射关系：

<mapper namespace="com.example.mapper.UserMapper">
    <select id="selectUserById" parameterType="int" resultType="User">
        SELECT * FROM users WHERE id = #{id}
    </select>
</mapper>

1.2 优点

灵活性高：由于 SQL 语句直接定义在 XML 文件中，开发者可以完全控制 SQL 的编写，包括动态 SQL 的使用。
SQL 与 Java 代码分离：将 SQL 语句与 Java 代码分离，使得代码更具可读性和可维护性。SQL 的修改不需要修改 Java 代码，减少了代码耦合。
易于维护：对于大型项目，SQL 语句的集中管理使得维护更加方便，特别是在数据库结构变化时。

1.3 缺点

额外的 XML 配置：需要编写和维护 XML 文件，增加了一定的复杂度。
缺少编译期检查：由于 SQL 在 XML 中定义，SQL 语句的错误（如语法错误或字段名错误）只有在运行时才能发现。

二、基于注解的 Mapper

MyBatis 支持使用注解直接在 Java 接口中定义 SQL 语句，这种方式不需要额外的 XML 配置文件，是一种更为简洁的方式。

2.1 注解 Mapper 示例

public interface UserMapper {
    
    
    @Select("SELECT * FROM users WHERE id = #{id}")
    User selectUserById(int id);

    @Insert("INSERT INTO users(name, age) VALUES(#{name}, #{age})")
    void insertUser(User user);
}

常见的注解包括：

@Select：用于定义查询语句。
@Insert：用于定义插入语句。
@Update：用于定义更新语句。
@Delete：用于定义删除语句。

2.2 优点

简洁性：不需要单独的 XML 文件，所有 SQL 语句直接在接口中定义，减少了文件数量。
便于快速开发：适合小型项目或简单的 CRUD 操作，能快速实现数据库操作。
编译期检查：由于 SQL 语句直接写在 Java 代码中，编译器可以在一定程度上帮助检查一些简单的错误（如拼写错误等）。

2.3 缺点

灵活性不足：注解方式不适合复杂 SQL，特别是涉及动态 SQL 的场景，无法像 XML 那样灵活地构建 SQL。
可维护性差：对于大型项目，随着业务逻辑的复杂化，注解方式的代码可能变得难以维护，特别是当 SQL 语句较长或复杂时，代码的可读性会降低。
SQL 与代码耦合：SQL 语句与 Java 代码耦合在一起，增加了代码的耦合度，修改 SQL 语句时需要同时修改 Java 代码。

三、混合使用 XML 和注解的 Mapper

MyBatis 也支持在同一个项目中同时使用 XML 和注解的方式。开发者可以选择在简单的场景下使用注解，而在复杂的场景下使用 XML 文件定义 SQL 语句。

3.1 混合使用示例

在简单的查询中使用注解：

public interface UserMapper {
    
    
    @Select("SELECT * FROM users WHERE id = #{id}")
    User selectUserById(int id);
}

对于复杂的查询，使用 XML 文件：

<mapper namespace="com.example.mapper.UserMapper">
    <select id="selectUsersByNameAndAge" resultType="User">
        SELECT * FROM users WHERE name = #{name}
        <if test="age != null">
            AND age = #{age}
        </if>
    </select>
</mapper>

3.2 优点

灵活性与简洁性的平衡：混合使用 XML 和注解能够在灵活性与简洁性之间取得平衡，开发者可以根据具体需求选择合适的方式。
更好的可维护性：将复杂的 SQL 语句分离到 XML 文件中，可以提高代码的可读性和可维护性，而简单的操作可以直接使用注解。

3.3 缺点

需要维护多种文件：混合使用时，可能需要维护多个文件和不同的配置，增加了一定的复杂度。
项目统一性差：对于团队合作项目，不同开发者可能倾向于使用不同的方式，导致项目风格不一致。

四、使用接口动态代理

MyBatis 还支持通过 Java 的动态代理机制来实现 Mapper 接口。在这种方式下，Mapper 接口可以不直接绑定到 XML 或注解，而是通过动态代理生成具体的实现。这种方式一般与 XML 配置结合使用。

4.1 动态代理示例

public interface UserMapper {
    
    
    User selectUserById(int id);
}

对应的 XML 文件：

<mapper namespace="com.example.mapper.UserMapper">
    <select id="selectUserById" parameterType="int" resultType="User">
        SELECT * FROM users WHERE id = #{id}
    </select>
</mapper>

MyBatis 在运行时会为 UserMapper 接口生成一个动态代理对象，并在调用 selectUserById 方法时，自动映射到 XML 文件中的对应 SQL 语句。

4.2 优点

自动化程度高：通过动态代理机制，MyBatis 能够自动将接口方法与 SQL 语句绑定，减少手动编码的工作量。
灵活配置：动态代理机制与 XML 配置结合，能够灵活定义 SQL 语句，并且方便进行动态 SQL 的编写。

4.3 缺点

运行时错误：由于动态代理在运行时生成，如果 XML 文件中 SQL 语句的 ID 与接口方法名不匹配，错误会在运行时而不是编译时暴露出来。
理解门槛较高：对于不熟悉 Java 动态代理机制的开发者，可能需要花费时间理解 MyBatis 的运行机制。

五、使用 Kotlin DSL 编写 Mapper

对于使用 Kotlin 语言的开发者，MyBatis 提供了一种基于 Kotlin DSL（领域特定语言）的方式编写 Mapper，这种方式结合了 Kotlin 的语言特性，使得 SQL 语句的编写更加直观和灵活。

5.1 Kotlin DSL 示例

fun UserMapper.selectUserById(id: Int): User? =
    select {
    
    
        from("users")
        where {
    
    
            "id" eq id
        }
    }.single()

5.2 优点

Kotlin 特性：利用 Kotlin 的类型推断、空安全等特性，使得代码更加简洁和安全。
更少的模板代码：Kotlin DSL 方式可以减少模板代码的编写，提高代码的可读性。

5.3 缺点

语言限制：仅适用于 Kotlin 项目，Java 项目无法使用这种方式。
学习成本：对于不熟悉 Kotlin 的开发者来说，需要一定的学习成本。

六、总结

MyBatis 提供了多种编写 Mapper 的方式，包括基于 XML 的传统方式、基于注解的简化方式、混合使用、接口动态代理以及 Kotlin DSL。这些方式各有优缺点，适用于不同的开发场景：

XML 方式：灵活性高，适合复杂 SQL 和大项目，但需要维护额外的 XML 文件。
注解方式：简洁易用，适合简单的 CRUD 操作和小型项目，但灵活性不足。
混合使用：平衡了灵活性和简洁性，适合中大型项目的复杂场景。
动态代理：自动化程度高，与 XML 配置结合使用，减少手动编码。
Kotlin DSL：适用于 Kotlin 项目，代码简洁且安全，但仅限于 Kotlin 语言。