SpringBoot3- 整合 Mybatis-plus

2024年04月24日 17:43 · 阅读(653) ·

参考

SpringBoot 3.1.10 整合Mybatis-plus（快速学会）

开发环境

名称 版本
操作系统 Windows 11 X64
SpringBoot 3.2.4
Mybatis-plus 3.5.5
JDK 17

源码下载

sharding-jdbc-demo.zip

测试表

  1. CREATE TABLE `payment_wallet_detail` (
  2.    `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主键ID',
  3.    `pay_month` varchar(6) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '支付月份yyyyMM，分片键',
  4.    `tenant_id` bigint(20) DEFAULT NULL COMMENT '"tenantId',
  5.    `create_by` varchar(50) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '创建人',
  6.    `create_time` datetime DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  7.    `update_by` varchar(50) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT '修改人（数据库中最终取 update_by）',
  8.    `update_time` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间（数据库中最终取 update_time）',
  9.    `is_delete` tinyint(1) DEFAULT '0' COMMENT '是否删除（0、否，1、是） 默认是0',
  10.    PRIMARY KEY (`id`),
  11.    KEY `payment_wallet_detail_kv_id_IDX` (`kv_id`) USING BTREE
  12. ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci COMMENT='发放明细表';
  14. CREATE TABLE `payment_wallet_transaction` (
  15.    `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'id',
  16.    `pay_order_number` varchar(30) COLLATE utf8mb4_bin DEFAULT NULL COMMENT '外部订单号-对应明细表的明细唯一单号，分片键(hash-mod)',
  17.    `tenant_id` bigint(20) DEFAULT '1' COMMENT '租户id',
  18.    `create_by` varchar(100) COLLATE utf8mb4_bin DEFAULT NULL COMMENT '创建人',
  19.    `create_time` datetime DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  20.    `update_by` varchar(100) COLLATE utf8mb4_bin DEFAULT NULL COMMENT '修改人',
  21.    `update_time` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间',
  22.    `is_delete` tinyint(1) DEFAULT NULL COMMENT '是否删除（0：否，1：是）',
  23.    PRIMARY KEY (`id`) USING BTREE,
  24.    KEY `pay_order_number_IDX` (`pay_order_number`,`transaction_direction`) USING BTREE
  25. ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin ROW_FORMAT=DYNAMIC COMMENT='发放流水表';

创建空项目

项 值
名称 SpringBoot3-Study
位置 D:\Study-Java\2023

创建模块-sharding-jdbc-demo

项 值
名称 sharding-jdbc-demo
位置 D:\Study-Java\2023\SpringBoot3-Study
语言 Java
构建系统 Maven
JDK 版本：17
供应商：Eclipse Temurin(AdoptOpenJDK HotSpot)17.0.8
位置：C:\Users\Administrator.jdks\temurin-17.0.8
主 ID com.atguigu
工件 ID sharding-jdbc-demo

sharding-jdbc-demo

目录结构

  1. ├─sharding-jdbc-demo
  2. │  │  pom.xml
  3. │  │
  4. │  ├─src
  5. │  │  ├─main
  6. │  │  │  ├─java
  7. │  │  │  │  └─com
  8. │  │  │  │      └─sharding
  9. │  │  │  │          └─demo
  10. │  │  │  │              │  ShardingJdbcDemoApplication.java
  11. │  │  │  │              │
  12. │  │  │  │              ├─common
  13. │  │  │  │              │      Contents.java
  14. │  │  │  │              │      ResponseCode.java
  15. │  │  │  │              │
  16. │  │  │  │              ├─config
  17. │  │  │  │              │      MybatisPlusConfig.java
  18. │  │  │  │              │
  19. │  │  │  │              ├─controller
  20. │  │  │  │              │      TestController.java
  21. │  │  │  │              │
  22. │  │  │  │              ├─DTO
  23. │  │  │  │              │      BatchParam.java
  24. │  │  │  │              │
  25. │  │  │  │              ├─exception
  26. │  │  │  │              │      InternalApiException.java
  27. │  │  │  │              │
  28. │  │  │  │              ├─handler
  29. │  │  │  │              │      MyMetaObjectHandler.java
  30. │  │  │  │              │
  31. │  │  │  │              ├─mapper
  32. │  │  │  │              │      PaymentWalletDetailMapper.java
  33. │  │  │  │              │      PaymentWalletTransactionMapper.java
  34. │  │  │  │              │
  35. │  │  │  │              ├─model
  36. │  │  │  │              │      PaymentWalletDetail.java
  37. │  │  │  │              │      PaymentWalletTransaction.java
  38. │  │  │  │              │      SuperEntity.java
  39. │  │  │  │              │
  40. │  │  │  │              ├─service
  41. │  │  │  │              │  │  IPaymentWalletDetailService.java
  42. │  │  │  │              │  │  IPaymentWalletTransactionService.java
  43. │  │  │  │              │  │
  44. │  │  │  │              │  └─impl
  45. │  │  │  │              │          PaymentWalletDetailServiceImpl.java
  46. │  │  │  │              │          PaymentWalletTransactionServiceImpl.java
  47. │  │  │  │              │
  48. │  │  │  │              ├─sharingrule
  49. │  │  │  │              │      PayMonthAlgorithm.java
  50. │  │  │  │              │      WalletPayOrderNumberShardingRule.java
  51. │  │  │  │              │
  52. │  │  │  │              └─utils
  53. │  │  │  │                      AssertUtil.java
  54. │  │  │  │                      CommonUtil.java
  55. │  │  │  │                      DateUtils.java
  56. │  │  │  │
  57. │  │  │  └─resources
  58. │  │  │      │  application.yml
  59. │  │  │      │  sharding-dev.yml
  60. │  │  │      │
  61. │  │  │      ├─mapper
  62. │  │  │      │      PaymentWalletDetailMapper.xml
  63. │  │  │      │      PaymentWalletTransactionMapper.xml
  64. │  │  │      │
  65. │  │  │      └─META-INF
  66. │  │  │          └─services
  67. │  │  │                  org.apache.shardingsphere.sharding.spi.ShardingAlgorithm
  68. │

pom.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  5.     <parent>
  6.         <groupId>org.springframework.boot</groupId>
  7.         <artifactId>spring-boot-starter-parent</artifactId>
  8.          <version>3.2.4</version>
  9.         <relativePath/> <!-- lookup parent from repository -->
  10.     </parent>
  11.     <groupId>com.sharding.demo</groupId>
  12.     <artifactId>sharding-jdbc-demo</artifactId>
  13.     <version>0.0.1-SNAPSHOT</version>
  14.     <name>sharding-jdbc-demo</name>
  15.     <description>sharding-jdbc-demo</description>
  16.     <properties>
  17.         <java.version>17</java.version>
  18.     </properties>
  19.     <dependencies>
  20.         <dependency>
  21.             <groupId>org.springframework.boot</groupId>
  22.             <artifactId>spring-boot-starter-web</artifactId>
  23.         </dependency>
  24.         <!--引入 MybatisPlus 依赖-->
  25.         <dependency>
  26.             <groupId>com.baomidou</groupId>
  27.             <artifactId>mybatis-plus-spring-boot3-starter</artifactId>
  28.             <version>3.5.5</version>
  29.         </dependency>
  30.         <!--mysql-->
  31.         <dependency>
  32.             <groupId>mysql</groupId>
  33.             <artifactId>mysql-connector-java</artifactId>
  34.             <version>8.0.30</version>
  35.         </dependency>
  36.         <!--引入 durid 数据源-->
  37.         <dependency>
  38.             <groupId>com.alibaba</groupId>
  39.             <artifactId>druid-spring-boot-starter</artifactId>
  40.             <version>1.1.18</version>
  41.         </dependency>
  44.         <!--lombok-->
  45.         <dependency>
  46.             <groupId>org.projectlombok</groupId>
  47.             <artifactId>lombok</artifactId>
  48.         </dependency>
  49.         <!-- hutool-->
  50.         <dependency>
  51.             <groupId>cn.hutool</groupId>
  52.             <artifactId>hutool-all</artifactId>
  53.             <version>5.8.25</version>
  54.         </dependency>
  56.         <!-- springboot-->
  57.         <dependency>
  58.             <groupId>org.springframework.boot</groupId>
  59.             <artifactId>spring-boot-starter</artifactId>
  60.         </dependency>
  61.         <dependency>
  62.             <groupId>org.springframework.boot</groupId>
  63.             <artifactId>spring-boot-starter-freemarker</artifactId>
  64.         </dependency>
  65.     </dependencies>
  67.     <build>
  68.         <plugins>
  69.             <plugin>
  70.                 <groupId>org.springframework.boot</groupId>
  71.                 <artifactId>spring-boot-maven-plugin</artifactId>
  72.                 <configuration>
  73.                     <excludes>
  74.                         <exclude>
  75.                             <groupId>org.projectlombok</groupId>
  76.                             <artifactId>lombok</artifactId>
  77.                         </exclude>
  78.                     </excludes>
  79.                 </configuration>
  80.             </plugin>
  81.         </plugins>
  83.         <resources>
  84.             <resource>
  85.                 <directory>src/main/resources</directory>
  86.                 <includes>
  87.                     <include>**/*</include>
  88.                 </includes>
  89.                 <filtering>false</filtering>
  90.             </resource>
  91.         </resources>
  92.     </build>
  93. </project>

application.yml

  1. server:
  2.   port: 8088
  4. spring:
  5.   datasource:
  6.     type: com.alibaba.druid.pool.DruidDataSource
  7.     driver-class-name: com.mysql.cj.jdbc.Driver
  8.     url: jdbc:mysql://a.a.a.a:3306/testDB?serverTimezone=UTC&characterEncoding=utf-8&useSSL=false
  9.     username: username
  10.     password: password
  13. #mybatis
  14. mybatis-plus:
  15.   mapper-locations: classpath:/mapper/*Mapper.xml
  16.   #实体扫描,多个package用逗号或者分号分隔
  17.   typeAliasesPackage:
  18.   typeEnumsPackage:
  19.   global-config:
  20.     #主键类型  0:"数据库ID自增", 1:"用户输入ID",2:"全局唯一ID (数字类型唯一ID)", 3:"全局唯一ID UUID";
  21.     id-type: 0
  22.     #字段策略 0:"忽略判断",1:"非 NULL 判断"),2:"非空判断"
  23.     field-strategy: 2
  24.     #驼峰下划线转换
  25.     db-column-underline: true
  26.     #刷新mapper 调试神器
  27.     refresh-mapper: true
  28.     #数据库大写下划线转换
  29.     #capital-mode: true
  30.     #序列接口实现类配置
  31.     #key-generator:
  32.     #逻辑删除配置
  33.     logic-delete-value: 0
  34.     logic-not-delete-value: 1
  35.   #    #自定义填充策略接口实现
  36.   #    meta-object-handler:
  37.   configuration:
  38.     map-underscore-to-camel-case: true #开启驼峰命名
  39.     cache-enabled: false
  40.     log-impl: org.apache.ibatis.logging.stdout.StdOutImpl #日志

主启动类-ShardingJdbcDemoApplication

  1. package com.sharding.demo;
  3. import org.mybatis.spring.annotation.MapperScan;
  4. import org.springframework.boot.SpringApplication;
  5. import org.springframework.boot.autoconfigure.SpringBootApplication;
  7. @SpringBootApplication
  8. @MapperScan(basePackages = "com.sharding.demo.mapper")
  9. public class ShardingJdbcDemoApplication {
  10.     public static void main(String[] args) {
  11.         SpringApplication.run(ShardingJdbcDemoApplication.class, args);
  12.     }
  13. }

entity

SuperEntity

  1. package com.sharding.demo.model;
  3. import com.baomidou.mybatisplus.annotation.FieldFill;
  4. import com.baomidou.mybatisplus.annotation.IdType;
  5. import com.baomidou.mybatisplus.annotation.TableField;
  6. import com.baomidou.mybatisplus.annotation.TableId;
  7. import com.baomidou.mybatisplus.extension.activerecord.Model;
  8. import com.fasterxml.jackson.annotation.JsonFormat;
  9. import java.io.Serializable;
  10. import java.util.Date;
  11. import lombok.Getter;
  12. import lombok.Setter;
  13. import lombok.ToString;
  15. /**
  16.  * 基础实体类
  17.  */
  18. @Getter
  19. @Setter
  20. @ToString
  21. public class SuperEntity<T extends Model<T>> extends Model<T> {
  22.     /**
  23.      * 主键ID
  24.      */
  25.     @TableId(type = IdType.AUTO)
  26.     private Long id;
  28.     @TableField(value = "create_by", fill = FieldFill.INSERT)
  29.     private String createBy;
  31.     @TableField(value = "update_by", fill = FieldFill.INSERT_UPDATE)
  32.     private String updateBy;
  33.     /**
  34.      * 创建时间
  35.      */
  36.     @TableField(value = "create_time", fill = FieldFill.INSERT)
  37.     @JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")
  38.     private Date createTime;
  40.     /**
  41.      * 更新时间
  42.      */
  43.     @TableField(value = "update_time", fill = FieldFill.INSERT_UPDATE)
  44.     @JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")
  45.     private Date updateTime;
  47.     /**
  48.      * 是否删除（0：未删除；1：已删除）
  49.      */
  50.     @TableField(value = "is_delete", fill = FieldFill.INSERT)
  51.     private Integer isDelete;
  53.     @Override
  54.     public Serializable pkVal() {
  55.         return this.id;
  56.     }
  57. }

PaymentWalletDetail

  1. package com.sharding.demo.model;
  3. import com.baomidou.mybatisplus.annotation.IdType;
  4. import com.baomidou.mybatisplus.annotation.TableId;
  5. import lombok.Data;
  6. import lombok.EqualsAndHashCode;
  8. import java.math.BigDecimal;
  10. /**
  11.  * 发放明细表
  12.  */
  13. @Data
  14. @EqualsAndHashCode(callSuper = true)
  15. public class PaymentWalletDetail  extends SuperEntity {
  16.     /**
  17.      * 主键ID
  18.      */
  19.     @TableId(type = IdType.ASSIGN_ID)
  20.     private Long id;
  22.     /**
  23.      * "tenantId
  24.      */
  25.     private Long tenantId;
  27.     /**
  28.      *支付月份yyyyMM，分片键，取自iface pay_date
  29.      */
  30.     private String payMonth;
  32.     private static final long serialVersionUID = 1L;
  33. }

PaymentWalletTransaction

  1. package com.sharding.demo.model;
  3. import com.baomidou.mybatisplus.annotation.IdType;
  4. import com.baomidou.mybatisplus.annotation.TableId;
  5. import lombok.Data;
  6. import lombok.EqualsAndHashCode;
  8. import java.math.BigDecimal;
  10. /**
  11.  * 发放流水表
  12.  */
  13. @Data
  14. @EqualsAndHashCode(callSuper = true)
  15. public class PaymentWalletTransaction extends SuperEntity {
  16.     /**
  17.      * 主键ID
  18.      */
  19.     @TableId(type = IdType.ASSIGN_ID)
  20.     private Long id;
  22.     /**
  23.      * 外部订单号-对应明细表的明细唯一单号
  24.      */
  25.     private String payOrderNumber;
  27.     /**
  28.      * 租户id
  29.      */
  30.     private Long tenantId;
  31. }

Mapper

PaymentWalletDetailMapper

  1. package com.sharding.demo.mapper;
  3. import com.baomidou.mybatisplus.core.mapper.BaseMapper;
  4. import com.sharding.demo.model.PaymentWalletDetail;
  5. import org.springframework.stereotype.Repository;
  7. @Repository
  8. public interface PaymentWalletDetailMapper  extends BaseMapper<PaymentWalletDetail> {
  9. }

PaymentWalletDetailMapper.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  3. <mapper namespace="com.sharding.demo.mapper.PaymentWalletDetailMapper">
  5. </mapper>

PaymentWalletTransactionMapper

  1. package com.sharding.demo.mapper;
  3. import com.baomidou.mybatisplus.core.mapper.BaseMapper;
  4. import com.sharding.demo.model.PaymentWalletTransaction;
  5. import org.apache.ibatis.annotations.Mapper;
  7. @Mapper
  8. public interface PaymentWalletTransactionMapper extends BaseMapper<PaymentWalletTransaction> {
  9. }

PaymentWalletTransactionMapper.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  3. <mapper namespace="com.sharding.demo.mapper.PaymentWalletTransactionMapper">
  4. </mapper>

service 和 serviceImpl 层

IPaymentWalletDetailService

  1. package com.sharding.demo.service;
  3. import com.baomidou.mybatisplus.extension.service.IService;
  4. import com.sharding.demo.model.PaymentWalletDetail;
  6. public interface IPaymentWalletDetailService extends IService<PaymentWalletDetail> {
  7. }

PaymentWalletDetailServiceImpl

  1. package com.sharding.demo.service.impl;
  3. import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
  4. import com.sharding.demo.mapper.PaymentWalletDetailMapper;
  5. import com.sharding.demo.model.PaymentWalletDetail;
  6. import com.sharding.demo.service.IPaymentWalletDetailService;
  7. import lombok.extern.slf4j.Slf4j;
  8. import org.springframework.stereotype.Service;
  10. @Slf4j
  11. @Service
  12. public class PaymentWalletDetailServiceImpl extends ServiceImpl<PaymentWalletDetailMapper, PaymentWalletDetail>
  13.         implements IPaymentWalletDetailService {
  14. }

IPaymentWalletTransactionService

  1. package com.sharding.demo.service;
  3. import com.baomidou.mybatisplus.extension.service.IService;
  4. import com.sharding.demo.model.PaymentWalletTransaction;
  7. public interface IPaymentWalletTransactionService extends IService<PaymentWalletTransaction> {
  8. }

PaymentWalletTransactionServiceImpl

  1. package com.sharding.demo.service.impl;
  3. import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
  4. import com.sharding.demo.mapper.PaymentWalletTransactionMapper;
  5. import com.sharding.demo.model.PaymentWalletTransaction;
  6. import com.sharding.demo.service.IPaymentWalletTransactionService;
  7. import lombok.extern.slf4j.Slf4j;
  8. import org.springframework.stereotype.Service;
  10. @Slf4j
  11. @Service
  12. public class PaymentWalletTransactionServiceImpl
  13.         extends ServiceImpl<PaymentWalletTransactionMapper, PaymentWalletTransaction>
  14.         implements IPaymentWalletTransactionService {
  16. }

controller

  1. package com.sharding.demo.controller;
  3. import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
  4. import com.sharding.demo.mapper.PaymentWalletDetailMapper;
  5. import com.sharding.demo.model.PaymentWalletDetail;
  6. import jakarta.annotation.Resource;
  7. import lombok.extern.slf4j.Slf4j;
  8. import org.springframework.web.bind.annotation.GetMapping;
  9. import org.springframework.web.bind.annotation.RequestMapping;
  10. import org.springframework.web.bind.annotation.RequestParam;
  11. import org.springframework.web.bind.annotation.RestController;
  13. import java.util.List;
  15. @Slf4j
  16. @RestController
  17. @RequestMapping("/test")
  18. public class TestController {
  19.     @Resource
  20.     PaymentWalletDetailMapper detailService;
  22.     @GetMapping("/testGetDetail")
  23.     public List<PaymentWalletDetail> testGetDetail(@RequestParam(name = "payMonth") String payMonth) {
  24.         LambdaQueryWrapper<PaymentWalletDetail> wrapper = new LambdaQueryWrapper<>();
  25.         wrapper.eq(PaymentWalletDetail::getPayMonth, payMonth);
  27.         return detailService.selectList(wrapper);
  28.     }
  29. }

测试结果

  1. [{"id":1,"createBy":null,"updateBy":null,"createTime":"2024-04-24 23:26:31","updateTime":"2024-04-24 23:26:31","isDelete":0,"payMonth":"202403"}]