第四篇：spring boot和通用Mapper与分页插件的集成

电玩女神 2021-12-10 11:31 137阅读 0赞

转载地址：[https://blog.battcn.com/2018/05/10/springboot/v2-orm-mybatis-plugin/][https_blog.battcn.com_2018_05_10_springboot_v2-orm-mybatis-plugin]

分页插件：能根据当前页面、页面显示行数等参数来显示页面

通用Mapper：**`通用 Mapper` 是一个可以实现任意 `MyBatis` 通用方法的框架**，项目提供了常规的增删改查操作以及 `Example` 相关的单表操作

**1.  导入依赖**

在** `pom.xml`** 中添加通用Mapper与分页插件的依赖包

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMxOTQyNQ_size_16_color_FFFFFF_t_70][]

2.  属性配置

在 `application.properties` 文件中分别添加上**`数据库`、`Mybatis`、`通用Mapper`、`PageHelper`**的属性配置，这里只提供了常见场景的配置

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMxOTQyNQ_size_16_color_FFFFFF_t_70 1][]

通用Mapper

*  **mapper.enum-as-simple-type：** 枚举按简单类型处理，如果有枚举字段则需要加上该配置才会做映射
 *  **mapper.not-empty：** 设置以后，会去判断 insert 和 update 中符串类型!=’’

分页插件

*  **pagehelper.reasonable：** 分页合理化参数，默认值为false。当该参数设置为 true 时，pageNum<=0 时会查询第一页， pageNum>pages（超过总数时），会查询最后一页。默认false 时，直接根据参数进行查询。
 *  **support-methods-arguments：** 支持通过 Mapper 接口参数来传递分页参数，默认值false，分页插件会从查询方法的参数值中，自动根据上面 params 配置的字段中取值，查找到合适的值时就会自动分页。

注意事项

由于 **`mybatis.mapper-locations=classpath:com/battcn/mapper/*.xml`**配置的在`java package`中，而`Spring Boot`默认只打入`java package -> *.java`，所以我们需要给`pom.xml`文件添加如下内容

<build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
            </resource>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </resources>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

分页功能使用：可以传入当前页、页行数参数，利用PageHelper插件设置就行

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMxOTQyNQ_size_16_color_FFFFFF_t_70 2][]

**通用mapper的使用**

实体类

`通用Mapper`采用了JPA规范包中的注解，这种的设计避免了重复造轮子，更是让`Spring Data Jpa`的应用可以轻松切换到`Mybatis`

`当然你也可以不用采用这些注解`

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMxOTQyNQ_size_16_color_FFFFFF_t_70 3][]

### 持久层 ###

UserMapper

继承 `BaseMapper<T>` 就可以了，这点是不是有点类似 `JpaRepository`，同时也可以根据自己需要扩展出更适合自己项目的`BaseMapper`，它的灵活也是众多开发者喜爱的因素之一

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMxOTQyNQ_size_16_color_FFFFFF_t_70 4][]

`UserMapper` 映射文件

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMxOTQyNQ_size_16_color_FFFFFF_t_70 5][]

当然这里我们只定义了一个查询方法，其实继承`BaseMapper<T>接口时，这里面有很多增、删、查、改方法给我们使用`

只需要去查看这个接口的方法就行，这样子就整合完成，我们就可以在测试那里调用mapper的方法了

[https_blog.battcn.com_2018_05_10_springboot_v2-orm-mybatis-plugin]: https://blog.battcn.com/2018/05/10/springboot/v2-orm-mybatis-plugin/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMxOTQyNQ_size_16_color_FFFFFF_t_70]: /images/20211210/d9157a81c3384541aadf4cdcc98ccc3c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMxOTQyNQ_size_16_color_FFFFFF_t_70 1]: /images/20211210/3387dff5c11d45e3aed02de6d086f19b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMxOTQyNQ_size_16_color_FFFFFF_t_70 2]: /images/20211210/ba66f0a24fcc44fbaa168a0ac3b11568.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMxOTQyNQ_size_16_color_FFFFFF_t_70 3]: /images/20211210/3263b3fb320f4ba6a524ea61769587d8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMxOTQyNQ_size_16_color_FFFFFF_t_70 4]: /images/20211210/61104ddc0635459d918e877d2003a3b0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zODMxOTQyNQ_size_16_color_FFFFFF_t_70 5]: /images/20211210/e7396a5d996f4419a52250ec44043499.png