1 Star 2 Fork 1

jy / generate-code-plugin

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

$\color{#4285f4}{Generate}\color{#ea4335}{-}\color{#fbbc05}{Code}\color{#4285f4}{-}\color{#34a853}{Plugin}$

$\color{#ff6600}{注:resources/template下的引擎模板代码不能格式化,切记,否则会导致生成的代码格式特别乱!!!}$

$\color{#ff6600}{注:文档中的gradle或者kotlin脚本仅仅支持gradle版本范围:5.x~6.x,,7.+版本有时间会出新的支持的脚本文档说明。}$

支持gradle7+且支持kotlin DSL的版本已经更新为仓库:https://gitee.com/jiangyun/gradle-mybatis-codegen-plugin, 此仓库代码将不再维护!!!

介绍

基于gradle构建工具并支持gradle的代码生成插件,生成代码支持类型如下:

  • 数据库类型

    • mysql5.6+
    • postgresql12+
    • mariadb10+
    • h2
    • sqlite
    • mssql
    • oracle
    • db2
    • sybase
  • 支持框架及特点

    • gradle
    • maven
    • springboot
    • springmvc
    • mybatis
    • mybatis-plus
    • swagger2
    • swagger-bootstrap-ui
    • knife4j
    • EasyYApi(需要idea安装EasyYapi插件,EasyYApi插件支持导出EasyYApi发布文档和Postman离线文档,至于怎么搭建EasyYapi在线,详情问度娘)
  • 支持语言

    • java
    • kotlin
    • groovy

生成的代码,在mybatis版本中,是默认直接生成从dao层到controller层的CRUD,mybatis-plus则按照官方代码生成方式 目前暂时推荐使用创建独立的gradle文件,并在build.gradle或build.gradle.kts中引用即可。

为什么上传到maven仓库?第一次申请被拒绝了,而且也不是很熟悉发布流程,熟悉的可以考虑发布到maven仓库中。

软件架构

  1. kotlin;
  2. freemarker;
  3. gradle;
  4. druid;

idea发布本地maven仓库教程

image

使用说明

怎么直接在gradle使用可以自己琢磨一下,本文档着重教程是独立gradle脚本文件使用方式,因为可以保持build.gradle的简洁; 编译好可下载使用的包在源码中的release文件夹下 点击下载

  1. 在项目根目录下创建一个叫:generate-code.gradle 的文件,脚本内容如下:
buildscript {
  repositories {
    mavenLocal()
    maven { url 'https://maven.aliyun.com/repository/public/' }
  }
  dependencies {
    classpath 'mysql:mysql-connector-java:8.0.23'
    classpath 'org.freemarker:freemarker:2.3.31'
    classpath 'org.postgresql:postgresql:42.2.19'
    classpath 'com.alibaba:druid:1.2.8'
    classpath fileTree(dir: "${rootDir}/libs", include: ['cn-plugins-generator-1.0.8.jar']) // libs为jar包代码插件存放位置,位置可以随意放,只要配置好路径即可
  }
}

/**
 * 生成代码task
 */
task generateCode(type: cn.plugins.generator.task.GenerateCodeTask) {
  doFirst {
    dbType = "mysql" // 目前只支持mysql(5.7+)、meriaDB(对应mysql5.7+的版本)、postgresql(某个版本以上,具体版本后面会补齐说明)
    url = "localhost" // 数据库所在host
    port = "3306" // 数据库端口
    database = "test" // 数据库名称
    userName = "root" // 数据库用户名
    password = "admin123456" // 数据库密码
    frameworkType = "mybatisplus" // mybatis 或 mybatisplus
    tablePrefix = "base" // 切记不要带前缀下划线进来,如:btplatform_
    tableName = "base_user" // 多个表使用英文逗号隔开,不要留空格符
    projectPath = "/Users/admin/Desktop/project" // 此路径可以根据需求随意设置即可,只不过 projectDir.path 会定位到当前项目下
    packageName = "com.test.admin" // 顶层包
    controller = "controller" // 控制器对应的包名称
    service = "service" // 业务逻辑层service对应的包名称
    mapper = "mapper" // mybatis mapper对应的包名称
    entity = "entity" // 与数据库表字段一一对应的实体包名称
    xml = "mapper" // resources下mybatis xml所存放的位置
    languageType = "java"// java或kotlin,当frameworkType为mybatisplus时,不支持生成kotlin代码,估计以后会考虑支持
    author = "jy"//System.getProperty("user.name") // 生成的代码的顶部注释会的作者名称(默认拉取当前系统登录用户名)
    apiPrefix = "/api"// 定义的controller请求前缀,默认值:/api
    enableGenerateDoc = true // 是否生成支持swaggerUI2文档,当然前提是已经配置swaggerUI2,不然无法生效,UI可选择swaggerUI2/swagger-bootstrap-ui/knife4j
    enableGenVuePage = true // 是否生成vue crud页面代码,默认值:false
  }
}

/**
 * 生成数据库设计文档(markdown)
 */
task generateDoc(type: cn.plugins.generator.task.GenerateMarkdownTask) {
  doFirst {
    dbType = "mysql"
    url = "localhost" // 数据库所在host
    port = "3306" // 数据库端口
    database = "base" //    数据库名称
    userName = "root" // 数据库用户名
    password = "admin123456" // 数据库密码
    projectPath = "/Users/admin/Desktop/project" // 此路径可以根据需求随意设置即可,只不过 projectDir.path 会定位到当前项目下
  }
}
  1. 在工程项目中的build.gradle引用generate-code.gradle

在最外层引用即可,不要把下面的脚本随意放到别的位置!!!

apply from: 'generate-code.gradle'

想在springboot2.+的kotlin中怎么使用?目前spring官方默认给出的是使用kotlin编写DSL,不熟悉的人,就比较费劲了,文件也不再是以.gradle结束,而是.gradle.kts。 如下的脚本为kotlin编写DSL的使用方式,具体使用方式如下:

  1. 在工程目录下创建一个独立的叫generate-code.gradle.kts的文件,文件脚本内容如下:
import cn.plugins.generator.task.GenerateCodeTask
import cn.plugins.generator.task.GenerateMarkdownTask

buildscript {
  repositories {
    mavenLocal()
    maven {
      setUrl("https://maven.aliyun.com/repository/public/")
    }
  }
  dependencies {
    classpath 'mysql:mysql-connector-java:8.0.23'
    classpath 'org.freemarker:freemarker:2.3.31'
    classpath 'org.postgresql:postgresql:42.2.19'
    classpath 'com.alibaba:druid:1.2.8'
    classpath fileTree(dir: "${rootDir}/libs", include: ['cn-plugins-generator-1.0.8.jar']) // libs为jar包代码插件存放位置,位置可以随意放,只要配置好路径即可
  }
}


tasks.register<GenerateCodeTask>(name = "generateCode") {
    dbType = "mysql"// 值为mysql或postgresql 由于mariadb为mysql的分支,所以是mariadb的,此处直接填写mysql即可
    url = "localhost"
    port = "3306"
    database = "pagehelper-test"
    userName = "root"
    password = "admin1230"
    frameworkType = "mybatis" // mybatis 或 mybatisplus
    tablePrefix = "test" // 不要带前缀下划线进来
    tableName = "test_login"// 多个表使用英文逗号隔开
    projectPath = projectDir.path
    packageName = "com.example.demo"
    controller = "controller"
    service = "service"
    mapper = "mapper"
    entity = "entity"
    xml = "mapper"
    languageType = "kotlin"// java或kotlin
    author = "jy"
    company = "测试公司"
    apiPrefix = "/api"// 默认值:/api
    enableGenerateDoc = true // 是否生成支持swaggerUI2文档
}

/**
 * 生成代码task
 */
tasks.register<GenerateCodeTask>(name = "generateCode") {
  doFirst {
    dbType = "mysql" // 目前只支持mysql(5.7+)、meriaDB(对应mysql5.7+的版本)、postgresql(某个版本以上,具体版本后面会补齐说明)
    url = "localhost" // 数据库所在host
    port = "3306" // 数据库端口
    database = "test" // 数据库名称
    userName = "root" // 数据库用户名
    password = "admin123456" // 数据库密码
    frameworkType = "mybatisplus" // mybatis 或 mybatisplus
    tablePrefix = "base" // 切记不要带前缀下划线进来,如:btplatform_
    tableName = "base_user" // 多个表使用英文逗号隔开,不要留空格符
    projectPath = "/Users/admin/Desktop/project" // 此路径可以根据需求随意设置即可,只不过 projectDir.path 会定位到当前项目下
    packageName = "com.test.admin" // 顶层包
    controller = "controller" // 控制器对应的包名称
    service = "service" // 业务逻辑层service对应的包名称
    mapper = "mapper" // mybatis mapper对应的包名称
    entity = "entity" // 与数据库表字段一一对应的实体包名称
    xml = "mapper" // resources下mybatis xml所存放的位置
    languageType = "java"// java或kotlin,当frameworkType为mybatisplus时,不支持生成kotlin代码,估计以后会考虑支持
    author = "jy"//System.getProperty("user.name") // 生成的代码的顶部注释会的作者名称(默认拉取当前系统登录用户名)
    apiPrefix = "/api"// 定义的controller请求前缀,默认值:/api
    enableGenerateDoc = true // 是否生成支持swaggerUI2文档,当然前提是已经配置swaggerUI2,不然无法生效,UI可选择swaggerUI2/swagger-bootstrap-ui/knife4j
    enableGenVuePage = true // 是否生成vue crud页面代码,默认值:false
  }
}

/**
 * 生成数据库设计文档(markdown)
 */
tasks.register<GenerateMarkdownTask>(name = "generateDoc") {
  doFirst {
    dbType = "mysql"
    url = "localhost" // 数据库所在host
    port = "3306" // 数据库端口
    database = "base" //    数据库名称
    userName = "root" // 数据库用户名
    password = "admin123456" // 数据库密码
    projectPath = "/Users/admin/Desktop/project" // 此路径可以根据需求随意设置即可,只不过 projectDir.path 会定位到当前项目下
  }
}
  1. 然后在build.gradle.kts文件中引用该gradle脚本:
apply(from = "generate-code.gradle.kts") // 特殊就在这个地方,这是kotlin编写DSL的脚本,与groovy还是有区别的 groovy的为:apply from: 'generate.gradle'

生成代码或数据库设计markdown文档截图

  1. 生成代码只需运行上述的task即可 image

生成代码截图如下

  1. 生成的kotlin代码 image
  2. 生成的java代码 image
  3. 生成的mapper xml代码 image
  4. 生成markdown文档 image

参与贡献

  1. Fork 本仓库
  2. 新建 分支
  3. 提交代码
  4. 新建 Pull Request
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

代码生成插件 展开 收起
Kotlin 等 2 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Kotlin
1
https://gitee.com/jiangyun/generate-code-plugin.git
git@gitee.com:jiangyun/generate-code-plugin.git
jiangyun
generate-code-plugin
generate-code-plugin
master

搜索帮助

14c37bed 8189591 565d56ea 8189591