MyBatis（22）如何在 MyBatis 中使用注解而不是 XML 映射文件

在 MyBatis 中，使用注解而不是 XML 映射文件来进行 SQL 映射是一种更为简洁直观的方式，尤其适用于 SQL 语句较少的场景。通过注解，开发者可以直接在接口方法上声明 SQL 语句，这样可以减少项目中的配置文件数量，使得项目结构更加清晰。下面，我们将详细介绍如何在 MyBatis 中使用注解。

基本配置

首先，你需要有一个 MyBatis 的基本配置环境。假设你已经配置好了 MyBatis 的环境，并且已经集成到 Spring 或者是单独使用。

Mapper 接口

MyBatis 通过 Mapper 接口与 SQL 语句的映射关系来执行数据库操作。使用注解方式，你需要定义一个接口，然后在接口方法上使用 MyBatis 提供的注解来声明 SQL 语句。

package com.example.mapper;

import org.apache.ibatis.annotations.Select;
import com.example.entity.User;

public interface UserMapper {

    @Select("SELECT * FROM users WHERE id = #{id}")
    User getUserById(Integer id);
}

在上面的例子中，@Select 注解用于声明一个查询操作的 SQL 语句。MyBatis 在执行 getUserById 方法时，会将注解中的 SQL 语句发送到数据库执行。

支持的注解

MyBatis 提供了一系列的注解用于不同类型的数据库操作，包括但不限于：

• @Select：用于查询操作。
• @Insert：用于插入操作。
• @Update：用于更新操作。
• @Delete：用于删除操作。
• @Results：用于映射查询结果到 Java 对象。
• @Param：用于传递多个参数到 SQL 语句。

结果映射（ResultMap）

当 SQL 查询的结果列与 Java 对象的字段名不一致时，可以使用 @Results 和 @Result 注解来进行映射：

@Select("SELECT id, user_name AS userName FROM users WHERE id = #{id}")
@Results({
    @Result(column="id", property="id"),
    @Result(column="user_name", property="userName")
})
User getUserById(Integer id);

参数映射

当方法有多个参数时，可以使用 @Param 注解来命名这些参数，从而在 SQL 语句中使用这些命名的参数：

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

动态 SQL

对于复杂的动态 SQL，MyBatis 提供了 @SelectProvider, @InsertProvider, @UpdateProvider, @DeleteProvider 等注解，允许你指定一个类和方法来动态生成 SQL 语句：

@SelectProvider(type = UserSqlBuilder.class, method = "buildGetUserById")
User getUserById(Integer id);

class UserSqlBuilder {
    public static String buildGetUserById(final Integer id) {
        return new SQL() {{
            SELECT("*");
            FROM("users");
            WHERE("id = #{id}");
        }}.toString();
    }
}

源码解析

在 MyBatis 中，注解方式和 XML 方式最终都会被解析成相同的内部表示形式——MappedStatement 对象。例如，当 MyBatis 启动时，它会扫描所有的 Mapper 接口，解析这些接口中的注解信息，然后构建对应的 MappedStatement 对象并存储在 Configuration 对象中。在执行查询时，MyBatis 会根据方法名查找对应的 MappedStatement 对象，然后执行其中封装的 SQL 语句。

总结

通过注解方式使用 MyBatis，可以使得 SQL 语句更加紧密地与 Java 代码集成，减少了项目中的配置文件，使得项目结构更加简洁。不过，在处理复杂的 SQL 语句和动态 SQL 时，XML 映射文件的方式可能会更加灵活。因此，选择哪种方式取决于项目的具体需求和开发团队的偏好。