MyBatis注解

MyBatis 的注解（Annotations）提供了一种简洁的方式来配置 SQL 映射，而无需使用 XML 文件。通过在 Mapper 接口的方法上使用注解，可以直接在 Java 代码中定义 SQL 语句和相关映射。这种方式使得代码更加集中和易于维护，尤其适合简单的 CRUD 操作。

以下是 MyBatis 注解的详细介绍，包括常用注解的说明、使用示例以及与 XML 配置的对比。

1. 常用注解说明

1.1 `@Select`

用于定义查询操作。

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

1.2 `@Insert`

用于定义插入操作。

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

1.3 `@Update`

用于定义更新操作。

@Update("UPDATE users SET name=#{name}, email=#{email} WHERE id=#{id}")
void updateUser(User user);

1.4 `@Delete`

用于定义删除操作。

@Delete("DELETE FROM users WHERE id=#{id}")
void deleteUser(int id);

1.5 `@Results` 和 `@Result`

用于定义复杂的结果映射，尤其是当查询结果需要映射到多个表或多个对象时。

@Select("SELECT u.id, u.name, u.email, o.id as order_id, o.amount as order_amount " +"FROM users u LEFT JOIN orders o ON u.id = o.user_id WHERE u.id=#{id}")
@Results({@Result(property = "id", column = "id"),@Result(property = "name", column = "name"),@Result(property = "email", column = "email"),@Result(property = "orders", column = "id", many = @Many(select = "com.example.mapper.OrderMapper.findOrdersByUserId"))
})
User selectUserWithOrders(int id);

1.6 `@Param`

当方法的参数超过一个时，使用 @Param 注解为参数命名，以便在 SQL 语句中引用。

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

1.7 `@Options`

用于配置 SQL 执行的选项，如是否使用缓存、是否刷新缓存、返回主键等。

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

1.8 `@SelectProvider`, `@InsertProvider`, `@UpdateProvider`, `@DeleteProvider`

用于动态 SQL，允许将 SQL 语句的构建逻辑委托给一个单独的类。

public class UserSqlProvider {public String selectUserById(int id) {return "SELECT * FROM users WHERE id = " + id;}
}public interface UserMapper {@SelectProvider(type = UserSqlProvider.class, method = "selectUserById")User selectUserById(int id);
}

注意：使用 Provider 注解时，SQL 构建逻辑在外部类中，适用于复杂的动态 SQL 场景。

2. 使用示例

以下是一个完整的示例，展示如何在 MyBatis 中使用注解进行 CRUD 操作。

2.1 实体类

public class User {private Integer id;private String name;private String email;// 构造方法public User() {}public User(Integer id, String name, String email) {this.id = id;this.name = name;this.email = email;}// Getter 和 Setter 方法// ...
}

2.2 Mapper 接口

import org.apache.ibatis.annotations.*;import java.util.List;public interface UserMapper {@Select("SELECT * FROM users WHERE id = #{id}")User selectUserById(int id);@Select("SELECT * FROM users")List<User> selectAllUsers();@Insert("INSERT INTO users (name, email) VALUES (#{name}, #{email})")@Options(useGeneratedKeys = true, keyProperty = "id")void insertUser(User user);@Update("UPDATE users SET name=#{name}, email=#{email} WHERE id=#{id}")void updateUser(User user);@Delete("DELETE FROM users WHERE id=#{id}")void deleteUser(int id);
}

2.3 配置 MyBatis

确保在 MyBatis 的配置文件中正确扫描 Mapper 接口。

mybatis-config.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configurationPUBLIC "-//mybatis.org//DTD Config 3.0//EN""http://mybatis.org/dtd/mybatis-3-config.dtd"><configuration><environments default="development"><environment id="development"><transactionManager type="JDBC"/><dataSource type="POOLED"><property name="driver" value="com.mysql.cj.jdbc.Driver"/><property name="url" value="jdbc:mysql://localhost:3306/your_database?useSSL=false&serverTimezone=UTC"/><property name="username" value="your_username"/><property name="password" value="your_password"/></dataSource></environment></environments><mappers><mapper class="com.example.mapper.UserMapper"/></mappers>
</configuration>

2.4 使用 Mapper 接口

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;import java.util.List;public class MyBatisAnnotationExample {public static void main(String[] args) {SqlSessionFactory sqlSessionFactory = MyBatisUtil.getSqlSessionFactory(); // 获取 SqlSessionFactory 实例try (SqlSession session = sqlSessionFactory.openSession()) {UserMapper mapper = session.getMapper(UserMapper.class);// 插入用户User newUser = new User(null, "张三", "zhangsan@example.com");mapper.insertUser(newUser);session.commit();// 查询用户User user = mapper.selectUserById(newUser.getId());System.out.println(user);// 更新用户user.setName("李四");mapper.updateUser(user);session.commit();// 查询所有用户List<User> users = mapper.selectAllUsers();users.forEach(System.out::println);// 删除用户mapper.deleteUser(user.getId());session.commit();} catch (Exception e) {e.printStackTrace();}}
}

3. 注解与 XML 的对比

特性	注解	XML
可读性	代码即配置，易于阅读和维护	SQL 与 Java 代码分离，适合复杂 SQL
维护性	对于简单操作更易于维护	对于复杂 SQL 和动态 SQL 更灵活
动态 SQL 支持	有限，需使用 `Provider` 注解	强大，支持复杂的条件判断和循环
复用性	较低，难以复用 SQL 片段	高，可以通过 `<sql>` 标签复用 SQL 片段
性能	无显著差异	无显著差异

选择建议：
• 对于简单的 CRUD 操作，推荐使用注解，因其简洁明了。
• 对于复杂的 SQL 语句或需要动态构建 SQL 的场景，推荐使用 XML 配置。

4. 常见问题及解决方案

4.1 参数映射问题

问题：在使用多个参数时，MyBatis 无法正确识别参数名称。

解决方案：使用 @Param 注解为每个参数命名。

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

4.2 结果映射复杂

问题：当查询结果需要映射到嵌套对象或多个对象时，注解配置复杂。

解决方案：使用 @Results 和 @Result 注解，或者考虑使用 XML 进行更灵活的结果映射。

@Select("SELECT u.id, u.name, u.email, o.id as order_id, o.amount as order_amount " +"FROM users u LEFT JOIN orders o ON u.id = o.user_id WHERE u.id=#{id}")
@Results({@Result(property = "id", column = "id"),@Result(property = "name", column = "name"),@Result(property = "email", column = "email"),@Result(property = "orders", column = "id", many = @Many(select = "com.example.mapper.OrderMapper.findOrdersByUserId"))
})
User selectUserWithOrders(int id);

4.3 动态 SQL 支持不足

问题：注解对动态 SQL 的支持有限，难以处理复杂的条件逻辑。

解决方案：使用 @SelectProvider 等 Provider 注解，将 SQL 构建逻辑委托给外部类；或者使用 XML 配置以获得更强大的动态 SQL 支持。

public class UserSqlProvider {public String selectUserDynamic(@Param("name") String name, @Param("email") String email) {return new SQL() {{SELECT("*");FROM("users");if (name != null) {WHERE("name = #{name}");}if (email != null) {WHERE("email = #{email}");}}}.toString();}
}public interface UserMapper {@SelectProvider(type = UserSqlProvider.class, method = "selectUserDynamic")List<User> selectUsersDynamic(@Param("name") String name, @Param("email") String email);
}

5. 总结

MyBatis 的注解提供了一种简洁、直观的方式来定义 SQL 映射，适用于简单的 CRUD 操作。通过使用 @Select、@Insert、@Update、@Delete 等注解，可以直接在 Mapper 接口中编写 SQL 语句，减少 XML 配置文件的使用，使代码更加集中和易于维护。

然而，对于复杂的 SQL 语句或需要动态构建 SQL 的场景，XML 配置仍然具有优势。因此，在实际项目中，可以根据具体需求灵活选择使用注解或 XML，甚至在同一个项目中结合两者的优点。

如果你在使用过程中遇到具体问题或需要更详细的示例，请随时提问！