0

0

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

蓮花仙者

蓮花仙者

发布时间:2025-07-10 16:02:02

|

601人浏览过

|

来源于php中文网

原创

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的依赖。

   
       com.baomidou
       mybatis-plus-boot-starter
       3.5.3.1 
   
   
       mysql
       mysql-connector-java
       8.0.33 
   

这里顺便加上了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 {
       // 可以自定义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 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 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,大大提高开发效率。

DBShop开源电子商务网店系统
DBShop开源电子商务网店系统

DBShop电子商务系统具备统一的系统设置、简单的商品管理、灵活的商品标签、强大的商品属性、方便的配送费用管理、自由的客服设置、独立的广告管理、全面的邮件提醒、详细的管理权限设置、整合国内外知名支付网关、完善的系统更新(可在线自动更新或手动更新)功能、细致的帮助说明、无微不至的在线教程……,使用本系统绝对是一种享受!

下载
  1. 添加代码生成器依赖
   
       com.baomidou
       mybatis-plus-generator
       3.5.3.1
   
   
       org.apache.velocity
       velocity-engine-core
       2.3 
   

这里添加了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 getUsersByPage(int pageNum, int pageSize) {
       Page page = new Page<>(pageNum, pageSize);
       return userMapper.selectPage(page, null);
   }

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

  1. 在Controller中调用分页查询方法
   @GetMapping("/page")
   public Page 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 getMethodList(Class mapperClass) {
           List 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 {
       List 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会自动更新版本号,如果版本号不一致,就会抛出异常。

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

675

2023.10.12

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

319

2023.10.27

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

345

2024.02.23

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

1084

2024.03.06

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

355

2024.03.06

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

673

2024.04.07

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

566

2024.04.29

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

409

2024.04.29

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

7

2025.12.31

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
MySQL 教程
MySQL 教程

共48课时 | 1.5万人学习

MySQL 初学入门(mosh老师)
MySQL 初学入门(mosh老师)

共3课时 | 0.3万人学习

简单聊聊mysql8与网络通信
简单聊聊mysql8与网络通信

共1课时 | 778人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号