当前位置:首页 > 文章列表 > 文章 > java教程 > SpringBoot整合MyBatisPlus详细教程

SpringBoot整合MyBatisPlus详细教程

2025-07-10 18:25:28 0浏览 收藏

本教程详细讲解了如何在Spring Boot项目中整合MyBatis Plus,旨在简化数据库操作,提升开发效率。首先,你需要添加MyBatis Plus和数据库连接器依赖,并配置数据源信息。接着,创建与数据库表对应的实体类,并创建继承BaseMapper的Mapper接口。通过编写Service调用Mapper方法,最后创建Controller提供API接口。此外,教程还介绍了MyBatis Plus代码生成器的使用,它可以自动生成实体类、Mapper接口、Service和Controller等代码,极大地提高开发效率。同时,还讲解了如何使用Page对象实现分页查询,如何自定义SQL注入器添加自定义SQL方法,以及如何利用乐观锁机制防止并发冲突,确保数据一致性。掌握这些技巧,能让你在Spring Boot项目中更高效地使用MyBatis Plus。

Spring Boot整合MyBatis Plus可通过以下步骤实现:1. 添加MyBatis Plus和数据库连接器依赖;2. 配置数据源信息;3. 创建与表对应的实体类;4. 创建继承BaseMapper的Mapper接口;5. 编写Service调用Mapper方法;6. 创建Controller提供API接口。此外,可使用MyBatis Plus代码生成器自动生成代码,通过配置生成器参数并运行生成代码。分页查询可通过引入Page对象并在Mapper中调用selectPage方法实现。自定义SQL注入器需创建继承DefaultSqlInjector的类并添加自定义方法,同时定义对应SQL逻辑并在Mapper接口中声明。乐观锁功能则通过在实体类添加@Version注解字段并配置OptimisticLockerInnerInterceptor拦截器实现,更新数据时自动处理版本号以防止并发冲突。

Spring Boot整合MyBatis Plus完整配置教程

Spring Boot整合MyBatis Plus,简单来说,就是让你的Spring Boot项目能更方便地操作数据库。MyBatis Plus简化了MyBatis的很多繁琐配置,让开发者可以更专注于业务逻辑。下面就来详细说说怎么配置。

Spring Boot整合MyBatis Plus完整配置教程

解决方案

  1. 添加依赖

首先,在你的pom.xml文件中添加MyBatis Plus的依赖。

   <dependency>
       <groupId>com.baomidou</groupId>
       <artifactId>mybatis-plus-boot-starter</artifactId>
       <version>3.5.3.1</version> <!-- 使用最新版本 -->
   </dependency>
   <dependency>
       <groupId>mysql</groupId>
       <artifactId>mysql-connector-java</artifactId>
       <version>8.0.33</version> <!-- 使用最新版本 -->
   </dependency>

这里顺便加上了MySQL的连接器,因为大部分项目都会用MySQL。如果你用的是其他数据库,比如PostgreSQL,就要换成对应的连接器。

Spring Boot整合MyBatis Plus完整配置教程
  1. 配置数据源

application.properties或者application.yml中配置数据源。

application.properties

Spring Boot整合MyBatis Plus完整配置教程
   spring.datasource.url=jdbc:mysql://localhost:3306/your_database?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
   spring.datasource.username=your_username
   spring.datasource.password=your_password
   spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

application.yml

   spring:
     datasource:
       url: jdbc:mysql://localhost:3306/your_database?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
       username: your_username
       password: your_password
       driver-class-name: com.mysql.cj.jdbc.Driver

别忘了把your_databaseyour_usernameyour_password改成你自己的数据库信息。serverTimezone也要设置成你所在的时区,不然可能会遇到时间问题。

  1. 创建实体类

创建一个实体类,对应数据库中的表。

   import com.baomidou.mybatisplus.annotation.IdType;
   import com.baomidou.mybatisplus.annotation.TableId;
   import com.baomidou.mybatisplus.annotation.TableName;
   import lombok.Data;

   @Data
   @TableName("user") // 对应数据库中的表名
   public class User {
       @TableId(type = IdType.AUTO) // 主键自增
       private Long id;
       private String name;
       private Integer age;
       private String email;
   }

@TableName注解用来指定表名,@TableId注解用来指定主键,@Data是Lombok的注解,可以自动生成getter和setter方法。

  1. 创建Mapper接口

创建一个Mapper接口,继承BaseMapper

   import com.baomidou.mybatisplus.core.mapper.BaseMapper;
   import org.apache.ibatis.annotations.Mapper;

   @Mapper
   public interface UserMapper extends BaseMapper<User> {
       // 可以自定义SQL语句,也可以使用MyBatis Plus提供的通用方法
   }

@Mapper注解是MyBatis的注解,用来告诉Spring这是一个Mapper接口。BaseMapper是MyBatis Plus提供的通用Mapper接口,里面有很多常用的CRUD方法。

  1. 编写Service

创建一个Service类,调用Mapper接口的方法。

   import org.springframework.beans.factory.annotation.Autowired;
   import org.springframework.stereotype.Service;

   import java.util.List;

   @Service
   public class UserService {

       @Autowired
       private UserMapper userMapper;

       public User getUserById(Long id) {
           return userMapper.selectById(id);
       }

       public List<User> getAllUsers() {
           return userMapper.selectList(null);
       }

       public void addUser(User user) {
           userMapper.insert(user);
       }

       public void updateUser(User user) {
           userMapper.updateById(user);
       }

       public void deleteUser(Long id) {
           userMapper.deleteById(id);
       }
   }

这里使用了@Autowired注解来注入UserMapper。然后就可以调用userMapper的方法来操作数据库了。

  1. 编写Controller

创建一个Controller类,提供API接口。

   import org.springframework.beans.factory.annotation.Autowired;
   import org.springframework.web.bind.annotation.*;

   import java.util.List;

   @RestController
   @RequestMapping("/users")
   public class UserController {

       @Autowired
       private UserService userService;

       @GetMapping("/{id}")
       public User getUserById(@PathVariable Long id) {
           return userService.getUserById(id);
       }

       @GetMapping
       public List<User> getAllUsers() {
           return userService.getAllUsers();
       }

       @PostMapping
       public void addUser(@RequestBody User user) {
           userService.addUser(user);
       }

       @PutMapping("/{id}")
       public void updateUser(@PathVariable Long id, @RequestBody User user) {
           user.setId(id);
           userService.updateUser(user);
       }

       @DeleteMapping("/{id}")
       public void deleteUser(@PathVariable Long id) {
           userService.deleteUser(id);
       }
   }

这里使用了@RestController@RequestMapping注解来定义API接口。然后就可以通过HTTP请求来访问这些接口了。

MyBatis Plus 代码生成器如何使用?

MyBatis Plus的代码生成器可以帮你自动生成实体类、Mapper接口、Service和Controller,大大提高开发效率。

  1. 添加代码生成器依赖
   <dependency>
       <groupId>com.baomidou</groupId>
       <artifactId>mybatis-plus-generator</artifactId>
       <version>3.5.3.1</version>
   </dependency>
   <dependency>
       <groupId>org.apache.velocity</groupId>
       <artifactId>velocity-engine-core</artifactId>
       <version>2.3</version> <!-- 使用最新版本 -->
   </dependency>

这里添加了mybatis-plus-generatorvelocity-engine-core的依赖。velocity-engine-core是代码生成器使用的模板引擎。

  1. 编写代码生成器配置

创建一个类,编写代码生成器的配置。

   import com.baomidou.mybatisplus.generator.FastAutoGenerator;
   import com.baomidou.mybatisplus.generator.config.OutputFile;
   import com.baomidou.mybatisplus.generator.engine.VelocityTemplateEngine;

   import java.util.Collections;

   public class CodeGenerator {

       public static void main(String[] args) {
           FastAutoGenerator.create("jdbc:mysql://localhost:3306/your_database?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai", "your_username", "your_password")
                   .globalConfig(builder -> {
                       builder.author("Your Name") // 设置作者
                               .outputDir("D://code") // 设置输出目录
                               .commentDate("yyyy-MM-dd")
                               .enableSwagger() // 开启 swagger 模式
                               .fileOverride(); // 覆盖已生成文件
                   })
                   .packageConfig(builder -> {
                       builder.parent("com.example") // 设置父包名
                               .moduleName("demo") // 设置父包模块名
                               .entity("entity") // 设置实体类包名
                               .service("service") // 设置service包名
                               .serviceImpl("service.impl") // 设置serviceImpl包名
                               .mapper("mapper") // 设置mapper包名
                               .xml("mapper.xml")
                               .controller("controller") // 设置controller包名
                               .pathInfo(Collections.singletonMap(OutputFile.mapperXml, "D://code//mapper")); // 设置mapperXml生成路径
                   })
                   .strategyConfig(builder -> {
                       builder.addInclude("user") // 设置需要生成的表名
                               .addTablePrefix("t_", "c_") // 设置过滤表前缀
                               .entityBuilder()
                               .enableLombok()
                               .enableTableFieldAnnotation()
                               .controllerBuilder()
                               .enableRestStyle();
                   })
                   .templateEngine(new VelocityTemplateEngine()) // 使用Velocity引擎模板
                   .execute();
       }
   }

这里使用了FastAutoGenerator来配置代码生成器。你需要修改数据库连接信息、作者、输出目录、包名、表名等信息。

  1. 运行代码生成器

运行CodeGenerator类的main方法,就可以自动生成代码了。

MyBatis Plus 如何进行分页查询?

MyBatis Plus提供了非常方便的分页查询功能。

  1. 引入Page对象
   import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
  1. 编写分页查询方法
   public Page<User> getUsersByPage(int pageNum, int pageSize) {
       Page<User> page = new Page<>(pageNum, pageSize);
       return userMapper.selectPage(page, null);
   }

这里使用了Page对象来封装分页信息。pageNum是页码,pageSize是每页显示的条数。selectPage方法会自动进行分页查询。

  1. 在Controller中调用分页查询方法
   @GetMapping("/page")
   public Page<User> getUsersByPage(@RequestParam(defaultValue = "1") int pageNum, @RequestParam(defaultValue = "10") int pageSize) {
       return userService.getUsersByPage(pageNum, pageSize);
   }

这里使用了@RequestParam注解来获取页码和每页显示的条数。

如何自定义 MyBatis Plus 的 SQL 注入器?

MyBatis Plus允许你自定义SQL注入器,添加自定义的SQL方法。

  1. 创建自定义SQL注入器
   import com.baomidou.mybatisplus.core.injector.AbstractMethod;
   import com.baomidou.mybatisplus.core.injector.DefaultSqlInjector;
   import org.springframework.stereotype.Component;

   import java.util.List;

   @Component
   public class MySqlInjector extends DefaultSqlInjector {

       @Override
       public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
           List<AbstractMethod> methodList = super.getMethodList(mapperClass);
           methodList.add(new MyCustomMethod()); // 添加自定义方法
           return methodList;
       }
   }

这里继承了DefaultSqlInjector,并重写了getMethodList方法,添加了自定义的SQL方法。

  1. 创建自定义SQL方法
   import com.baomidou.mybatisplus.core.injector.AbstractMethod;
   import com.baomidou.mybatisplus.core.metadata.TableInfo;
   import org.apache.ibatis.mapping.MappedStatement;
   import org.apache.ibatis.mapping.SqlSource;

   public class MyCustomMethod extends AbstractMethod {

       @Override
       public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
           String sql = "select * from " + tableInfo.getTableName() + " where age > 18";
           SqlSource sqlSource = languageDriver.createSqlSource(configuration, sql, modelClass);
           return addSelectMappedStatement(mapperClass, "selectAdultUsers", sqlSource, modelClass, tableInfo);
       }
   }

这里继承了AbstractMethod,并重写了injectMappedStatement方法,定义了自定义的SQL语句。

  1. 在Mapper接口中使用自定义方法
   import org.apache.ibatis.annotations.Mapper;

   import java.util.List;

   @Mapper
   public interface UserMapper extends BaseMapper<User> {
       List<User> selectAdultUsers(); // 使用自定义方法
   }

在Mapper接口中声明自定义方法,就可以使用了。

如何使用 MyBatis Plus 的乐观锁?

乐观锁是一种并发控制机制,可以避免多个用户同时修改同一条数据导致的数据冲突。

  1. 在实体类中添加版本号字段
   import com.baomidou.mybatisplus.annotation.Version;
   import lombok.Data;

   @Data
   public class User {
       private Long id;
       private String name;
       private Integer age;
       private String email;
       @Version // 乐观锁版本号字段
       private Integer version;
   }

这里使用了@Version注解来标记版本号字段。

  1. 配置乐观锁拦截器
   import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
   import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;
   import org.springframework.context.annotation.Bean;
   import org.springframework.context.annotation.Configuration;

   @Configuration
   public class MybatisPlusConfig {

       @Bean
       public MybatisPlusInterceptor mybatisPlusInterceptor() {
           MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
           interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor()); // 添加乐观锁拦截器
           return interceptor;
       }
   }

这里配置了OptimisticLockerInnerInterceptor拦截器,用来实现乐观锁功能。

  1. 更新数据时,MyBatis Plus会自动更新版本号
   public void updateUser(User user) {
       userMapper.updateById(user); // 更新数据时,MyBatis Plus会自动更新版本号
   }

在更新数据时,MyBatis Plus会自动更新版本号,如果版本号不一致,就会抛出异常。

好了,本文到此结束,带大家了解了《SpringBoot整合MyBatisPlus详细教程》,希望本文对你有所帮助!关注golang学习网公众号,给大家分享更多文章知识!

Python高效存数据,Parquet格式优化技巧Python高效存数据,Parquet格式优化技巧
上一篇
Python高效存数据,Parquet格式优化技巧
JWT认证实现:Token生成与验证全解析
下一篇
JWT认证实现:Token生成与验证全解析
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    542次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    509次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    497次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    484次学习
查看更多
AI推荐
  • AI边界平台:智能对话、写作、画图,一站式解决方案
    边界AI平台
    探索AI边界平台,领先的智能AI对话、写作与画图生成工具。高效便捷,满足多样化需求。立即体验!
    386次使用
  • 讯飞AI大学堂免费AI认证证书:大模型工程师认证,提升您的职场竞争力
    免费AI认证证书
    科大讯飞AI大学堂推出免费大模型工程师认证,助力您掌握AI技能,提升职场竞争力。体系化学习,实战项目,权威认证,助您成为企业级大模型应用人才。
    398次使用
  • 茅茅虫AIGC检测:精准识别AI生成内容,保障学术诚信
    茅茅虫AIGC检测
    茅茅虫AIGC检测,湖南茅茅虫科技有限公司倾力打造,运用NLP技术精准识别AI生成文本,提供论文、专著等学术文本的AIGC检测服务。支持多种格式,生成可视化报告,保障您的学术诚信和内容质量。
    538次使用
  • 赛林匹克平台:科技赛事聚合,赋能AI、算力、量子计算创新
    赛林匹克平台(Challympics)
    探索赛林匹克平台Challympics,一个聚焦人工智能、算力算法、量子计算等前沿技术的赛事聚合平台。连接产学研用,助力科技创新与产业升级。
    634次使用
  • SEO  笔格AIPPT:AI智能PPT制作,免费生成,高效演示
    笔格AIPPT
    SEO 笔格AIPPT是135编辑器推出的AI智能PPT制作平台,依托DeepSeek大模型,实现智能大纲生成、一键PPT生成、AI文字优化、图像生成等功能。免费试用,提升PPT制作效率,适用于商务演示、教育培训等多种场景。
    544次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码