插件简介.md · nevercloud/CodeGenerateORM

## 写插件的原因
其实很简单，就三点：
1. 现在很多ORM生成代码的插件都是要收费的；
2. 自己想定制一点东西，现在开源出去的是比较公用的，我自己这边可能会适用于公司；
3. 提升下自己和帮助下大家；

## 插件的功能简单介绍

其实我插件主页上介绍也有一点，可以参考：
homepage：https://plugins.jetbrains.com/plugin/18891-code-generate-orm

这里在详细介绍下，配合图文；

功能大致介绍下：

> 可以帮助你快速生成基本的增删改查代码，然后对应的生成目录，是否需要生成swagger、service这些都有用户自己控制；

大致讲讲用法，有两种生成方式：

### 直接自己连接数据源生成
> 无需在idea的database里面配置，自己配置数据源连接，目前我是把入口放在不同的地方
> 1. 选中项目 -> 右键,最下面 -> ORMCodeGenerate，然后就会出来弹窗让你先配置；（mac用户不适用快捷键推荐）
> 2. Tools -> 最下面；（Windows用户不适用快捷键推荐）
> 3. control + 9，快捷键的方式是我最推荐的；

**下面就是几张操作图：参考代码里面的 “images/插件用法.png”;**
![直接连接数据源](images/插件用法.png)

这里简单介绍下那几个参数：

1. classpath：这里只会选择你当前idea最外层的项目；
2. yysimple那里，是让你输入自己项目对应的作者，也就是Javadoc里面的 @author yysimple；
3. 文件目录选择，含义很清楚，这里就不多说了，这里只是选择的生成的目录，会根据下面的选项来判断要不要生成，如果你不想生成controller可以不选择路径；
4. 数据源信息，这里自己配置数据源的方式目前只实现了MySQL，不支持其他数据源（后面会说支持的方式）；

- table name是让你数据如表面的支持like模糊查询，记住不要回车，需要点击下前面的select tables；下面就会有表格出现；
    - test conn就是给你测试下数据源能不能正常连接，会提示数据库版本；

5. 选项的含义：

- mybatisPlus：就是会帮你的类继承mybatisPlus的类；依赖需要自己引入；
    - is Create...：就是是否帮你生成Controller、Service等等，默认是会生成PO、DAO、Mapper.xml的，所以这三个文件路径必填；
    - is create dir：这个含义就是当你项目中不存在controller、service等目录时，会自动帮你创建这个目录和对应类；

6. 所有参数都具备缓存功能，只要你之前生成过，所以在选择表的时候，记得下一次把之前的清掉（不清掉因为存在也不会再次生成）
这里我也在考虑看需不需要优化下，这里直接不缓存了，因为很少有需要重新生成的情况；弄个todo，下次优化掉；

### 直接选择idea的database选中表生成

> 这个就是大多数ORM生成的方式，支持的数据源就是idea支持多少，这里就支持多少，但是这里就是每个项目都需要配置数据源，
> 所以才有了上面那种方式，当然看个人喜好，两种方式都支持了，我是mysql生成的时候比较喜欢用上面那个，我不喜欢在项目
> 里面去连接数据源，我专门开个窗口连所有数据源的（有些人还喜欢用DG，Navicat；纯看个人喜好）

操作也比较简单，但是没提供快捷键：

**操作图片在：“images/table2Orm.png”;**
![选择连接数据源](images/table2Orm.png)

> 1. 需要选中表，然后右键
> 2. 中间没有找到对应列类型，会询问你需要关联到java的什么类型；
> 3. 最后的弹窗就是上面的阉割版，功能是一样的，就不介绍了；
> 4. 这里有个小问题，你的表中必须要有主键，没有的话，mapper文件、service文件里面的方法不会帮你生成，因为有个方法是 byId的；

## 总结

1. 我的插件库：https://plugins.jetbrains.com/author/me
2. 插件地址：https://plugins.jetbrains.com/plugin/18891-code-generate-orm
3. 我的gitee：https://gitee.com/yysimple（具体是哪个仓库插件上有写）
4. 我的github：https://github.com/yysimple（这里的代码可能存在时效性，我会忘记推）
5. 有问题欢迎issue，或者发邮件给我：1449697757@qq.com

nevercloud/CodeGenerateORM

简介

发行版

贡献者

近期动态

nevercloud/CodeGenerateORM .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

nevercloud/CodeGenerateORM