目录

文档概述

文档说明

本文是EPPDEV-JEE代码生成系统的使用说明，主要内容包括：

参考文件

暂无

保密及知识产权要求

EPPDEV-JEE代码生成系统是由郝金隆个人开发的开源软件， 采用Anti-996 License V1.01)协议对外发布。 本文知识产权归属郝金隆个人所有，但是同样采用相同协议对外发布。 任何符合该协议的企业、团体和个人，均可在本文的基础上进行二次修改和对外分发。

下载与安装

环境准备

系统编译运行所必须的环境主要包括：

程序下载

程序下载有以下两种方式：

直接下载打包号的程序文件

本程序的正式发布地址为：https://github.com/eppdev/eppdev-jee-pom/releases， 要下载的内容文件包括：

上述两个文件下载以后，需要放到同一个文件夹下

通过源代码进行安装使用

源代码仓库位于：

任何人均可以从上述两个代码仓库下载并自行编译本系统，以github为例： 

git clone https://github.com/eppdev/eppdev-jee-pom.git
cd eppdev-jee-pom
mvn -Dmaven.test.skip=true package
注意：编译安装需要Java和Maven环境

编译完成后，需要将以下两个文件复制到同一个文件夹下：

使用前的基础配置

数据库环境准备

已有数据库环境的可以跳过此章节。若无数据库环境，则需首先需要创建一个数据库schema， 并对其进行权限配置，示例如下： 

CREATE DATABASE test_db charset utf8;
GRANT ALL privileges ON test_db.* TO 'eppdev'@localhost IDENTIFIED BY 'eppdev';
FLUSH privileges;
注：上述sql完成了test_db数据库的创建，并将其所有权限赋予了密码为eppdev的eppdev用户 具体的schema名称、用户名、密码可以根据实际需要进行修改

修改application.properties文件

根据需要修改application.properties文件，主要修改项目包括：

针对个人开发，4、5最后两项可以不在application.properties中配置，在平台启动后的界面配置即可。 但若是多人协作开发，建议每个人在自己的本地单独配置不同的作者名、工程地址， 以避免某一人修改配置后对其他人的影响

代码生成

启动代码生成程序

windows下的启动

java -jar -Dfile.encoding=UTF-8 ./eppdev-jee-web-x.y.z.jar
注：此处需通过指定file.encoding以避免生成代码的乱码问题

Linux/Mac下的启动

Linux和Mac下可以首先将下载的jar包转换为可执行程序，后续只需要直接执行即可 

chmod a+x ./eppdev-jee-web-x.y.z.jar
./eppdev-jee-web-x.y.z.jar

启动后的基础配置

系统启动后通过浏览器打开eppdev-jee-usage)， 即可访问本系统，界面如下图所示：

进入后的首页

点击顶部菜单中的初始化配置链接，即可进入初始化配置页面，进行初始化配置，如下图所示：

初始化配置页面

主要需要修改的配置包括：

更多的配置项说明，参见界面上的说明。

注：针对协作开发，建议直接在application.properties文件中修改配置eppdev.author.name， eppdev.project.path，则PROJECT_PATH、AUTHOR_NAME在web页面不起作用，以区分不同的使用者

生成基础代码

点击web页面中的工程初始化菜单，即可进入工程初始化界面，如下图所示：

工程初始化页面

在界面中可以初始化 通用代码，具体初始化内容包括：

在此页面可以选择一次性全部生成，也可以选择分类生成，还可以单个文件依次生成。

注意在生成相应的代码前，可以先预览以下具体要生成的内容，确认一些具体的代码路径，避免错误出现

库表信息配置

新增库表信息

添加库表

点击最新库表信息菜单，选择新增表按钮，即可进入库表添加库表页面，如下图所示：

新增库表页面

主要要填写的内容包括：

根据提示填写相关内容以后，点击提交按钮即可完成库表的添加，添加库表的过程中， 系统会自动创建id、createdate、createby、updatedate、updateby、del_flag、 remarks这六个技术字段

新增字段

创建完成库表成功后，页面会自动转到库表详情页面，如下图所示：

表详情页面

在此页面中可以查看并添加字段，配置库表的索引，进行代码生成，查看修订记录。 在字段列表中点击添加链接，即可进入新增字段页面，具体如下图所示：

添加字段页面

在此页面可以配置内容包括：

相关信息填写完成后，提交保存即可。

配置索引

库表详情页面，索引列表中点击添加链接，即可配置库表的索引，如下图所示：

添加索引页面

在此页面中依次选择要创建的索引字段，选择提交后即可完成索引的配置

自动加载原有库表

加载物理表

系统还可以自动读取平台已有的库表信息，在工程初始化页面点击加载最新物理表链接， 即可进入物理表加载页面，如下图所示：

加载物理表页面

在此页面可选择加载所有的物理表，也可以选择单个表进行加载。

加载后的配置

为保证加载后库表对应的代码的可用性，一般需要对每个表的信息进行配置， 主要配置内容是每个字段对应的信息，包括

库表对应的代码生成

生成对应的代码，可以采用两种模式来生成：

附录

生成的代码说明

具体会生成的内容包括：

对于每个表，之所以在Entity、Param、Dao、Service和Mapper文件都要分两个，是为了区分自动生成以后要根据数据库配置自动更新的代码文件和可以手工修改的文件。 有下划线的文件都是后续自动生成的时候要自动修改覆盖的文件，无下划线的是可以手工修改的，后续的自动代码生成不会覆盖。

历史版本修订记录

V1

2019年1月第一次正式发布，主要完成内容：

V1.1

2019年2月完成的小版本优化，主要完成内容包括：

V1.2

2019年3月完成的bugfix，主要修改内容：

V1.3

2019年5月完成的小版本升级，主要内容：

V1.4

2019年5月完成的小版本升级，主要内容：

V1.4.1

2019年5月完成的bugfix，主要内容：

V1.5

2019年8月完成的小版本升级，主要内容：

V1.6

2019年9月完成的小版本升级，主要内容：

1)
参见https://github.com/996icu/996.ICU/blob/master/LICENSE
2)
Maven仅用于编译安装使用
3)
x.y.z表示的程序的版本号，具体下载时可以下载最新的版本
4)
系统会自动将表名转换成驼峰形的Java类名，如test_table会自动对应为TestTable