【項目實戰】從零到一搭建Spring Boot整合Mybatis-plus

前言

2023年想搭建一套屬於自己的框架，做一個屬於自己想法的項目。這些年工作中一直用公司已有的框架，以前有跟著學習視頻搭建過，但自己真正動手搭建時發現問題還是很多，比如沒有引入Mybatis-plus包之前，項目api test是成功的，引入Mybatis-plus包後就一直啟動不成功，而且異常信息也不拋出，後引入actuator應用健康監測才拋異常信息排查解決。我會下麵文中說明為什麼引入這個pom作用是什麼，pom引入的每個包都有其作用，而不是照搬別人的框架過來，引入不必要的包。

看該文章前需要瞭解maven pom結構，idea創建一個項目的步驟，spring boot知識，往下閱讀預設都具備了。

環境說明：idea2022.3 ，jdk17 ，maven 3.6.3，mysql-8.0.31

一、創建一個maven空項目

項目創建步驟不截圖了，預設大家懂了。創建一個空maven項目目的是作為父級引入公用的一些，一般企業級的項目都是這樣的結構，當然如果想簡單一點，該步驟也是可以省略掉的。

創建出來把一些不要的包，文件都刪除掉，目錄結構如下圖

1、確定spring boot版本號

因為我後面是要實現微服務框架項目，所以在選擇Spring Boot版本號是與Spring Cloud是對應的。（最開始我是選擇Spring Boot最新版本號3.0.0，但發現在整合Mybatis-Plus 3.5.2出現很多問題，主要是spring boot 3.0自動註入方式改變，原因說明可參考博客：Spring Boot3.0升級，踩坑之旅，附解決方案 ：https://www.cnblogs.com/wayn111/p/16950025.html）

訪問spring官網https://spring.io，選擇projects下 Spring Cloud 右側Learn ，目前最新版本是2022.0.0GA(上面已有說明不選擇最新版)，往下找第一個GA版本2021.0.5。

2 、pom整理

關鍵Spring Boot pom定義如下，完整pom定義詳見示例源碼。

方便後面Api定義的聲明，增加引入Swagger

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.6.13</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

<properties>  
    <!-- Spring Cloud -->
    <spring.cloud.version>2021.0.5</spring.cloud.version>
    <!-- Spring Boot -->
    <spring.boot.version>2.6.13</spring.boot.version>   
    <!-- Swagger -->
    <knife4j.spring.boot.version>2.0.8</knife4j.spring.boot.version>
</properties>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>${spring.boot.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>${spring.cloud.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
        
        <!--Swagger-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-micro-spring-boot-starter</artifactId>
            <version>${knife4j.spring.boot.version}</version>
        </dependency>

    </dependencies>
</dependencyManagement>

二、添加子模塊demo-service

1、Spring Boot Api Test

關鍵pom引入，就可以進行api test，完整pom定義詳見示例源碼。

添加spring-boot-starter-web是web應用需要的包，Controller等相關，spring-boot-starter-actuator 是Spring Boot應用健康監測，如果應用有異常可以捕獲到，供我們排查。

<dependencies>        
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!--actuator-應用健康監測 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
    
    <!--Swagger-->
    <dependency>
        <groupId>com.github.xiaoymin</groupId>
        <artifactId>knife4j-micro-spring-boot-starter</artifactId>
    </dependency>

</dependencies>

代碼層面自己手動加package: com.elephant.demo , 創建啟動類DemoApplication，代碼如下：

package com.elephant.demo;

import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @author xiufen.huang
 * @description:
 * @date 2023-01-08-18:38
 */
@Slf4j
@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
        log.info("========================= elephant-demo-啟動成功 ==========================");
    }

}

點擊試運行，從控制台的日誌來看已成功。埠暫時沒有設置預設8080。

添加application.yml，設置埠8071

添加測試Controller類：TestController，代碼如下：

package com.elephant.demo.controller;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author xiufen.huang
 * @description:
 * @date 2023-01-08-18:47
 */
@Api(value = "TestController", tags = "測試Controller")
@Slf4j
@RestController
@RequestMapping("/test")
@RequiredArgsConstructor
public class TestController {

    @ApiOperation(value = "測試介面")
    @GetMapping("/index")
    public String test() {
        return "ok";
    }

}

api test訪問 http://127.0.0.1:8071/test/index ，響應成功ok，

2、整合Mybatis-plus

2.1、正常的pom引入說明

資料庫採用mysql，mybatis-plus選擇版本號3.5.2 ，只需要引入兩個包即可。

<properties>  
    <mybatis.plus.version>3.5.2</mybatis.plus.version>
    <mysql.connector.version>8.0.31</mysql.connector.version> 
</properties>

<!--Mybatis-plus-start-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>${mybatis.plus.version}</version>
</dependency>
<!--Mybatis-plus-end-->

<!-- MySql -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>${mysql.connector.version}</version>
</dependency>

2.2、正常的yaml配置

mybatis-plus配置，mapper.xml，實體掃描，列印sql

#mybatis-plus配置
mybatis-plus:
  mapper-locations: classpath:com/elephant/demo/**/mapper/*Mapper.xml
  #實體掃描，多個package用逗號或者分號分隔
  type-aliases-package: com.elephant.demo.**.entity
  configuration:
    # 駝峰轉換 從資料庫列名到Java屬性駝峰命名的類似映射
    map-underscore-to-camel-case: true
    # 列印sql
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

資料庫連接配置

spring:
  application:
    # 應用名稱
    name: elephant-demo
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    # 換成自己的配置
    url: jdbc:mysql://127.0.0.1:3306/test
    username: root
    password: 123456

2.3、測試的建表腳本和數據

我的測試表是訂單表，僅針對功能測試使用，不一定按我的，我把建表腳本提供和初始化腳本提供出來。方便如果下載我的demo代碼可以初始化後，修改下配置即可運行。在resources/ sql下。

# 創建表語句
CREATE TABLE `ft_order` (
  `id` varchar(32) NOT NULL COMMENT '主鍵',
  `create_user` varchar(32) DEFAULT NULL COMMENT '創建人',
  `create_time` datetime DEFAULT NULL COMMENT '創建時間',
  `update_user` varchar(32) DEFAULT NULL COMMENT '更新人',
  `update_time` datetime DEFAULT NULL COMMENT '更新時間',
  `status` int DEFAULT NULL COMMENT '業務狀態: 0-正常, 1-已刪除',
  `is_deleted` bit(1) DEFAULT b'0' COMMENT '是否刪除',
  `order_no` varchar(50) DEFAULT NULL COMMENT '訂單編號',
  `customer_name` varchar(100) DEFAULT NULL COMMENT '客戶名稱',
  `customer_email` varchar(100) DEFAULT NULL COMMENT '客戶郵箱',
  `product_status` int DEFAULT NULL COMMENT '貨品狀態: 1-備車中,2-出口手續辦理中,3-轉移待出口（手續辦理完成）,4-報關完成,5-車輛達到指定港口,6-運輸中,7-已抵達,8-確認收貨',
  `remark` varchar(256) DEFAULT NULL COMMENT '備註',
  PRIMARY KEY (`id`),
  KEY `idx_customer_name` (`customer_name`) USING BTREE,
  KEY `idx_order_no_email_name` (`order_no`,`customer_email`,`customer_name`) USING BTREE COMMENT 'PC後臺查詢組合索引',
  KEY `idx_customer_email_name` (`customer_email`,`customer_name`) USING BTREE
)COMMENT='外貿訂單信息';

測試初始化數據

INSERT INTO `ft_order`(`id`, `create_user`, `create_time`, `update_user`, `update_time`, `status`, `is_deleted`, `order_no`, `customer_name`, `customer_email`, `product_status`, `remark`) VALUES ('1001', NULL, '2023-01-03 15:18:46', NULL, '2023-01-03 15:18:49', 0, b'0', 'TEST20230103001', 'Jack', '[email protected]', NULL, NULL);
INSERT INTO `ft_order`(`id`, `create_user`, `create_time`, `update_user`, `update_time`, `status`, `is_deleted`, `order_no`, `customer_name`, `customer_email`, `product_status`, `remark`) VALUES ('1002', NULL, '2023-01-04 16:18:49', NULL, '2023-01-04 16:18:49', 0, b'0', 'TEST20230104001', 'Jack', '[email protected]', NULL, NULL);
INSERT INTO `ft_order`(`id`, `create_user`, `create_time`, `update_user`, `update_time`, `status`, `is_deleted`, `order_no`, `customer_name`, `customer_email`, `product_status`, `remark`) VALUES ('1003', NULL, '2023-01-04 17:18:49', NULL, '2023-01-04 17:18:49', 0, b'0', 'TEST20230104002', 'Jack', '[email protected]', NULL, NULL);
INSERT INTO `ft_order`(`id`, `create_user`, `create_time`, `update_user`, `update_time`, `status`, `is_deleted`, `order_no`, `customer_name`, `customer_email`, `product_status`, `remark`) VALUES ('1004', NULL, '2023-01-04 18:18:49', NULL, '2023-01-04 18:18:49', 0, b'0', 'TEST20230104003', 'Jack', '[email protected]', NULL, NULL);
INSERT INTO `ft_order`(`id`, `create_user`, `create_time`, `update_user`, `update_time`, `status`, `is_deleted`, `order_no`, `customer_name`, `customer_email`, `product_status`, `remark`) VALUES ('1005', NULL, '2023-01-04 19:18:49', NULL, '2023-01-04 19:18:49', 0, b'0', 'TEST20230104004', 'Jack', '[email protected]', NULL, NULL);

2.4、動態數據源的pom引入說明

如果想採用動態數據源，再引入這個pom包

<properties>  
    <mybatis.plus.dynamic.version>3.5.2</mybatis.plus.dynamic.version>
</properties>

<!-- 動態數據源-start -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
    <version>${mybatis.plus.dynamic.version}</version>
</dependency>
<!-- 動態數據源-end -->

2.5、動態數據源的yaml配置

# 動態數據源
# pom 引入 dynamic-datasource-spring-boot-starter
spring:
  application:
    # 應用名稱
    name: elephant-demo
  datasource:
    dynamic:
      primary: master #設置預設的數據源或者數據源組,預設值即為master
      strict: false #嚴格匹配數據源,預設false. true未匹配到指定數據源時拋異常,false使用預設數據源
      datasource:
        master:
          driver-class-name: com.mysql.cj.jdbc.Driver
          url: jdbc:mysql://127.0.0.1:3306/test
          username: root
          password: 123456
        slave:
          driver-class-name: com.mysql.cj.jdbc.Driver
          url: jdbc:mysql://127.0.0.1:3306/test
          username: root
          password: 123456

3、示例代碼說明

由於代碼比較多不一一貼出來，主要代碼貼出來做說明。代碼結構做一下說明，是採用4層結構，多了一層業務實現層是為了避免後面業務複雜了，出現迴圈依賴的情況。具體是用3層還是4層可以按需。

本次示例給出3個：根據主鍵查詢，分頁列表查詢，保存訂單數據。

3.1.Dao層代碼

介面繼承IService ，實現類繼承 ServiceImpl<OrderMapper, Order>。IOrderRepository 代碼如下:

/**
 * @author xiufen.huang
 * @description:
 * @date 2022-12-21-15:38
 */
public interface IOrderRepository extends IService<Order> {
    
        /**
     * 獲取訂單信息
     * @param orderId 訂單id
     * @return com.elephant.demo.model.entity.Order
     * @author xiufen.huang
     * @date 2023-01-19 11:01
     */
    Order getById(String orderId);

    /**
     * 訂單分頁列表
     * @param param 查詢參數
     * @return com.baomidou.mybatisplus.core.metadata.IPage<com.elephant.demo.model.vo.OrderPageVo>
     * @author xiufen.huang
     * @date 2023-01-19 11:01
     */
    IPage<OrderPageVo> getOrderPage(OrderPageParam param);

    /**
     * 保存訂單數據
     * @param param
     * @return java.lang.Boolean
     * @author xiufen.huang
     * @date 2022-12-16 15:50
     */
    Boolean saveOrder(OrderCreateParam param);

}    

OrderRepositoryImpl 代碼如下:

@Slf4j
@Service
public class OrderRepositoryImpl extends ServiceImpl<OrderMapper, Order>  implements IOrderRepository {
    // 後面分開講解
}

3.2.單個查詢

比如根據主鍵查詢，可以用Mybatis提供封裝好的方法selectById() 。具體代碼實現如下

@Override
public Order getById(String orderId) {
    Order order = this.baseMapper.selectById(orderId);
    return order;
}

Service，Controller的代碼只需要調用一下即可，實際業務場景再根據需要做一些處理。

3.3.訂單分頁列表

實現思路：構造分頁參數，具體查詢實現在Mapper.xml用原生的sql結合動態參數。比如我的場景：根據關鍵詞(訂單號/客戶名稱/客戶郵箱)查詢訂單數據。

OrderMapper 代碼如下

public interface OrderMapper extends BaseMapper<Order> {
    IPage<OrderPageVo> getOrderPage(Page page, @Param("param") OrderPageParam param);
}

OrderMapper .xml代碼如下

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.elephant.demo.repository.mapper.OrderMapper">

    <select id="getOrderPage" resultType="com.elephant.demo.model.vo.OrderPageVo">
        select fto.id,
        fto.create_time,
        fto.update_time,
        fto.`status`,
        fto.order_no,
        fto.customer_name,
        fto.customer_email,
        fto.product_status
        from ft_order fto
        where fto.is_deleted=0
        <if test="param.searchWord != null and param.searchWord !=''">
            and (
            fto.order_no like concat('%',#{param.searchWord},'%')
            or fto.customer_email like concat('%',#{param.searchWord},'%')
            or fto.customer_name like concat('%',#{param.searchWord},'%')
            )
        </if>
        order by fto.create_time desc
    </select>

</mapper>

OrderRepositoryImpl的代碼實現就比較簡單了，調整下即可，代碼如下

@Override
public IPage<OrderPageVo> getOrderPage(OrderPageParam param) {
    Page page = new Page(param.getPage().getCurrent(), param.getPage().getSize());
    return baseMapper.getOrderPage(page, param);
}

3.4.保存訂單數據

實現思路：把提交參數做業務校驗後，把對應的欄位賦給實體類，然後調用this.save(T entity)方法進行保存，id會自動賦值。OrderRepositoryImpl的代碼實現如下：

@Override
public Boolean saveOrder(OrderCreateParam param) {
    // 參數賦值
    Order order = new Order();
    order.setOrderNo(param.getOrderNo());
    order.setCustomerName(param.getCustomerName());
    order.setCustomerEmail(param.getCustomerEmail());
    order.setCreateTime(new Date());
    order.setUpdateTime(new Date());
    // 訂單創建時，預設是0-正常
    order.setStatus(0);
    // 持久化數據
    return this.save(order);
}

4.添加日誌列印

實現說明：在src/main/resources下添加日誌配置logback-spring.xml，然後application.yml添加配置。

logback-spring.xml各項說明可以閱讀博客：https://blog.csdn.net/weixin_43790613/article/details/109428318

4.1.logback-spring.xml配置

<?xml version="1.0" encoding="UTF-8"?>
<configuration  scan="true" scanPeriod="60 seconds" debug="true">
    <!--
     參考博客：https://blog.csdn.net/weixin_43790613/article/details/109428318
     1. scan：程式運行時配置文件被修改，是否重新載入。true=重新載入；false=不重新載入；預設為true;
     2. scanPeriod：監測配置文件被修改的時間間隔，scan屬性必須設置為true才可生效；預設為1分鐘，預設單位是毫秒；
     3. debug：是否列印logback程式運行的日誌信息。true=列印；false=不列印；預設為false;
    -->
    <contextName>logback</contextName>
    <!-- 路徑變數，當前項目所在目錄下 -->
    <property name="log.path" value="/log/demo/logback.log" />
    <!-- 日誌格式變數 -->
    <property name="logPattern" value="%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36}  %file:%line - %msg%n" />
    <!--
    1. %d{HH:mm:ss.SSS} 顯示的時間
    2. [%thread]列印線程號，log4j2使用%t]也可以
    3. %-5level日誌級別，並且使用5個字元靠左對齊
    4. %logger{36}——日誌輸出者的名字,即類的類名
    5. %file	列印類名，也可用%class，列印的全限定類名
    6. %line	列印日誌所在代碼行數
    7. %msg——日誌消息
    8. %n——平臺的換行符-->
    <!--輸出到控制台-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <!-- <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
             <level>ERROR</level>
         </filter>-->
        <encoder>
            <pattern>${logPattern}</pattern>
        </encoder>
    </appender>

    <!--輸出到文件-->
    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}</file>
        <!--輸出到文件路徑一種滾動策略：根據時間制定日誌文件的滾動策略，如：按天、按小時、按分鐘生成日誌文件 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 文件路徑,定義了日誌的切分方式——把每一天的日誌歸檔到一個文件中,以防止日誌填滿整個磁碟空間 -->
            <fileNamePattern>${log.path}/%d{yyyy-MM-dd}.log.gz</fileNamePattern>
            <!-- 日誌在磁碟上保留天數 -->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <!-- 另一種滾動策略:表示根據日誌文件大小，超過制定大小會觸發日誌滾動； -->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <maxFileSize>5MB</maxFileSize>
        </triggeringPolicy>
        <encoder>
            <pattern>${logPattern}</pattern>
            <!--
            <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                 <level>ERROR</level>
            </filter>
            ThresholdFilter為系統定義的攔截器，例如我們用ThresholdFilter來過濾掉ERROR級別以下的日誌不輸出到文件中。如果不用記得註釋掉，不然你控制台會發現沒日誌~
             -->
            <!-- 設置字元集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>
    <!-- 把日誌非同步輸出到磁碟文件中，避免每次都進行磁碟IO操作 -->
    <appender name="ASYNC" class="ch.qos.logback.classic.AsyncAppender">
        <discardingThreshold>0</discardingThreshold>
        <queueSize>10000</queueSize>
        <appender-ref ref="file" />
    </appender>

    <root level="info">
        <appender-ref ref="console" />
        <appender-ref ref="ASYNC" />
    </root>

</configuration>

4.2.application.yml添加配置

# 日誌配置
logging:
  config: classpath:logback-spring.xml

三、源碼地址

上面步驟說明還是不夠全面，如果是自己剛開始搭建，可能還是沒什麼頭緒。

因此我把demo分享出來。https://gitee.com/wuqixiufen2/elephant-demo