1 Star 1 Fork 1

陈伟明 / kcg

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

kcg:kaadog code generator

它能做什么

​ 支持 Mysql、Oracle、DB2、Microsoft SQL Server、GaussDB、openGauss、PostgreSQL数据中心的数据结构获取,并依托于数据结构使用 freemarker 自定义模板生成想要的目标结果,如:

  • 不同开发语言的代码(java、python、c、c++、c#、.net、php、......)
  • 静态 html 文件
  • 填充数据后的 xml、yaml、properties 文件
  • 其它类结果文件

数据中心支持情况

Mysql Oracle DB2 Microsoft SQL Server GaussDB openGauss PostgreSQL
支持 支持 计划中 支持 支持 支持 支持

kcg 主要功能

  • 多数据源支持

    可以指定多个不同数据中心的数据源

  • 多模板路径支持

    支持文件夹、jar 文件、zip 文件、gz 文件

  • 全局自定义属性内容

    当每一个模板需要使用相同的属性内容时,可以使用全局属性内容,全局属性将传递调到每一个模板中,使用 freemarker 语法进行读取

  • 转换函数配置能力

    在进行表结构获取后,可以自主配置需要转换的内置函数进行表名、字段名等一系列的转换,如果内置函数满足不了需要,可以自定义函数

  • 生成文件支持下载功能

    当执行生成时可以使用生成并下载功能,它将提供一个压缩文件并下载到本地

开始使用

Step 1: 获取工具

​ kcg 是一个 spring boot 项目,要求具备 maven 3.5+、jdk17+ 环境。

方式一:

​ 进入下载页面,【下载】 ,选择所需的版本,下载对应的压缩文件,解压后进行 Step 2

方式二:

​ 下载源代码自行编译,编译后,进行Step 2

windows 编译指令

​ cmd 命令执行器:mvn clean package install & mvn -f kcg-dashboard/pom.xml -P release clean package install -U

​ PowerShell 命令执行器: mvn clean package install ; mvn -f kcg-dashboard/pom.xml -P release clean package install -U

linux 编译指令

mvn clean package install && mvn -f kcg-dashboard/pom.xml -P release clean package install -U

下载源代码,执行 maven 编码打包命令,要求具备 maven 3.5+、jdk 1.8+ 环境。

Step 2:工具配置

​ kcg 是一个 spring boot 项目,采用 yaml 文件进行工具启动配置,可配置的内容比较丰富,可以满足日常代码生成所需的大部分自定义内容,具体参考 相关配置

Step 3:配置模板

​ kcg 内置模板本身内置丰富的模板,可以使用内置模板,也可以通过使用内置模板修改为自己的业务模板(建议),如果有能力也可以自定义业务模板,模板语法参考FreeMarker 在线手册

模板编辑完成后需要放置在配置项 kaadog.kcg.generator.template.folder-path 对应的路径下

Step 4:启动项目

方式一:

​ 下载发行版本解压直接执行启动

  • windows 双击运行或右键以管理员身份运行 bin/run.cmd
  • linux 运行 bin/run.sh

方式二:

​ 下载源代码,执行 maven 编码打包命令后,进入 kcg-dashboard/target/kcg-dashboard/kcg-dashboard

  • windows 双击运行或右键以管理员身份运行 bin/run.cmd
  • linux 运行 bin/run.sh

Step 5:访问生成地址

​ dashboard 地址:http://127.0.0.1:1666/index.html

相关配置

配置使用yaml进行配置,形式如:

kaadog:
  kcg:
    key: value

仪表盘配置采用 kaadog.kcg.dashboard 前缀,主配置项说明:

参数 描述 默认值
api-server-path 服务地址 http://127.0.0.1:1666
file-name 下载时生成的文件名称, 不需要后缀 fileName

生成器配置采用 kaadog.kcg.generator 前缀,主配置项说明:

kaadog.kcg.generator.template 模板相关配置

参数 描述 默认值
folder-path 模板存放的文件夹,可以使用绝对路径、相对路径、classpath:、jar 文件、zip 文件、gz文件
1、绝对路径使用程序可以访问到的磁盘地址
2、相对路径一般使用../../ 的形式,相对的程序运行的目录
3、classpath: 程序可以访问到的类路径,如:classpath:template ,会获取到当前类路径可访问到的template内所有的文件夹与文件
4、jar 文件指定jar文件地址,可以使用 ! 指定使用哪个文件夹作为模板文件夹,如:xxx.jar!template,获取当前 jar 中 template 文件夹中的模板
5、zip文件、gz 文件同 jar 文件处理一致
file-suffix 模板后缀,非此后缀不会进行模板读取,直接复制文件到输出文件夹 .flt
file-encoding 模板文件编码 UTF-8
out-root-folder 生成文件输出文件夹(文件夹必须存在) ../out
temp-folder-path 如果是 jar、zip 时此路径会执行解压路径(目录必须存在) 用户临时目录+/kcg/template
temp-folder-retain-day 临时生成的模板保留的天数 1

kaadog.kcg.generator.properties,自定义属性内容全局可使用,会传递调每一个模板中,使用 key=value 形式指定

kaadog.kcg.generator.data-source-configurations,数据源配置,可以指定多个数据源,配置项说明:

参数 描述 默认值
url 数据库连接字符串
username 用户名
password 密码
catalog 数据库catalog,如果数据库支持并且存在需要配置
schema 数据库schema,如果数据库支持并且存在需要配置,GaussDB、oracle需要
properties 数据库自定义属性内容,使用key=value形式指定
types 获取结构时可以获取的类型,支持 TABLE、VIEW TABLE、VIEW
table-names 可以是表名也可以是视图名称,这些表或视图来自数据源配置,按照顺序加载,后加载的会覆盖之前加载的,如果不指定会默认生成所有

kaadog.kcg.generator.transformFunction,数据转换接口配置,可以指定开启的转换函数,并进行部分函数参数配置,配置项说明:

参数 描述 默认值
class-name-camel-case-table-function.enabled 启用类名使用驼峰命名函数配置 true
class-name-camel-case-table-function.searchStrs 搜索的字符串,按照顺序搜索,设定时要注意字符串顺序 ["t_", "t", "t-", "-t-", "-"]
column-name-lower-case-column-function.enabled 启用列名称转换为小写函数配置 true
data-type-lower-case-column-function.enabled 启用数据类型转换为小写函数配置 true
field-name-camel-case-column-function.enabled 列的属性名称使用驼峰命名函数配置 true
field-name-lower-case-column-function.enabled 列的属性名称转换为小写函数配置 true
gauss-db-comment-table-function.enabled GaussDB 表备注信息获取函数配置,前提条件是数据源配置使用了 gaussDB true
table-name-lower-case-table-function.enabled 表名称转换为小写函数配置 true

kaadog.kcg.generator.dialect.types, 方言配置,实现数据库字段类型与特点语言类型的映射关系,如果不指定数据库字段映射关系默认生成为 java String 类型(应为此工具使用 Java 开发),配置项说明:

参数 描述 默认值
data-type 数据库类型
field-type 字段类型
class-name 字段类型所使用的类名,如果指定会进行 import(非内置类型需要指定)
value 默认值

kaadog.kcg.generator.dialect.types 默认值优先级最低,可以进行配置替换,如下为默认值:

data-type field-type class-name value
varchar String
varchar2 String
double double
number double
boolean Boolean Boolean.TRUE
integer int
int int
clob String
char String
datetime LocalDateTime java.time.LocalDateTime LocalDateTime.now()
date LocalDateTime java.time.LocalDateTime LocalDateTime.now()
longtext String
timestamp LocalDateTime java.time.LocalDateTime LocalDateTime.now()

内置模板

​ 内置模板使用 kaadog.kcg.generator.template.folder-path 按照 classpath 形式指定,如:

kaadog:
  kcg:
    generator:
      template:
        folder-path: classpath:template/db-structure
  1. kcg-template-db-structure:用于生成数据中心结构
  2. kcg-template-necs:用于生成 spring cloud 工程模块

roadmap

  • 完善数据中心适配
  • 开发 dashboard 仪表盘
    • 支持数据源手动维护
    • 支持动态选择要生成的表
    • 支持可以上传模板文件
    • 支持自定义表结构
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 (properties) 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.

简介

kcg:kaadog code generator 是一个易于使用、开源、支持多数据中心的代码生成器 展开 收起
Apache-2.0
取消

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/cwmchen/kcg.git
git@gitee.com:cwmchen/kcg.git
cwmchen
kcg
kcg
master

搜索帮助