idea 添加 mybatis-plus 插件

在使用 MyBatis 时,会使用到如下文件:

  1. 与数据表对应的实体类
  2. 与数据库操作相关的 mapper 接口 和 对应的 mapper xml 文件

以上的文件,相对比较简单,根据格式来填充即可。

但是,在开发过程中可能会遇到这样的情况:

  1. 当某个数据表的字段很多,多到十几个或上百个时,需要自己在创建实体类,把每个字段都要写一遍时,这“无效”的工作量就会很大;
  2. 当数据库中有几十个甚至更多的表时,需要创建的 mapper 和 mapper xml 文件也就越多,这样的“无效”工作也会很大;

我们知道,程序员是“懒惰的”,那有没有工具能自动帮我们生成数据表对应的实体类和相关的 mapper 文件呢?答案是有的:mybatis-plus

1. 在 idea 中安装 mybatis-plus 插件

打开 idea,在 File > settings > Plugins 中 Marketplace 搜索 mybatis plus,找到后点击 install 安装,如下图:

mybatis-plus

安装完成后,会提示重启 idea,重启完成后,在 idea 顶部的工具栏中就会出现 Other 菜单,如图:

mybatis-plus

2. 添加依赖

在 pom.xml 添加如下依赖:

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.2</version>
    <scope>provided</scope>
</dependency>

更新 maven

3. 使用 mybatis-plus 插件

3.1 数据库配置

点击 idea 顶部菜单栏中的 Other > Config Database, 如图:

mybatis-plus

说明

  1. dbUrl: 为要连接的数据库 url
  2. jdbcDriver: 为要连接的数据库驱动
  3. user/password: 为数据库账号和密码

以上根据实际情况进行填写,填写完成后点击 ok

3.2 配置要生成代码规则

点击 idea 顶部菜单栏中的 Other > Code Generator, 如图:

mybatis-plus

说明

  1. 第1部分显示的是数据库中的所有表信息,表可以选中;
  2. 第2部分是配置要生成哪些代码:
    1. module: 要生成的模块名称。填写的话会在项目中根据这个名称生成一个完整的项目路径;不填写的话,是在当前项目路径中新增相应的文件。
    2. package:包名称。可填写当前的包平常
    3. author:新建文件头部位置注释的作者名
    4. Entity:存放实体的包/文件夹名称
    5. Mapper:存放 mapper 的包名称
    6. Controller、Service、ServiceImpl:与 Entity一致
    7. TablePrefix:表的前缀;如果表有前缀,而在代码中不需要这个前缀名称,则在这里填写前缀名
    8. lombok:是否使用 Lombok
    9. restController:是否生成对应的 restController
    10. swagger:是否使用 swagger
      11:ResultMap:是否生成 ResultMap
    11. is base column

以上内容根据实际需要的情况进行填写配置,点击 save 按钮会保存此次的修改,下次再次打开时,会采用上次保存的结果

配置无误有,点击 code generator 生成代码,提示生成成功后,代码就在我们项目里面添加进来了,如图:

mybatis-plus

这样就非常方便了,大大增加了程序员的开发效率!

发表评论