MyBatis好帮手，一款功能强大的IDEA插件，帮你节省90%代码量

╰+哭是因爲堅強的太久メ 2024-04-07 13:29 72阅读 0赞

## MyBatis好帮手，一款功能强大的IDEA插件，帮你节省90%代码量 ##

### 下载安装 ###

###### 地址： ######

> https://github.com/gejun123456/MyBatisCodeHelper-Pro

###### 安装 ######

Intellij最新插件`MybatisCodeHelper-2.8.1-191-201`，使用方法IDEA顶部菜单：`Tools -> MybatisCodeHelper -> Activation -> OfflineActivation`，在`offline key`框输入任意字符串

![图片][292cb67dd18799c74ef29123ac7c861b.png]

###### 配置 ######

数据库用的tinyInt 或者 smallInt生成java类型是 byte 和 short 两种类型。在java代码里面操作 byte 和 short 类型比较麻烦，经常需要强制转换，下面是设置使用Integer 来替代byte和short还有使用Java8的日期时间类型

![图片][c0bee342a65cb1ff41ae24817c7081a3.png]

### 使用 ###

###### Maven依赖 ######

创建Maven项目，为保证生成的代码不出错误提示，导入依赖：

<dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis</artifactId>
      <version>3.5.4</version>
    </dependency>
    
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.18.10</version>
    </dependency>
    
    <dependency>
      <groupId>com.github.pagehelper</groupId>
      <artifactId>pagehelper</artifactId>
      <version>5.1.11</version>
    </dependency>
    
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>5.2.1.RELEASE</version>
    </dependency>

###### 根据实体类生成建表sql ######

按alt+insert

![图片][b2bca564f6346ef6d1efac20f80e0171.png]

![图片][d3a6f42aa5aef855a40f725ca167b44c.png]生成的SQL语句：

![图片][0897e7d95956dd74ccf0b1d2120bcc75.png]生成好了建表语句后，到数据库中执行， 然后从数据库来生成crud代码

###### 根据表生成Bean、Dao+mapper和Service ######

第一步：在Intellij中连接上MySQL数据库，在指定的表上右键

![图片][181f7e1d3110a0beeab67942aaa4c151.png]第二步：配置生成信息

![图片][53ff127105c1d2bd95e37933e26f0073.png]说明：

exampleQuery：会生成一大堆的example文件，xml中的example代码看起来也很乱、建议使用方法名生成sql来替代。

不推荐mapper接口做继承，所以baseClass选项也不要选。现在代码都是自动生成的，mapper做继承仅能减少一些代码量，效率提升不明显。搞了继承后，看mapper接口对应的xml也变得比较麻烦，哪些方法要放到继承里面也比较难定义，有可能某些接口继承的方法根本用不到。建议是每个接口只生成自己需要的xml方法。

`-generatedComments`选项建议选中，不然会出现如下所示的提示

![图片][c870e7f641bd3a9ef450c18280e17b42.png]第三步：查看各个生成的目录

![图片][fc1c15afd24122b71e7f606682603af3.png]

###### 根据接口中的方法名生成对应的mapper ######

只需要一个方法名，不需要参数和返回值，输入方法名后，按`alt+enter–Generate mybatis sql` 就可以生成了。扩展：[最全的java面试题库][java]

![图片][6b9da5c7748a0fd3ae5fc105bfb76553.gif]方法名生成sql时支持if test

![图片][4bf4b91f57988303aab3053a653a14a8.gif]

###### 一键添加@param注解 ######

按alt+enter

![图片][61fc86e8b414e08913a07952f866b515.png]结果：

![图片][37f3eed3a487a021541a529064541e19.png]

###### 生成mapper映射文件中resultMap未使用的字段 ######

光标放到resultmap标签type属性值上 -> `alt + enter -> generate unUsed properties`

![图片][9d31de0926c51621774873f5ef639270.png]结果：

![图片][a6f396ab3a8482b78c688e7ea18bc4cc.png]

###### 根据mapper接口生成mapper映射文件 ######

创建一个接口 -> 光标放到接口名上 -> a`lt + enter -> generate mybatis mapper for current class` \-> 选择mapper映射文件位置

![图片][4c86905a269a710ac3cb92f2e4db1105.png]

###### 生成find方法 ######

根据方法名 直接生成sql代码 方法名有自动提示 单表操作的代码只有写个方法名就好了

find方法

![图片][6b1a41b5dc4aa2441a58d0eaade13fa3.gif]

###### 生成update方法 ######

![图片][ee5caa956c71c3dd25025b6c34bdd237.gif]

###### 生成delete方法 ######

![图片][71a626903bd6a896d0f4bd645232ee79.gif]

###### 生成count方法 ######

![图片][a50bbd99b36c56393ebcea1e24c4eed9.gif]

###### 生成测试用例 ######

![图片][e9f0ce3d5ec1bd39a45e5dc8f9a15fd8.png]

###### 生成分页查询 （依赖于 pageHelper) ######

![图片][da9a94e5babea0db378d6412f3d1c5dd.png]

![图片][fb6f964e28e4952e136945a8ba169eef.png]在`DeptServiceImpl`类中就可以查看到刚才生成的带有分页功能的代码。扩展：[最全的java面试题库][java]

###### 从表数据导出java insert语句 ######

可用于快速构造测试数据

![图片][94523b66e7ed9af7b7c1bffb4a9fe56a.gif]

### Dao中方法名的规则 ###

###### find方法 ######

可以使用 `select query get` 替代find开头，支持`orderBy,distinct, findFirst`

![图片][67c6a806c7b12dc0e91ad8f23d37689c.png]

###### update方法 ######

可以使用modify替代update开头

![图片][3c2a005cf0a890e1a861123e4bf531f2.png]

###### delete方法 ######

可以使用remove替代delete开头

![图片][a04e2f63f2ae7329a58bbcb7fb2ba691.png]

###### count方法 ######

支持distinct

![图片][18e7b864649f1507c6e5d1b50e4232af.png]

### 生成不基于Spring的单元测试 ###

光标定位在Mapper中待生成测试方法的方法声明上按快捷键alt+enter

![图片][5bddb62b644ebefe98bd9b2188624571.png]最终生成的测试代码：

public class DaShangMapperTest {
        private static DaShangMapper mapper;
    
        @BeforeEach
        public static void setUpMybatisDatabase() {
            SqlSessionFactory builder = new SqlSessionFactoryBuilder().build(DaShangMapperTest.class.getClassLoader().getResourceAsStream("mybatisTestConfiguration/DaShangMapperTestConfiguration.xml"));
            //you can use builder.openSession(false) to not commit to database
            mapper = builder.getConfiguration().getMapper(DaShangMapper.class, builder.openSession(true));
        }
    
        @Test
        public void testInsertDaShang() throws FileNotFoundException {
            mapper.insertDaShang();
        }
    }

### 使用小技巧 ###

###### 查看字段 ######

在mapper.xml文件的字段中按着ctrl键，单击字段，会自动跳转表表的字段中，方便查看各字段的含义：

![图片][795ed4d146f221379880c97d6ec7a204.gif]

###### 根据实体类生成sql文件 ######

创建一个实体类，在实体类上右键-generate

![图片][936873e310b1d9cb5188c8302f5671d6.png]选择`generte mybatis files`

![图片][b16b898f51a78cffb744ad3d1b81d07c.png]

![图片][8d4d52c78dc6be0e485091791d5ea7db.png]其中：

*  unique：唯一索引，不可重复；
 *  index：普通索引，可重复；

体类上右键-generate

\[外链图片转存中…(img-W6hW2TFv-1662429075932)\]选择`generte mybatis files`

\[外链图片转存中…(img-8TtO8L4B-1662429075932)\]

\[外链图片转存中…(img-aTFjaqB3-1662429075933)\]其中：

*  unique：唯一索引，不可重复；
 *  index：普通索引，可重复；

有了表之后就可以创建mapper、mapper.xml、service、serviceImpl了

[292cb67dd18799c74ef29123ac7c861b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/56620ee646c7442b85f537f920b1c7cc.png
[c0bee342a65cb1ff41ae24817c7081a3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/b888e6246d6b4d1cab8e1f59728600ab.png
[b2bca564f6346ef6d1efac20f80e0171.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/2a13ea1907844837b2f1bba3ee8a566f.png
[d3a6f42aa5aef855a40f725ca167b44c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/5d45f7b092994ce1bb1432d4bdaac93a.png
[0897e7d95956dd74ccf0b1d2120bcc75.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/f8374d738aee420992b0b61cd83d89b7.png
[181f7e1d3110a0beeab67942aaa4c151.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/351a2e926146411eb95481b0e02c53f7.png
[53ff127105c1d2bd95e37933e26f0073.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/3f3b3af375af456f85c3a21cc546de05.png
[c870e7f641bd3a9ef450c18280e17b42.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/6d1f2659e20e428d831942d219223609.png
[fc1c15afd24122b71e7f606682603af3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/998b76568cf5487aa6c0421eccfad016.png
[java]: http://mp.weixin.qq.com/s?__biz=MzIyNDU2ODA4OQ==&mid=2247494250&idx=2&sn=957a5eb085292fb716d5b7db6f8a8628&chksm=e80e5c1cdf79d50adce9e6266562ad1e283a5997b7f3b21f3c394d20819080c2f34aea7b8eaa&scene=21#wechat_redirect
[6b9da5c7748a0fd3ae5fc105bfb76553.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/40d08369cb6942899a2f11f8e50cd315.gif
[4bf4b91f57988303aab3053a653a14a8.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/d6e365d915ad4eca85b60ed737827422.gif
[61fc86e8b414e08913a07952f866b515.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/d37777fe162843568f89718ef848efaa.png
[37f3eed3a487a021541a529064541e19.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/b7da1f5193f94246aa07eccb4aadd8b1.png
[9d31de0926c51621774873f5ef639270.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/58e652ee964e4571b4d33cd550a32532.png
[a6f396ab3a8482b78c688e7ea18bc4cc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/6abf7b684e474bd8b417b3bfbf41c9c3.png
[4c86905a269a710ac3cb92f2e4db1105.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/5ed77562c9f6475e92415fc1eed02bb5.png
[6b1a41b5dc4aa2441a58d0eaade13fa3.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/bf984b79ea584083958ee4dac012baf5.gif
[ee5caa956c71c3dd25025b6c34bdd237.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/c6afaf0f2df8488f89d4e9a0dbb8deb7.gif
[71a626903bd6a896d0f4bd645232ee79.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/284f9dd5804a428e80c25f5cc8ff7ae2.gif
[a50bbd99b36c56393ebcea1e24c4eed9.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/82cc72864e8f46948f02ed0544f393f3.gif
[e9f0ce3d5ec1bd39a45e5dc8f9a15fd8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/6ceced2fc81741f3a2bd45445a92db9a.png
[da9a94e5babea0db378d6412f3d1c5dd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/96e7d04e26704991b6e703688c4d7123.png
[fb6f964e28e4952e136945a8ba169eef.png]: https://img-blog.csdnimg.cn/img_convert/fb6f964e28e4952e136945a8ba169eef.png
[94523b66e7ed9af7b7c1bffb4a9fe56a.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/927a2cd8733f4f6eaaea0caee0d40411.gif
[67c6a806c7b12dc0e91ad8f23d37689c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/1abc755c8db24fb0aead3efa4102ec73.png
[3c2a005cf0a890e1a861123e4bf531f2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/96c30cb108e844c9bedf751978cc4218.png
[a04e2f63f2ae7329a58bbcb7fb2ba691.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/6b9b1bfc793c4e93956c3e68b96221e4.png
[18e7b864649f1507c6e5d1b50e4232af.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/51578f1fdda9429fbd242c64e7df4288.png
[5bddb62b644ebefe98bd9b2188624571.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/132483d818114bb0a8f7ade513d6dbcf.png
[795ed4d146f221379880c97d6ec7a204.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/9479455d6d9e4b649fce1f7db33b6ad9.gif
[936873e310b1d9cb5188c8302f5671d6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/988f31b0055045d696041ac58e811f70.png
[b16b898f51a78cffb744ad3d1b81d07c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/9c33dda70ed84a699e275921bf50bce2.png
[8d4d52c78dc6be0e485091791d5ea7db.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/07/91845939bc6b42c3af11c15249a7e6f6.png