首页 Java知识正文

Spring Boot MyBatis 入门(二)之 MyBatis + 注解

admin Java知识 2019-11-09 78 0

摘要: 原创出处 http://www.iocoder.cn/Spring-Boot/MyBatis/ 「芋道源码」欢迎转载,保留摘要,谢谢!

  • 1. 概述

  • 2. MyBatis + XML

    • 2.1 引入依赖

    • 2.2 Application

    • 2.3 应用配置文件

    • 2.4 MyBatis 配置文件

    • 2.5 UserDO

    • 2.6 UserMapper

    • 2.7 简单测试

  • 3. MyBatis + 注解

    • 3.1 差异部分

    • 3.2 UserMapper

    • 3.3 简单测试

  • 4. MyBatis-Plus

    • 4.1 引入依赖

    • 4.2 Application

    • 4.3 应用配置文件

    • 4.4 UserDO

    • 4.5 UserMapper

    • 4.6 简单测试

  • 5. tkmybatis

    • 5.1 引入依赖

    • 5.2 Application

    • 5.3 应用配置文件

    • 5.4 MyBatis 配置文件

    • 5.5 UserDO

    • 5.6 UserMapper

    • 5.7 简单测试

  • 666. 彩蛋



3. MyBatis + 注解

大多数情况下,艿艿并不推荐使用注解的方式编写 SQL 。一方面,SQL 无法很好的排版。另一方面,会导致 Mapper 接口很长很乱。

并且,在 MyBatis 的官方文档中,对注解的评价如下:

FROM https://mybatis.org/mybatis-3/zh/java-api.html

因为最初设计时,MyBatis 是一个 XML 驱动的框架。配置信息是基于 XML 的,而且映射语句也是定义在 XML 中的。而到了 MyBatis 3,就有新选择了。MyBatis 3 构建在全面且强大的基于 Java 语言的配置 API 之上。这个配置 API 是基于 XML 的 MyBatis 配置的基础,也是新的基于注解配置的基础。注解提供了一种简单的方式来实现简单映射语句,而不会引入大量的开销。

不幸的是,Java 注解的的表达力和灵活性十分有限。尽管很多时间都花在调查、设计和试验上,最强大的 MyBatis 映射并不能用注解来构建——并不是在开玩笑,的确是这样。比方说,C#属性就没有这些限制,因此 MyBatis.NET 将会比 XML 有更丰富的选择。也就是说,基于 Java 注解的配置离不开它的特性。

  • 间接表述不是很推荐使用 MyBatis 注解的方式。

同时,在艿艿的工作经历之间,和询问一些好朋友,没有发现使用注解的情况。

因此,真的不推荐使用 MyBatis + 注解。哈哈哈哈,不过这个章节,我还是想写一写。

示例代码对应仓库:lab-12-mybatis-annotation 。

3.1 差异部分

考虑到胖友已经看过 「2. MyBatis + XML」 小节的内容,我们在这个小节主要说下差异的地方。

1、application.yaml

在 application.yaml 配置文件中,我们可以删除 mapper-locations 配置项。

当然,如果胖友想 XML 和注解一起使用,可以保留该配置项。

2、UserMapper.xml

可以删除 UserMapper.xml 配置文件。不过需要在 UserMapper 接口上,通过注解声明 SQL 操作。具体见 「3.2 UserMapper」 。

3.2 UserMapper

在 cn.iocoder.springboot.lab12.mybatis.mapper 包路径下,创建 UserMapper 接口。代码如下:

// UserMapper.java

@Repository
public interface UserMapper {

    @Insert("INSERT INTO users(username, password, create_time) VALUES(#{username}, #{password}, #{createTime})")
    @Options(useGeneratedKeys = true, keyProperty = "id", keyColumn = "id")
    int insert(UserDO user);

    @Update(value = {
            "<script>",
            "UPDATE users",
            "<set>",
            "<if test='username != null'>, username = #{username}</if>",
            "<if test='password != null'>, password = #{password}</if>",
            "</set>",
            "</script>"
    })
    int updateById(UserDO user);

    @Insert("DELETE FROM users WHERE id = #{id}")
    int deleteById(@Param("id") Integer id)// 生产请使用标记删除,除非有点想不开,嘿嘿。

    @Select("SELECT username, password, create_time FROM users WHERE id = #{id}")
    UserDO selectById(@Param("id") Integer id);

    @Select("SELECT username, password, create_time FROM users WHERE username = #{username}")
    UserDO selectByUsername(@Param("username") String username);

    @Select(value = {
            "<script>",
            "SELECT username, password, create_time FROM users",
            "WHERE id IN",
            "<foreach item='id' collection='ids' separator=',' open='(' close=')' index=''>",
            "#{id}",
            "</foreach>",
            "</script>"
    })
    List<UserDO> selectByIds(@Param("ids") Collection<Integer> ids);

}
  • 是不是发现整个 Mapper 接口看起来乱乱的,并且 SQL 的排版也不尽如人意。

  • 对于使用 OGNL 编写动态 SQL ,也特别难受。具体怎么用,胖友可以看看 《MyBatis 在注解上使用动态 SQL》 文章。反正艿艿不是想写第二遍了。

3.3 简单测试

具体的测试,还是使用 UserMapperTest 测试类,直接运行每个测试方法即可。



版权声明

本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。

评论