/zilean

MyBatis代码生成工具

Primary LanguageJavaMIT LicenseMIT

1. 基本介绍

zilean是一款MyBatis代码生成IntelliJ IDEA plugin。旨在提高后台开发效率，减少重复编写模版代码的困扰。

2. 功能特性

  1. 生成entity、dto、vo、form、query等领域驱动模型对象。
  2. 生成mapper、dao、service、serviceImpl、Controller层模版代码。
  3. 根据配置 生成满足业务需求的模版代码。
  4. 支持生成通用mybatis(暂未实现)以及myabtis plus模版代码。
  5. 支持自定义代码模版。
  6. 保存上次代码生成配置。
  7. 支持生成kim框架模版代码。

3. 注意

  1. 暂不支持生成kotlin模版代码

  2. IntelliJ IDEA 版本需要IntelliJ IDEA 2017.3版本以上

  3. 生成的service、Controller层模版代码中使用的BeanUtils工具类，需要引入相应的依赖坐标。

    请使用如下依赖坐标(2020-10-21 最新版本为1.0.13):

    <dependency>
    <groupId>com.github.fengyuchenglun</groupId>
    <artifactId>kim-boot-util</artifactId>
    <version>最新版本</version>
</dependency>

    如果使用勾选了lombok选项，请引入lombok依赖(2020-10-21 最新版本为1.18.16)：

    <dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>最新版本</version>
    <scope>provided</scope>
</dependency>

4. 开始

1. 安装

  1. IntelliJ IDEA官方仓库安装(插件官方正在审核中，敬请期待)。

  2. IntelliJ IDEA个人仓库安装(暂未实现)。

  3. 本地jar安装

    • 插件jar包下载地址:zilean

    • IntelliJ IDEA界面操作File->Settings->Plugins，进入插件管理页面。

    • 左键点击Installed右侧的设置按钮，点击下拉列表的Install Plugin from Dist。

    • 选择Zilean插件安装jar包。

    • 重启IntelliJ IDEA。

2. 设置数据源

  1. 点击右侧的Database tab页签。

  2. 新建Data Source，选择所需要添加的数据库，填写必要的信息，测试连接是否可用，完成数据源的添加。

  3. 数据源添加成功界面如下。

3. 生成代码

  1. 鼠标点击数据源-表结构节点。

  2. 选择“Generator Code”，进入代码生成配置页面。

  3. 选择需要生成的表结构以及填写其他的配置项。

  4. 点击生成按钮，即可生成所需要的代码。

4. 保存设置

  1. 点击“生成”按钮，会把当前配置自动进行保存。
  2. 点击“重置”按钮，会清空当前界面配置。
  3. 点击"加载上一次配置",会加载上一次保存配置项。
  4. 代码配置界面默认加载会加载上一次保存配置项。

5. 自定义模版

  1. 点击IntelliJ IDEA 工具栏->"Tools"->Zilean->“导出默认模版到 .zilean”/"导出默认模版到 .idea/zilean"。
  2. 以上操作会把默认模版导出到 .zilean/templates或者.idea/zilean/templates目录下。
  3. 用户可以通过修改导出的模版，定制生成的模版代码。
  4. 插件模版加载顺序
    • .zilean/templates目录下的模版。
    • .idea/zilean/templates目录下的模版。
    • 系统默认模版。
  5. 模版说明：
    • controller.ftl controller层代码模版。
    • service.ftl service接口层代码模版。
    • service-impl.ftl service实现类层代码模版。
    • dao.ftl dao层代码模版。
    • xml.ftl mapper xml模版。
    • entity.ft entity层代码模版。
    • dto.ftl dto层代码模版。
    • vo.ftl vo层代码模版。
    • query.ftl query层代码模版。
    • form.ftl form层代码模版。

5. 感谢

本项目主要参考:

  1. batiso

  2. EasyCode

  3. kvn-code-plugin

6. 后续计划

  1. 支持生成mybatis模版代码。
  2. 支持Project项目代码结构，右键直接生成代码。
  3. 支持更多的代码生成配置项。
  4. 支持IntelliJ IDEA官方仓库、自定义IntelliJ IDEA个人仓库安装方式。
  5. 支持生成kotlin模版代码。
  6. 支持Oracle等其他数据模版代码生成。
  7. 支持生成代码日期类型的选择。
  8. 文档补充。