MyBatis 注解开发是使用注解方式替代 XML 配置文件的一种方式。与 XML 配置方式相比,注解开发更加灵活、简洁,适合小型项目或者数据库操作比较简单的场景。
一、 MyBatis 注解开发的主要步骤:
1.在 Mapper 接口上添加 @Mapper 注解,声明该接口为 Mapper 接口;
2.在 Mapper 接口的方法上添加注解,声明该方法对应的 SQL 语句以及参数和返回值类型等信息。
例如,如果我们想要查询一个用户的信息,可以使用如下的注解:
@Mapper
public interface UserMapper {
@Select("SELECT * FROM user WHERE id = #{id}")
User getUserById(@Param("id") int id);
}
在上述代码中,我们首先通过 @Mapper 注解声明了 UserMapper 接口为 Mapper 接口;然后,在 getUserById() 方法上使用了 @Select 注解,指定了该方法对应的 SQL 语句;其中,#{id} 表示该 SQL 语句中的占位符,需要动态替换为方法参数中的 id 参数值。
此外,我们还可以通过 @Param 注解来指定方法参数与 SQL 语句中的参数名之间的映射关系。例如,在上述代码中,我们使用 @Param("id") 注解将方法参数中的 id 参数映射到 SQL 语句中的 #{id} 占位符。
二、MyBatis 注解开发中常用的几种类型:
1、@Select:@Select 注解用于声明一个查询语句。
@Select("SELECT * FROM user WHERE id = #{id}")
User getUserById(@Param("id") int id);
在上述代码中,使用 @Select 注解声明了一个查询语句,查询的 SQL 语句为 SELECT * FROM user WHERE id = #{id},其中,#{id} 表示该 SQL 语句中的占位符,需要动态替换为方法参数中的 id 参数值。
2、@Insert:@Insert 注解用于声明一个插入语句。
@Insert("INSERT INTO user(id, name, age) VALUES(#{id}, #{name}, #{age})")
int addUser(User user);
在上述代码中,使用 @Insert 注解声明了一个插入语句,插入的 SQL 语句为 INSERT INTO user(id, name, age) VALUES(#{id}, #{name}, #{age}),其中,#{id}、#{name}、#{age} 等都表示该 SQL 语句中的占位符,需要动态替换为 User 对象中对应的属性值。
3、@Update:@Update 注解用于声明一个更新语句。
@Update("UPDATE user SET name = #{name}, age = #{age} WHERE id = #{id}")
int updateUser(User user);
在上述代码中,使用 @Update 注解声明了一个更新语句,更新的 SQL 语句为 UPDATE user SET name = #{name}, age = #{age} WHERE id = #{id},其中,#{id}、#{name}、#{age} 等都表示该 SQL 语句中的占位符,需要动态替换为 User 对象中对应的属性值。
4、@Delete:@Delete 注解用于声明一个删除语句。
@Delete("DELETE FROM user WHERE id = #{id}")
int deleteUser(@Param("id") int id);
在上述代码中,使用 @Delete 注解声明了一个删除语句,删除的 SQL 语句为 DELETE FROM user WHERE id = #{id},其中,#{id} 表示该 SQL 语句中的占位符,需要动态替换为方法参数中的 id 参数值。
5、@Results:@Results 注解用于配置结果映射。
@Results(id = "userResultMap", value = {
@Result(column = "id", property = "id", id = true),
@Result(column = "name", property = "name"),
@Result(column = "age", property = "age")
})
User getUserById(int id);
在上述代码中,使用 @Results 注解声明了一个结果映射配置,其中,@Result 注解用于指定数据库表中字段名与实体类中属性名之间的映射关系。
6、@ResultMap:@ResultMap 注解用于引用之前配置的结果映射。
@ResultMap("userResultMap")
User getUserById(int id);
在上述代码中,使用 @ResultMap 注解引用了之前定义的 userResultMap 结果映射。
三、在使用注解开发时,需要注意以下几点:
-
注解方式只适合于简单的 SQL 操作,对于复杂的 SQL 操作还是建议使用 XML 配置方式;
-
注解方式不支持动态 SQL,例如 if、where、foreach 等语句无法使用注解方式实现;
-
注解方式可以与 XML 配置方式混用,也就是说,可以同时使用注解和 XML 配置文件来完成数据库操作。