SpringBoot系列——MyBatis-Plus整合封裝

qch發表於2020-08-25

　　前言

　　MyBatis-Plus是一款MyBatis的增強工具（簡稱MP），為簡化開發、提高效率，但我們並沒有直接使用MP的CRUD介面，而是在原來的基礎上封裝一層通用程式碼，單表繼承我們的通用程式碼，實現了單表的基礎get、save（插入/更新）、list、page、delete介面，使用Vo去接收、傳輸資料，實體負責與資料庫表對映。

　　這樣做的目的是與我們之前的那套jpa保持編碼風格上的一致，當我們的通用介面不能滿足要求時，應當先考慮使用MP的Service層CRUD介面，然後是Mapper的介面，最後才是自定義查詢，本文將記錄實現過程

　　MyBatis-Plus官網：https://baomidou.com/

　　建立專案

　　在我們的工程裡新建子工程springboot-mybatis-plus，pom繼承父工程，引入Mybatis-Plus相關jar包

        <!--新增MyBatis-Plus依賴 -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.0</version>
        </dependency>

        <!--新增程式碼生成器依賴 -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.4.0</version>
        </dependency>
        <!-- 模板引擎 -->
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.0</version>
        </dependency>

　　啟動類中配置mapper掃描路徑

@SpringBootApplication
@MapperScan("cn.huanzi.qch.springbootmybatisplus.*.mapper")
public class SpringbootMybatisPlusApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootMybatisPlusApplication.class, args);
    }

}

　　建立MybatisPlusConfig配置類

/**
 * MybatisPlusConfig配置類
 */
@Configuration
@ConditionalOnClass(value = {PaginationInterceptor.class})
public class MybatisPlusConfig {

    /**
     * 分頁外掛相關
     */
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
        return paginationInterceptor;
    }

    /**
     * 主鍵策略相關
     */
    @Bean
    public IKeyGenerator keyGenerator() {
        return new H2KeyGenerator();
    }
}

　　配置檔案配置資料庫連線，與專案資訊

server.port=10102
spring.application.name=springboot-mybatis-plus

#修改thymeleaf訪問根路徑
spring.thymeleaf.prefix=classpath:/view/

　　yml

spring:
    datasource: #資料庫相關
      url: jdbc:mysql://localhost:3306/test?serverTimezone=GMT%2B8&characterEncoding=utf-8
      username: root
      password: 123456
      driver-class-name: com.mysql.cj.jdbc.Driver
    mvc:
      date-format: yyyy-MM-dd HH:mm:ss #mvc接收引數時對日期進行格式化

    jackson:
      date-format: yyyy-MM-dd HH:mm:ss #jackson對響應回去的日期引數進行格式化
      time-zone: GMT+8

　　到這裡專案簡單搭建完成

　　通用程式碼

　　接下來就是通用程式碼的編寫，我們參考之前jpa的程式碼，結合Mybatis-Plus的Mapper介面進行封裝通用get、save（插入/更新）、list、page、delete介面

　　程式碼佈局與jpa的風格一致

　　介面也一樣

　　程式碼生成器

　　MP原生的並不適合我們，我們要新建自定義模板，編寫程式碼生成器

　　執行程式碼生成器即可生成後端程式碼，程式碼風格與我們之前的jpa高度一致，同樣是封裝一套通用CRUD、page分頁介面，單表繼承實現快速開發

　　介面效果演示

　　get介面：http://localhost:10102/tbUser/get/2

list介面：http://localhost:10102/tbUser/list、http://localhost:10102/tbUser/list?id=2

page介面分頁、排序：http://localhost:10102/tbUser/page?page=1&rows=3&sidx=id&sord=desc

save有id，更新：http://localhost:10102/tbUser/save?id=2&username=huanzixxxx

save無id，新增：http://localhost:10102/tbUser/save?username=huanziyyy&password=000000&created=2020-08-16%2019:56:04

　　delete刪除：http://localhost:10102/tbUser/delete/14

　　後記

　　至此，我們便擁有了兩個編碼風格高度統一的ORM框架的自定義封裝，都有一套基礎通用的程式碼、程式碼自動生成工具，我們的開發效率大大提高，不管後續專案需要用到那個ORM框架，我們都有了技術儲備，實現快速開發！MyBatis相關可看回我們之前的系列部落格：SpringBoot系列——MyBatis整合

　　MP：SpringBoot系列——MyBatis-Plus整合封裝

　　JPA：SpringBoot系列——Spring-Data-JPA（究極進化版）自動生成單表基礎增、刪、改、查介面