介绍一款超级有用的开发建模工具cg

建模工具cg简介

今天给大家介绍一个很实用的开发工具cg。这是一个建模工具。主要思想是，利用java定义实体模型，然后利用freemarker语法生成各类脚本，代码和文档。

前言

1、cg 是 Code Generator 意思，原本在公司时，我把它叫Code Egg，后面为了方便，就把名字取成两个字母cg。但后来感觉cg失去了Egg的意思，那就干脆叫Code Generator了。

这个工具主要功能就是通过面向对象思想定义模型然后生产数据库脚本，后端代码，前端代码，数据库文档，接口文档等。

2、应用程序下载：直接使用mvn包管理器下载。

3、具体[使用说明]BYEAP文档

4、项目源代码地址：(github.com)openyeap/cg

注：这个工具帮助我快速完成了很多项目的开发。比如：私人资产管家 - 私人知识管家 (byeap.com) 这个网站就使用了这个工具。

如何使用

在Java项目中增加dependency依赖

<dependency>
    <groupId>ltd.fdsa</groupId>
    <artifactId>code-egg</artifactId>
    <version>1.0.5</version>
    <scope>compile</scope>
</dependency>

这主要是为了java中定义模型，并增加build plugin插件

<plugin>
    <groupId>ltd.fdsa</groupId>
    <artifactId>code-egg-maven-plugin</artifactId>
    <version>1.0.5</version>
    <executions>
        <execution>
            <goals>
                <goal>package</goal>
            </goals>
            <configuration>
            </configuration>
        </execution>
    </executions>
</plugin>

模型定义

在Java工程中使用java pojo定义实体entities（@Table）和关系relations（@Relation）。然后运行mvn package，即可在/target/project/中生成相关代码、脚本和文档。

配置定义

默认在java工程的主目录中config目录里，可以通过*.properties，*yaml自定义模型的名称，作者、版本、时间以及数据类型映射等。

模板定义

默认在java工程的主目录中的templates目录中，可以定义输入模板。默认提供文档，数据库脚本的模板。

贡献代码

git clone https://github.com/openyeap/cg

如何成为Committer

• 认领并解决2个Issue后可以获得提交者权限
• 提供6个测试用例后可以获得提交者权限
• 帮助解决5个Issue后可以获得管理员权限

代码提交规范

1. 认领Issue，Fork 本项目的仓库。

2. 新建分支，如果是加新特性，分支名格式为feature_${issue_id}，如果是修改bug，则命名为bug_${issue_id}，如果是增强，则命名为enhancement_${issue_id}。

3. 代码注释，可以参考之前的注释，新增加代码需要相应的单元测试。

4. 提交代码的Commit Message格式为#Issue的ID号\nISSUE的描述\n解决的问题描述。

5. 创建PR，然后提PR到相应的分支。

6. 检验通过的代码会及时随新版发布。