快速上手MybatisPlus

最新推荐文章于 2025-06-16 14:02:23 发布
最新推荐文章于 2025-06-16 14:02:23 发布
阅读量323 收藏
点赞数
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/jgt_insect/article/details/89877738
本文详细介绍如何在SpringMVC项目中集成MyBatisPlus，包括依赖配置、代码生成器使用、配置启用流程及常见问题解答。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

首先附上mybatis-plus官方文档
本篇参考官方文档记录spring mvc项目接入mybatis plus的全流程及一些问题的解决方案，建议优先参考官方文档
开始之前，假设数据库已建好并已能正常访问

依赖配置

此处使用maven，gradle参考gradle依赖配置

核心依赖

查看最新版本

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus</artifactId>
    <version>3.1.0</version>
</dependency>

！！！注：如之前已引入mybatis相关依赖，请去除，mybatis plus会自行管理

代码生成器相关依赖

如不需要代码生成，请跳过

  • AutoGenerator 查看最新版本

    <dependency>
  <groupId>com.baomidou</groupId>
  <artifactId>mybatis-plus-generator</artifactId>
  <version>3.1.0</version>
</dependency>

  • 模版引擎，这里选择freemarker供生成器使用

    <dependency>
   <groupId>org.freemarker</groupId>
   <artifactId>freemarker</artifactId>
   <version>2.3.23</version>
</dependency>

  • lombok，使用注解代替set-get方法

    <dependency>
   <groupId>org.projectlombok</groupId>
   <artifactId>lombok</artifactId>
   <version>1.18.2</version>
   <scope>provided</scope>
</dependency>

代码生成

要使用此功能，需添加代码生成器相关依赖

代码生成器

根据官方代码改了个较为简洁方便适合懒人直接使用的生成器， 如需更多配置可查看官方生成器模版或参考文末附的全配置项自行配置

import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;


/**
 * @description: 代码生成器
 * @author: 04637@163.com
 * @date: 2019/3/3
 **/
public class CodeGenerator {

    public static void main(String[] args) {
        // ================= 必须修改的配置 start =================

        // 数据源配置
        String jdbcUrl = "jdbc:mysql://localhost:3306/deva?serverTimezone=Asia/Shanghai&useUnicode=true&useSSL=false&characterEncoding=utf8";
        String jdbcDriver = "com.mysql.cj.jdbc.Driver";
        String jdbcUsername = "root";
        String jdbcPassword = "123456";

        // 父级包名配置
        String parentPackage = "com.ty.mp";

        // 生成代码的 @author 值
        String author = "04637@163.com";

        // 要生成代码的表名配置
        String[] tables = {
                "question_info",
                "answer_info",
                "message_info",
        };

        // ================= 必须修改的配置 end =================




        AutoGenerator mpg = new AutoGenerator();
        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor(author);
        gc.setBaseResultMap(true);
        gc.setBaseColumnList(true);
        // 生成完毕后是否打开输出目录
        gc.setOpen(false);
        // 为true时生成entity将继承Model类，单类即可完成基于单表的业务逻辑操作，按需开启
        gc.setActiveRecord(false);
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl(jdbcUrl);
        dsc.setDriverName(jdbcDriver);
        dsc.setUsername(jdbcUsername);
        dsc.setPassword(jdbcPassword);
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        // 父级包名，按需修改
        pc.setParent(parentPackage);
        // 设置模块名, 会在parent包下生成一个指定的模块包
        pc.setModuleName(null);
        mpg.setPackageInfo(pc);


        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setRestControllerStyle(false);
        strategy.setInclude(tables);
        strategy.setSuperEntityColumns("id");
        // Controller驼峰连字符，如开启，则requestMapping由 helloWorld 变为 hello-world 默认false
        strategy.setControllerMappingHyphenStyle(false);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        // 开启后将使用lombok注解代替set-get方法，false则生成set-get方法
        strategy.setEntityLombokModel(true);
        // 在实体类中移除is前缀
        strategy.setEntityBooleanColumnRemoveIsPrefix(true);
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }

}

执行后会生成这些文件

16817462-304b92c5205f59a4
生成结果

可将生成的xml放到resources目录或者配置xml目录为resource目录方便扫描

配置启用mybatis-plus

mapperScanner配置

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
    <property name="basePackage" value="你的mapper目录"/>
</bean>

sqlSessionFactory配置

<bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
    <property name="dataSource" ref="dataSource"/>
    <property name="mapperLocations" value="mapper xml的资源路径"/>
</bean>

CRUD接口

mapper CRUD接口

生成的mapper接口会继承BaseMapper接口，查看mapper CRUD接口支持的操作

service CRUD接口

生成的service接口会继承 IService接口，查看service CRUD接口支持的操作

条件构造器

QueryWrapper<TagInfo> queryWrapper = new QueryWrapper<>();
queryWrapper.eq("uk_name", tagName);
TagInfo newTag = tagInfoMapper.selectOne(queryWrapper);

查看条件构造器所有条件写法

分页插件

待更新

问题记录及解决

生成的@Data @Accessors等注解是什么意思？

  • 有了@Data注解就无需再写那些get set方法了
  • @Accessors(chain = true) chain为true时，set方法会return该对象，false时则return void
  • @EqualsAndHashCode(callSuper = false) 会自动生成equals 和 hashCode方法，callSuper = false时不会用super的equals比较

已经有了@Data注解，却不能调用set get方法？

需要安装插件 IDEA为例：
File->settings->Plugins 查找lombok plugin安装

待更新

附：生成器全配置项

GlobalConfig 全局配置项

```
/**
 * 生成文件的输出目录【默认 D 盘根目录】
 */
private String outputDir = "D://";

/**
 * 是否覆盖已有文件
 */
private boolean fileOverride = false;

/**
 * 是否打开输出目录
 */
private boolean open = true;

/**
 * 是否在xml中添加二级缓存配置
 */
private boolean enableCache = false;

/**
 * 开发人员
 */
private String author;

/**
 * 开启 Kotlin 模式
 */
private boolean kotlin = false;

/**
 * 开启 swagger2 模式
 */
private boolean swagger2 = false;

/**
 * 开启 ActiveRecord 模式
 */
private boolean activeRecord = false;

/**
 * 开启 BaseResultMap
 */
private boolean baseResultMap = false;

/**
 * 时间类型对应策略
 */
private DateType dateType = DateType.TIME_PACK;

/**
 * 开启 baseColumnList
 */
private boolean baseColumnList = false;
/**
 * 各层文件名称方式，例如： %sAction 生成 UserAction
 * %s 为占位符
 */
private String entityName;
private String mapperName;
private String xmlName;
private String serviceName;
private String serviceImplName;
private String controllerName;
/**
 * 指定生成的主键的ID类型
 */
private IdType idType;
```

StrategyConfig策略配置项

```
/**
 * 是否大写命名
 */
private boolean isCapitalMode = false;
/**
 * 是否跳过视图
 */
private boolean skipView = false;
/**
 * 数据库表映射到实体的命名策略
 */
private NamingStrategy naming = NamingStrategy.no_change;
/**
 * 数据库表字段映射到实体的命名策略
 * <p>未指定按照 naming 执行</p>
 */
private NamingStrategy columnNaming = null;
/**
 * 表前缀
 */
@Setter(AccessLevel.NONE)
private String[] tablePrefix;
/**
 * 字段前缀
 */
@Setter(AccessLevel.NONE)
private String[] fieldPrefix;
/**
 * 自定义继承的Entity类全称，带包名
 */
@Setter(AccessLevel.NONE)
private String superEntityClass;
/**
 * 自定义基础的Entity类，公共字段
 */
@Setter(AccessLevel.NONE)
private String[] superEntityColumns;
/**
 * 自定义继承的Mapper类全称，带包名
 */
private String superMapperClass = ConstVal.SUPER_MAPPER_CLASS;
/**
 * 自定义继承的Service类全称，带包名
 */
private String superServiceClass = ConstVal.SUPER_SERVICE_CLASS;
/**
 * 自定义继承的ServiceImpl类全称，带包名
 */
private String superServiceImplClass = ConstVal.SUPER_SERVICE_IMPL_CLASS;
/**
 * 自定义继承的Controller类全称，带包名
 */
private String superControllerClass;
/**
 * 需要包含的表名，允许正则表达式（与exclude二选一配置）
 */
@Setter(AccessLevel.NONE)
private String[] include = null;
/**
 * 需要排除的表名，允许正则表达式
 */
@Setter(AccessLevel.NONE)
private String[] exclude = null;
/**
 * 【实体】是否生成字段常量（默认 false）<br>
 * -----------------------------------<br>
 * public static final String ID = "test_id";
 */
private boolean entityColumnConstant = false;
/**
 * 【实体】是否为构建者模型（默认 false）<br>
 * -----------------------------------<br>
 * public User setName(String name) { this.name = name; return this; }
 */
private boolean entityBuilderModel = false;
/**
 * 【实体】是否为lombok模型（默认 false）<br>
 * <a href="https://projectlombok.org/">document</a>
 */
private boolean entityLombokModel = false;
/**
 * Boolean类型字段是否移除is前缀（默认 false）<br>
 * 比如 : 数据库字段名称 : 'is_xxx',类型为 : tinyint. 在映射实体的时候则会去掉is,在实体类中映射最终结果为 xxx
 */
private boolean entityBooleanColumnRemoveIsPrefix = false;
/**
 * 生成 <code>@RestController</code> 控制器
 * <pre>
 *      <code>@Controller</code> -> <code>@RestController</code>
 * </pre>
 */
private boolean restControllerStyle = false;
/**
 * 驼峰转连字符
 * <pre>
 *      <code>@RequestMapping("/managerUserActionHistory")</code> -> <code>@RequestMapping("/manager-user-action-history")</code>
 * </pre>
 */
private boolean controllerMappingHyphenStyle = false;
/**
 * 是否生成实体时，生成字段注解
 */
private boolean entityTableFieldAnnotationEnable = false;
/**
 * 乐观锁属性名称
 */
private String versionFieldName;
/**
 * 逻辑删除属性名称
 */
private String logicDeleteFieldName;
/**
 * 表填充字段
 */
private List<TableFill> tableFillList = null;
```
MybatisPlus深入浅出教程 快速上手Mybatis-Plus！！！
9.冄2.7.號的博客
09-23 573
文章目录1、了解Mybatis-PlusMybatis-Plus介绍代码以及文档特性架构作者2、快速开始创建数据库以及表创建工程导入依赖Mybatis + MP创建子ModuleMybatis实现查询User第一步，编写 mybatis-config.xml 文件第二步，编写User实体对象（这里使用lombok进行了进化bean操作）第三步，编写UserMapper接口第四步，编写UserMapper.xml文件第五步，编写TestMybatis测试用例Mybatis+MP实现查询User第一步，将Use
MybatisPlus快速上手1——MybatisPlus插件的介绍和整合
卓汶的博客
09-24 829
(opens new window)（简称 MP）是一个 MyBatis (opens new window)的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。
MyBatis-Plus快速上手
matexiang的博客
11-15 1552
本篇教大家如何配置MyBatis-Plus并且能快速上手应用起来
快速上手mybatis plus
早起的虫儿@04637
03-15 1248
目录序依赖配置核心依赖代码生成器相关依赖代码生成代码生成器CRUD接口mapper CRUD接口service CRUD接口配置启用mybatis-plusmapperScanner配置sqlSessionFactory配置附：生成器全配置项 序 首先附上mybatis-plus官方文档 本篇参考官方文档记录spring mvc项目接入mybatis plus的全流程及一些问题的解决方案，建议优先...
Mybatis-Plus快速上手：配置与插件全指南
最新发布
2201_75411271的博客
06-16 697
摘要：本文介绍了Mybatis-Plus3.0的基本配置和使用要点。首先说明需要JDK8+环境，其次讲解SpringBoot基础配置方式。重点解析了包别名配置、ID生成策略（推荐ASSIGN_ID雪花算法）及数据库字段映射转换。详细讲解了插件机制原理，包括分页插件（IPage/Page使用）和乐观锁插件（需@Version注解）的实现方式。文章还分享了作者作为大三实习生的学习心得，旨在帮助开发者快速掌握Mybatis-Plus简化开发的技巧，提高编码效率。全文兼顾技术细节与实践指导，适合Mybatis-Pl
mybatis-plus快速上手
qq_51705526的博客
03-12 1562
快速入门 官网文档也有入门介绍，如果有耐心和一定基础的小伙伴可以直接看官网传送门 准备依赖 1.mybatis-plus依赖 <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.4.3</versio
MybatisPlus快速上手
m0_46266496的博客
05-18 815
MybatisPlus
快速入门MyBatisPlus，面试必备技术，UserMapper接口基础教程
在实际开发中，MyBatisPlus快速入门可以帮助开发人员快速上手MyBatisPlus，省去了繁琐的配置和开发流程，提高了开发效率。通过继承BaseMapper基本类，可以直接使用CRUD方法，而不需要手动编写SQL语句，大大简化了...
MybatisPlus-快速上手
Reckless_hrl的博客
07-27 195
快速上手mybatis-plus
【Mybatis Plus】Mybatis Plus_快速上手
2301_77431942的博客
08-08 6229
Mybatis-plus简介：Mybatis增强工具，只做增强，不作改变，简化开发，提高效率。所以MP使用crud、本身是无性能损耗的。无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑强大的 CRUD 操作：内置通用 Mapper、通用 Service，提供了大量的通用的CRUD方法，因此可以省去大量手写sql的语句的工作。条件构造器：提供了强大的条件构造器，可以构造各种复杂的查询条件，以应对各种复杂查询。内置分页插件。
MybatisPlus快速入门上手
qq_46041588的博客
09-18 380
快速实操上手mybatisPlus
快速上手MyBatisPlus(详细)
weixin_49133806的博客
03-26 1870
快速上手MyBatisPlus(详细)
Mybatis-plus——快速上手完整实例
DK_ing的博客
05-08 847
Mybatis-plus 概要 今天发现公司在用mp（Mybatis-plus），于是想借这个机会，了解一下这个号称与Mybatis的关系就像魂斗罗中1p、2p关系的框架。 快速上手 想要了解一个新的框架，首先是要学会使用，这里先上快速上手，后面随着使用，扩展，慢慢深入，最终到其源码的分析。下面进入正题 <!-- 先上依赖 --> <dependencies> <!-- spring-boot的启动依赖 --> <dependency...
MyBatis-Plus快速入门
南 阳 的博客
02-22 2132
总的来说，MybatisPlus凭借其强大的功能集与简洁的API设计，已经成为众多Java项目首选的持久层框架之一。无论是对于简化日常开发工作，还是提升系统的稳定性和可维护性，MybatisPlus都展现出了显著的优势。随着技术的不断迭代和发展，MybatisPlus将继续为Java开发者带来更加智能、高效的数据库操作体验。让我们共同期待和挖掘这一框架更多的可能性和潜力。
springboot+mybatisplus快速上手写接口
03-20
### SpringBoot 和 MyBatis-Plus 快速入门 #### 项目依赖引入 为了快速使用 Spring Boot 和 MyBatis-Plus 开发接口，首先需要在项目的 `pom.xml` 文件中引入必要的依赖项。以下是常用的 Maven 配置： ```xml <dependencies> <!-- Spring Boot Starter Web --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!-- MyBatis Plus Starter --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.5.1</version> </dependency> <!-- MySQL Driver --> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <scope>runtime</scope> </dependency> <!-- Lombok (可选, 自动生成getter/setter等方法) --> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency> </dependencies> ``` 以上配置包含了 Spring Boot 的基础功能模块、MyBatis-Plus 增强工具包以及数据库驱动程序[^1]。 --- #### 数据库连接配置 在 `application.yml` 或 `application.properties` 中完成数据库的连接设置。以下是一个典型的 YAML 配置示例： ```yaml spring: datasource: url: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC username: root password: 123456 driver-class-name: com.mysql.cj.jdbc.Driver mybatis-plus: mapper-locations: classpath*:mapper/*.xml # 自定义 Mapper XML 文件路径 configuration: log-impl: org.apache.ibatis.logging.stdout.StdOutImpl # 打印 SQL 日志 ``` 上述配置指定了数据库 URL、用户名、密码以及其他参数，并设置了 MyBatis-Plus 的 Mapper 文件位置和日志打印方式[^3]。 --- #### 创建实体类 假设有一个名为 `User` 的表，其字段包括 `id`, `name`, 和 `age`。对应的 Java 实体类如下所示： ```java import com.baomidou.mybatisplus.annotation.TableField; import com.baomidou.mybatisplus.annotation.TableName; @TableName("user") // 映射到 user 表 public class User { @TableField(value = "id", exist = true) private Long id; @TableField(value = "name", exist = true) private String name; @TableField(value = "age", exist = true) private Integer age; // Getter 和 Setter 方法省略（如果使用 Lombok，则无需手动编写） } ``` 通过注解的方式将实体类映射至数据库中的对应表格。 --- #### 定义 Mapper 接口 创建一个继承自 `BaseMapper<T>` 的 Mapper 接口即可获得基本 CRUD 功能的支持： ```java import com.baomidou.mybatisplus.core.mapper.BaseMapper; public interface UserMapper extends BaseMapper<User> { // 可在此扩展其他查询方法 } ``` 由于 MyBatis-Plus 提供了通用 Mapper 支持，因此不需要额外实现该接口的方法就可以直接调用内置的功能[^2]。 --- #### Service 层设计 通常会封装一层服务来处理业务逻辑。这里可以通过集成 `IService<T>` 来减少重复代码量： ```java @Service public class UserService implements IService<User> { @Autowired private UserMapper userMapper; public List<User> getAllUsers() { return userMapper.selectList(null); // 查询所有记录 } public boolean addUser(User user) { return userMapper.insert(user) > 0; // 插入新用户 } } ``` 此部分实现了简单的增删改查操作，其中利用了 MyBatis-Plus 提供的基础 API 进行交互。 --- #### 控制器层开发 最后一步是在控制器中暴露 RESTful 风格的 HTTP 请求入口点： ```java @RestController @RequestMapping("/users") public class UserController { @Autowired private UserService userService; @GetMapping("") public ResponseEntity<List<User>> getUsers() { List<User> users = userService.getAllUsers(); return ResponseEntity.ok(users); } @PostMapping("") public ResponseEntity<String> createUser(@RequestBody User user) { if (userService.addUser(user)) { return ResponseEntity.status(HttpStatus.CREATED).body("User created successfully."); } else { return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("Failed to create user."); } } } ``` 这段代码展示了如何基于前面的服务构建对外公开的 API 路径。 --- #### 测试运行效果 启动应用程序之后访问 `/users` 地址能够获取全部用户的列表；发送 POST 请求携带 JSON 格式的请求体会新增一条新的用户数据条目。 ---
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值