Springboot整合Mybatis Plus【超详细】

已于 2023-05-31 11:05:36 修改
阅读量1.8w 收藏 59
点赞数 4
文章标签： spring boot java mybatis mybatisplus
于 2023-05-31 00:24:54 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/qq_45399396/article/details/130959510
版权

文章目录

Mybatis Plus简介

MyBatisPlus是基于MyaBatis框架基础上开发的增强型工具，旨在简化开发，提高效率。

MyBatis Plus特性：

特性说明
无入侵做增强不做改变，不会对现有工程产生影响
损耗小启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
强大的CRUD操作内置通用Mapper，少量配置即可实现单表CRUD操作
支持Lambda编写查询条件无序担心字段错误
内置分页插件方便高效
支持主键自动生成支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置完美解决主键问题
支持自定义全局通用操作支持全局通用方法注入
内置性能分析插件可输出 Sql 语句及其执行时间，建议开发测试时启用该功能，能快速定位慢查询

快速整合

总结需要做的步骤，不拖拉

1，导入依赖
2，yml文件中配置信息
3，启动类上加上扫描mapper接口所在包的注解
4，编写配置类
5，实现自动注入通用字段接口（非必需）
6，编写Mybatis Plus的controller、service、entity、mapper、xml的生成器工具类

1，导入依赖

        <!--mybatis plus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>${mybatis-plus.version}</version>
        </dependency>
        
         <!--mybatis plus生成器依赖-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>${mybatis-plus.version}</version>
        </dependency>
        
         <!--velocity模版依赖-->
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity</artifactId>
            <version>${velocity.version}</version>
            <exclusions>
                <exclusion>
                    <groupId>commons-collections</groupId>
                    <artifactId>commons-collections</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

2，yml文件中配置信息

mybatis-plus:
  # entity包路径,自行修改
  typeAliasesPackage: com.tunda.openai.model.entity
  # enum包路径,自行修改
  typeEnumsPackage: com.tunda.openai.common.enums
  global-config:
    db-config:
      db-column-underline: true
      # 逻辑删及设置默认值（deleted字段是数据库自定义字段）
      logic-delete-field: deleted
      logic-not-delete-value: 0
      logic-delete-value: 1
  configuration:
    mapUnderscoreToCamelCase: true
    # log-impl: org.apache.ibatis.logging.slf4j.Slf4jImpl #开启sql日志
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl # 控制台 打印sql
    default-enum-type-handler: com.baomidou.mybatisplus.extension.handlers.MybatisEnumTypeHandler

3，启动类上加上扫描mapper接口所在包的注解

@SpringBootApplication
@MapperScan(basePackages ="com.tunda.openai.mapper")
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class,args);
    }
}

4，编写配置类

@Configuration
@EnableTransactionManagement
public class MybatisPlusConfig {

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        PaginationInnerInterceptor pii = new PaginationInnerInterceptor();
        pii.setDbType(DbType.MYSQL);
        pii.setMaxLimit(500L);
        interceptor.addInnerInterceptor(pii);
        return interceptor;
    }

    @Bean
    public ConfigurationCustomizer configurationCustomizer() {
        return configuration -> configuration.setUseDeprecatedExecutor(false);
    }
}

5，实现自动注入通用字段接口（非必需）

@Component
public class MybatisMetaObjectHandler implements MetaObjectHandler {
    @Override
    public void insertFill(MetaObject metaObject) {
        insertOrUpdateFill(metaObject, true);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        insertOrUpdateFill(metaObject, false);
    }

    private void insertOrUpdateFill(MetaObject metaObject, boolean isInsert) {
        if (isInsert) {
            if (Objects.isNull(getFieldValByName("createTime",metaObject)))
            this.setFieldValByName("createTime", LocalDateTime.now(), metaObject);
            this.setFieldValByName("deleted", 0, metaObject);
        } else {
            if (Objects.isNull(getFieldValByName("updateTime",metaObject)))
            this.setFieldValByName("updateTime", LocalDateTime.now(), metaObject);
        }
    }
}

6，编写生成器工具类

具体说明：传送门->https://blog.youkuaiyun.com/qq_45399396/article/details/123986811

public class MybatisPlusGenerator {

    //生成文件所在项目路径
    private static String baseProjectPath = "D:\\generatorCode";

    //基本包名
    private static String basePackage = "com.tunda.openai";

    //作者(一般公司名简称)
    private static String authorName = "tunda";

    //要生成的表名，为空时生成所有表
    private static String[] tables = {"t_goods_info"};

    //table前缀
    private static String prefix = "";

    //数据库配置四要素
    private static String driverName = "com.mysql.jdbc.Driver";
    private static String url = "jdbc:mysql://129.139.254.38:3306/tunsdda_gpt?serverTimezone=GMT%2B8&zeroDateTimeBehavior=CONVERT_TO_NULL&useUnicode=true&characterEncoding=utf-8&useSSL=false";
    private static String username = "root";
    private static String password = "root";

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 1、全局配置
        GlobalConfig gc = new GlobalConfig();

        //可以将生成得代码单独放在文件夹里，检查完没问题在手动将包复制到项目中
        gc.setOutputDir(baseProjectPath);
        gc.setAuthor(authorName);// 生成实体类的文档注解中作者名
        gc.setOpen(true);// 生成代码后自动打开生成目录文件
        gc.setFileOverride(true); // 是否覆盖原来生成的
        gc.setIdType(IdType.AUTO);// 指定生成的主键类型：自增长
        gc.setDateType(DateType.ONLY_DATE);
        gc.setActiveRecord(false);
        mpg.setGlobalConfig(gc);

        // 2、数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl(url);
        dsc.setDriverName(driverName);
        dsc.setUsername(username);
        dsc.setPassword(password);
        dsc.setDbType(DbType.MYSQL); // mysql数据库
        gc.setServiceName("%sService"); //去掉Service接口的首字母'I'
        dsc.setTypeConvert(new MySqlTypeConvert() {
            @Override
            public IColumnType processTypeConvert(GlobalConfig globalConfig, TableField tableField) {
                return super.processTypeConvert(globalConfig, tableField);
            }
        });
        mpg.setDataSource(dsc);

        // 3、包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(null)// 生成的controller路径映射为一个"/",覆盖默认的"//"
                .setParent(basePackage)// 生成controller，service，xml并设置路径。
                .setEntity("entity")
                .setMapper("mapper")
                .setService("service")
                .setServiceImpl("service.impl")
                .setController("controller");
        mpg.setPackageInfo(pc);

        // 5、策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setCapitalMode(true);// 开启全局大写命名
        strategy.setNaming(NamingStrategy.underline_to_camel);// 实体类名驼峰
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);// 属性名驼峰
        strategy.setInclude(tables);// 设置要映射的表名注解@Table
        strategy.setSuperEntityClass(BaseEntity.class); // 预先定义一个BaseEntity类实现Serializable接口
        strategy.setEntityLombokModel(true); // 使用 lombok
        strategy.setRestControllerStyle(true);// 开启 restful风格
        strategy.setEntityTableFieldAnnotationEnable(false);// 不生成实体类字段swagger类型注解,而是采用文档类型注解：/**xxx*/

        if (prefix != null) strategy.setTablePrefix(prefix);  // 表前缀
        if (ArrayUtils.isNotEmpty(tables)) strategy.setInclude(tables);  // 表名

        // 6、自动填充配置：非必须（自动加上注解）
        TableFill createTime = new TableFill("create_time", FieldFill.INSERT);
        TableFill updateTime = new TableFill("update_time", FieldFill.UPDATE);
        ArrayList<TableFill> tableFills = new ArrayList<>();
        tableFills.add(createTime);
        tableFills.add(updateTime);
        strategy.setTableFillList(tableFills);

        strategy.setLogicDeleteFieldName("deleted");// 自动加上逻辑删注解

        mpg.setStrategy(strategy);

        mpg.setTemplateEngine(new VelocityTemplateEngine());

        // 执行生成器
        mpg.execute();
    }

}

注意事项：生成的代码当中，entiry实体类需要注意一下@EqualsAndHashCode，生成的时候，@EqualsAndHashCode(callSuper = true)。
但是大多数情况下，@EqualsAndHashCode(callSuper = false) 或者直接去掉这个注解也可以，所以这个的生成器生成的这个注解需要手动修改一下（改为false或者直接去掉这个注解）

到此为止，Springboot整合Mybatis Plus结束，接下来就是注意事项

1，问题一：mybatis-plus中@TableField.fill设置为FieldFill.UPDATE不生效

要想实现自动注入字段属性，必需实现第5步骤，也就是实现MetaObjectHandler接口，
其次，这种不生效的也存在两个注意的场景
场景一：使用原生sql语句，则注入字段属性不生效
场景二：使用update()方法时，需要调用两个参数的重载方法才有效，就这里需要注意一下。

使用方法API

1，新增操作

这里的this表示的是在service的实现类对象

this.saveOrUpdate(tGoodsInfo);

2，修改操作

在这里插入图片描述

通过Wappers的Lambda表达式来构造where后面的条件

在这里插入图片描述

3，查询操作

Mybatis Plus封装了丰富的查询操作api，尤其是单表操作的API，相比于SpringJPA来说，好处多多。

3,1 多条件查询

在这里插入图片描述
.
在这里插入图片描述
.
在这里插入图片描述
完整的示例如下：
在这里插入图片描述

3.2 排序

在这里插入图片描述

完整的示例如下：在这里插入图片描述

3.3 分组

在这里插入图片描述
完整的示例如下：
在这里插入图片描述

3.4 分页

在这里插入图片描述

在这里插入图片描述

完整的示例如下：
在这里插入图片描述

4，删除操作

在这里插入图片描述

Spring Boot 集成MyBatis-Plus
m0_74824877的博客
03-10 1979
增加集成相关的配置和依赖后，我们又创建了一个简单的接口，用于验证本次集成是否成功。其中谈到了SSM项目中基本的项目结构，相关代码都是从生产代码中抽象出来的，具有很强的参考意义。在古早的应用开发中，需要开发人员写许多的DAL（数据访问层）代码，需要自己管理数据库的连接与关闭，还需要自己从ResultSet中获取数据，然后再将其组装为对象。并且为了保持依赖的松散，控制器是不直接依赖于具体类的，而是依赖于接口。被该注解修饰的类，setters方法返回的该类的实例（即this），而不是void。
SpringBoot整合Mybatis-Plus
A_diligent_man的博客
08-08 1万+
MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window) 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。特性无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作。
SpringBoot集成MyBatisPlus
01-05
SpringBoot集成MyBatisPlus 技术选型： 核心框架：Spring Boot 1.5.1 安全框架：Apache Shiro 视图框架：Spring MVC 持久层框架：MyBatis MyBatisPlus 缓存技术：EhCache,Redis 数据库连接池：Druid 日志管理：SLF4J、Log4j 模版技术：FreeMarker 页面交互：BootStrap、Layer等
springboot整合mybatis-plus
听钱塘信来的博客
10-04 3万+
springboot整合mybatis-plus，自此告别基础SQL的编写；
springboot集成MyBatis-Plus
Flying_Fish_roe的博客
09-22 2560
MyBatis-Plus 的集成和使用在 Spring Boot 项目中非常简单。通过 `mybatis-plus-boot-starter`，开发者可以轻松构建基础的 CRUD 操作，并利用 MyBatis-Plus 提供的查询构造器、分页插件等功能，快速处理复杂的业务需求。 - **基础 CRUD**：通过继承 `BaseMapper`，可以直接调用常用的数据库操作方法。 - **复杂查询**：利用 `QueryWrapper` 和 `UpdateWrapper`，实现灵活的条件查询和更新。 - *
SpringBoot整合MyBatis Plus实现增删改查教程
02-05
SpringBoot整合MyBatis Plus实现增删改查教程 本文将详细介绍如何使用 Spring Boot 框架和 MyBatis Plus 实现增删改查（CRUD）操作的教程。MyBatis Plus 是一个基于 MyBatis 的 ORM 框架，它提供了许多实用的功能来...
springboot整合 mybatis-plus
10-17
SpringBoot整合MyBatis-Plus以及MysqlGenerator代码自动生成器的实践指南 SpringBoot作为现代Java开发中流行的微服务框架，以其简单、快速和易于部署的特性受到开发者的青睐。MyBatis-Plus作为MyBatis的增强工具，...
SpringBoot整合Mybatis-Plus+Oracle+Mysql
01-05
本教程将深入探讨如何利用SpringBoot整合Mybatis-Plus，同时支持Oracle和MySQL数据库，并通过Nacos作为注册中心，以及使用Swagger2进行API文档的生成。 首先，让我们了解SpringBoot的核心优势。SpringBoot简化了...
springboot整合mybatis调用oracle存储过程
08-17
本文将深入探讨如何在Spring Boot项目中整合MyBatis，实现调用Oracle存储过程并处理游标返回的数据。 首先，我们需要在Spring Boot项目中引入相关的依赖。在`pom.xml`文件中添加Oracle JDBC驱动（ojdbc66-oracle...
springboot mybatisplus 集成（附代码）
04-30
NULL 博文链接：https://zhouguofeng.iteye.com/blog/2388143
springboot+mybatis-plus+shardingsphere 实现读写分离
04-09
本项目以"springboot+mybatis-plus+shardingsphere 实现读写分离"为主题，结合了Spring Boot的快速开发能力、MyBatis-Plus的简化数据操作以及ShardingSphere的分布式数据库解决方案，旨在提高系统的读取性能和可扩展...
springboot 整合 mybatis-plus
jike920203的博客
07-03 2755
3.1.使用自定义sql和使用mybatis完全一样，这里不赘述了3.2.对自定义sql分页interface层同mybatis的正常使用，但是在第一个参数加上一个Page入参介绍两个插件DataPermissionInterceptor， PaginationInnerInterceptor我们在开发中，很多项目有多租户，多组织的需求，不同租户和组织能看到的数据内容不同。
SpringBoot 整合MyBatisPlus
热门推荐
小钟不想敲代码
09-07 5万+
SpringBoot 整合MyBatisPlus
简单应用：SpringBoot 集成mybatis-plus
等什么君！的博客
08-30 4156
本篇博客，基于mybatis-plus官网，简单了解和搭建mybatis-plusMyBatis-Plus 是 一个 MyBatis的增强工具，为简化springboot开发、提高效率而生。简介 | MyBatis-Plus。
SpringBoot整合MybatisPlus（详细版）
As_Yua的博客
07-13 1万+
​MybatisPlus是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。它继承了 MyBatis 的所有特性，并且加入了强大的功能，例如自动填充、逻辑删除、乐观锁、性能分析等。
SpringBoot 整合 MyBatisPlus
一个95后开发者，热爱编程，喜欢玩游戏. 希望可以结识更多的小伙伴...
06-30 9313
.
springboot mybatisplus 配置
最新发布
03-25
<think>好的，用户想在Spring Boot项目中配置MyBatis-Plus，需要详细的教程和示例。首先，我需要回忆一下MyBatis-Plus的配置步骤，并结合用户提供的引用内容来组织回答。 用户提到了三个引用，其中引用[1]和[2]提到了使用Spring Initializr创建项目，选择依赖，以及配置文件、实体映射、CRUD操作等内容。引用[3]是关于读写分离的配置，不过用户的主要问题可能不涉及这个，但可能需要简要提及。 首先，应该分步骤讲解，从项目创建到配置，再到示例代码。需要确保每一步都清晰，并且代码示例正确。可能需要注意以下几点： 1. 创建项目时，需要选择正确的依赖，比如MyBatis-Plus、MySQL Driver、Spring Web。这里要确认依赖名称是否正确，例如在Spring Initializr中MyBatis-Plus的依赖名称是否是“MyBatis-Plus”或者可能有不同的命名方式，比如“MyBatis Plus”。 2. 数据库配置，包括URL、用户名、密码、驱动类，这部分需要给出示例，并且提醒用户根据实际情况修改。 3. 实体类和Mapper接口的创建，这里需要说明如何使用MyBatis-Plus的注解，比如@TableName、@TableId等，以及继承BaseMapper的重要性。 4. 示例的Service和Controller层代码，展示如何进行CRUD操作。可能需要给出简单的示例，比如保存用户和查询用户列表。 5. 主类添加@MapperScan注解，确保Mapper接口被扫描到。 6. 测试部分，说明如何运行和验证。 另外，用户可能关心MyBatis-Plus的更多功能，比如分页插件、代码生成器等，可以在相关问题中提及，或者在步骤中简要说明。 需要检查引用内容中的依赖版本是否正确，比如dynamic-datasource-spring-boot3-starter的版本是否为4.3.1，但用户的问题可能不涉及读写分离，所以可能不需要包含这部分，除非用户特别问到。不过在相关问题中可以提到读写分离的配置，引导用户扩展知识。 还需要确保LaTeX格式正确，虽然用户的问题可能不涉及数学公式，但根据系统指令，所有行内数学表达式需要用$...$，但这里可能用不上，但要注意代码块的正确格式。 可能存在的疑问点：是否需要分点回答？用户要求结构清晰，分步骤说明，所以应该用编号步骤。同时要验证每个步骤的正确性，比如依赖名称是否正确，配置示例是否准确。 最后，生成相关问题时要考虑用户可能的后续问题，比如性能优化、高级功能、配置多数据源等。</think>### Spring Boot 配置 MyBatis-Plus 教程 #### 1. 创建项目并添加依赖 通过 **Spring Initializr** 创建项目时，需选择以下依赖： - **Spring Web** - **MyBatis-Plus** - **MySQL Driver** Maven 依赖示例（若手动配置）： ```xml <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.5.6</version> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.33</version> </dependency> ``` #### 2. 配置数据库连接 在 `application.yml` 中添加数据库信息： ```yaml spring: datasource: url: jdbc:mysql://localhost:3306/test_db?useSSL=false&serverTimezone=UTC username: root password: root driver-class-name: com.mysql.cj.jdbc.Driver ``` #### 3. 定义实体类与 Mapper 接口 实体类使用 `@TableName` 注解映射数据库表： ```java @TableName("user") public class User { @TableId(type = IdType.AUTO) private Long id; private String name; private Integer age; // 省略 getter/setter } ``` Mapper 接口需继承 `BaseMapper`： ```java public interface UserMapper extends BaseMapper<User> {} ``` #### 4. 启用 Mapper 扫描 在主启动类添加 `@MapperScan`： ```java @SpringBootApplication @MapperScan("com.example.mapper") public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } } ``` #### 5. 编写 Service 与 Controller Service 示例（可直接注入 Mapper）： ```java @Service public class UserService { @Autowired private UserMapper userMapper; public List<User> listUsers() { return userMapper.selectList(null); } } ``` Controller 示例： ```java @RestController @RequestMapping("/user") public class UserController { @Autowired private UserService userService; @GetMapping("/list") public List<User> list() { return userService.listUsers(); } } ``` #### 6. 测试运行 启动项目后访问 `http://localhost:8080/user/list`，若返回用户列表则配置成功[^2]。 --- ### 功能扩展说明 - **分页插件**：通过 `PaginationInterceptor` 实现分页查询。 - **代码生成器**：使用 `AutoGenerator` 快速生成实体类、Mapper 等文件。 - **多数据源**：引入 `dynamic-datasource-spring-boot-starter` 可配置读写分离（Spring Boot 3 需对应依赖版本）[^3]。 ---
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值