SpringBoot整合MyBatis

事情是这样的，JPA这玩意是用起来简单但是用了一年多不会写SQL了。遂打算在新项目里偷偷用一下MyBatis，直到发现我们的平台框架不允许这么玩。将查到的东西记录下来，下次用时可以参考。

依赖

使用的第一步就是找依赖。 MyBatis官方提供了集成SpringBoot的starter；使用MyBatis时为了减少分页带来不便，也会用到pagehelper；数据库中用到了datetime类型，为了使用java8的新日期和时间类，再引入一个typehandler相关的包。如下：

        <!-- mybatis starter -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.0.1</version>
        </dependency>
        <!-- page helper -->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper</artifactId>
            <version>5.1.11</version>
        </dependency>
        <!-- type handler -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-typehandlers-jsr310</artifactId>
            <version>1.0.2</version>
        </dependency>

版本上，由于某些原因只能使用springboot2.0.x，因此starter的版本是2.0.1。另外两个依赖的版本则选用了最新的。

用法

引入了依赖之后就可以啪啪啪写代码了。

先来一套民工三连：新建entity、dao、service、controller、config几个包。 SpringBoot广泛使用之后，非常流行注解式写法。所以就不再resources目录下写mapper了，先在启动类加注解@MapperScan("xx.xx.dao")，或者在dao层的每个map上写@Mapper。

写sql

接着在dao包里写XxxMapper接口，普通sql可以使用@Select``@Insert``@Update``@Delete等注解，详细描述查看官方文档。动态sql使用@InsertProvider``@UpdateProvider``@DeleteProvider``@SelectProvider注解：

// type写类名，method写方法名
@SelectProvider(type = ParkingDynamicSqlProvider.class, method = "findAllSql")

例如：

public class ParkingDynamicSqlProvider  {

    public String findAllSql(final Integer projectId, final String name, final Integer parent, final String sort) {
        return new SQL() {{
            SELECT("p.id, p.name, p.total_space_num, p.fixed_space_num, p.temporary_space_num, p.reserved_space_num, p.parent, p.project_id");
            FROM("pm_parking p");
            WHERE("project_id = #{projectId}");
            if (name != null) {
                WHERE("p.name = #{name}");
            }
            if (parent != null) {
                WHERE("p.parent = #{parent}");
            }
            ORDER_BY(sort);
        }}.toString();
    }
}

结果的映射使用@Results注解，将数据库里的列名与entity变量名对应起来。

    @Results({
            @Result(property = "totalSpaceNum", column = "total_space_num")
    })

分页

由于某些原因我这边接口限制分页时前端请求使用start（起始主键id）、limit（行数），响应时后端返回total（查询总数）和结果列表。因此分页插件我只关注了RowBounds(PageRowBounds)，其它分页方式都是页码+limit。

dao层分页查询方法的sql按照不分页的方式写，只需要在方法参数里带上PageRowBounds，然后service层调用的时候传入PageRowBounds实例（设置offset、limit、count=true），就可以使用分页功能了。

PageHelper 官方使用文档

类型处理

加了typehandler依赖之后，mysql的datetime可以直接对应java8的LocalDateTime，在entity里直接写就可以了private LocalDateTime createDatetime;。