SpringBoot3集成MyBatisPlus

介绍

使用SpringBoot3集成MyBatisPlus，进行项目开发。这里分XX进行整合。

第一步：创建SpringBoot3项目

创建项目时选择MySQL和Web的依赖。作者在这里使用的SpringBoot版本是3.2.4。

第二步：添加MybatisPlus相关依赖

<!--mybatis-plus-->
<dependency>
	<groupId>com.baomidou</groupId>
	<artifactId>mybatis-plus-spring-boot3-starter</artifactId>
	<version>3.5.5</version>
</dependency>

第三步：创建MybatisPlus配置类

package com.xiaoxi.officePark2024.config;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@MapperScan("com.xiaoxi.officePark2024.system.mapper")
public class MybatisPlusConfig {

    /**
     * 添加分页插件
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));//如果配置多个插件,切记分页最后添加
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());//配置乐观锁插件
        return interceptor;
    }
}

第四步：创建添加时间和修改时间自动填充类（可选）

package com.xiaoxi.officePark2024.config;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.time.LocalDateTime;

/**
 * MybatisPlus自动填充添加时间和修改时间
 */
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now()); // 起始版本 3.3.0(推荐使用)
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now()); // 起始版本 3.3.0(推荐)
    }
}

需要在字段上添加注解配置

/**
 * 添加时间
 */
@TableField(fill = FieldFill.INSERT)
private Date addTime;
/**
 * 修改时间
 */
@TableField(fill = FieldFill.UPDATE)
private Date updateTime;

第五步：application.yml添加数据库连接

spring:
  application:
    name: officePark2024
  # 数据库配置
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/office_park_2024?characterEncoding=utf-8&useSSL=false&allowPublicKeyRetrieval=true
    username: root
    password: 666666

第六步：配置代码生成器（可选）

添加依赖

<!--mybatis-plus代码生成器-->
<dependency>
	<groupId>com.baomidou</groupId>
	<artifactId>mybatis-plus-generator</artifactId>
	<version>3.5.5</version>
</dependency>
<dependency>
	<groupId>org.freemarker</groupId>
	<artifactId>freemarker</artifactId>
	<version>2.3.32</version>
</dependency>

添加生成代码

下面代码作者是在maven项目的test包下创建的。

package com.xiaoxi.officePark2024;

import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.config.rules.DbColumnType;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

import java.sql.Types;
import java.util.Collections;

public class CodeGenerator {

    public static void main(String[] args) {
        String outputDir = "/Users/mac/gitee/office-park-2024/src/main/java";
        String mapperOutputDir = "/Users/mac/gitee/office-park-2024/src/main/resources/mapper";
        FastAutoGenerator.create("jdbc:mysql://127.0.0.1:3306/office_park_2024", "root", "666666")
                .globalConfig(builder -> {
                    builder.author("xiaoxi") // 设置作者
//                            .enableSwagger() // 开启 swagger 模式
                            .disableOpenDir()
//                            .fileOverride() // 覆盖已生成文件
                            .outputDir(outputDir); // 指定输出目录
                })
                .dataSourceConfig(builder -> builder.typeConvertHandler((globalConfig, typeRegistry, metaInfo) -> {
                    int typeCode = metaInfo.getJdbcType().TYPE_CODE;
                    if (typeCode == Types.TINYINT) {
                        // 自定义类型转换
                        return DbColumnType.INTEGER;
                    }
                    return typeRegistry.getColumnType(metaInfo);

                }))
                .packageConfig(builder -> {
                    builder.parent("com.xiaoxi.officePark2024") // 设置父包名
                            .moduleName("system") // 设置父包模块名
                            .pathInfo(Collections.singletonMap(OutputFile.xml, mapperOutputDir)); // 设置mapperXml生成路径
                })
                .strategyConfig(builder -> {
                    builder.addInclude("op_park") // 设置需要生成的表名
                            .addTablePrefix("sys_", "c_"); // 设置过滤表前缀
                    builder.entityBuilder().enableLombok();
                })
                .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板
                .execute();
    }
}