1. 背景
本节将在 mybatis 中 注解方式的基本用法。
2.知识
除了 XML文件描述映射的方式,还有另一种方法来完成语句映射。 SQL语句可以不用 XML 来配置,而可以使用 Java 注解来配置。比如:
package org.mybatis.example;
public interface BlogMapper {
@Select("SELECT * FROM blog WHERE id = #{id}")
Blog selectBlog(int id);
}
- 使用注解来映射简单语句会使代码显得更加简洁
- 稍微复杂一点的语句,注解就不适用了,会让SQL 语句更加混乱不堪
- 选择何种方式来配置映射都是可以的,你可以很轻松的在基于注解和 XML 的语句映射方式间自由移植和切换
3. 示例
使用注解的增删改查的示例:
@Insert({"INSERT INTO sys_user(user_name,user_password,user_email,user_info) values(#{userName},#{userPassword},#{userEmail},#{userInfo})"})
int insert(SysUser user);
// 返回非自增主键
@Insert({"INSERT INTO sys_user(user_name,user_password,user_email,user_info) values(#{userName},#{userPassword},#{userEmail},#{userInfo})"})
@Options(useGeneratedKeys = true, keyProperty = "id")
int insert2(SysUser user);
@Update({"UPDATE sys_user SET user_name= #{userName}, user_password= #{userPassword}, user_email=#{userEmail}, user_info= #{userInfo} WHERE id=#{id}"})
int updateUser(SysUser user);
@Delete({"DELETE FROM sys_user WHERE id=#{id}"})
int deleteById(int id);
@Select({"select id, user_name, user_password, user_email, user_info from sys_user"})
List<SysUser> selectAll();
@Select({"select id, user_name, user_password, user_email, user_info from sys_user WHERE id=#{id}"})
SysUser selectByPrimaryKey(int id);
4. Provider 注解
MyBatis 还提供了 4 种 Provider 注解,分别 是 @SelectProvider 、@ InsertProvider 、@ Update Provider 和@ DeleteProvider 。 它 们同样可以实现查询、插入、更新、删除操作。
5. 扩展
注解的方式也是可以使用 if 等动态SQL 标签的。要在带注解的映射器接口类中使用动态 SQL,可以使用 script 元素。比如:
@Update({"<script>",
"update Author",
" <set>",
" <if test='username != null'>username=#{username},</if>",
" <if test='password != null'>password=#{password},</if>",
" <if test='email != null'>email=#{email},</if>",
" <if test='bio != null'>bio=#{bio}</if>",
" </set>",
"where id=#{id}",
"</script>"})
void updateAuthorValues(Author author);
更多 动态SQL标签,请阅读:https://mybatis.org/mybatis-3/zh/dynamic-sql.html
我的代码示例见:https://github.com/vir56k/java_demo/tree/master/mybatisdemo4_annotation
END
网友评论