这个一个代码生成工具, 通过 数据库(mysql/oracle)表 生成 MVC 层模块代码, 大幅提高后端开发效率的实用工具
在Java后台开发过程中, 基本上都会与数据库进行交互, 而如果每个数据表都对应了后台的一套增删改查, 那么开发量还是比较大和枯燥的
赶紧解放你的双手去做更有意思的事情吧!
最初的设想只是为了把 数据表 映射为 Java实体来提高开发效率; 后来发现, 好多模块其实都是大同小异的增删改查, 那么就可以给当前的框架定制一套模板
比如常用的组合框架:SSM(Spring + SpringMVC + Mybatis)
Controller: 模块控制器Service: 模块接口ServiceImpl: 模块实现Dao: 模块数据库接口DaoImpl: 模块数据库实现Mybatis xml: 模块对应的 mybatis xml 文件, sql语句就放这里了Jsp: 列表展示页面, 增加/修改页面
因为每个系统都有自己的一套框架, 所以第一次的模板配置会比较麻烦, 不过之后就好了, 也就是一次性的工作.
此工具比较适合 Java老鸟，对 Freemarker 语法有一定了解最好，另外如果此工具满足不了你的特殊需求时，你也可以考虑进行改造，比如页面其实也是可以做出模版的
- 项目源码clone到本地
- 使用IDE打开项目 推荐：
Intelliji IDEA或者Eclipse - 打开
resources/config.json配置文件, 修改mysql配置; 其他选项按自己需求修改 数据数连接(Mysql/Oracle)，根据url自动识别 (测试的SQL文件resources/test.sql) - 程序入口
com.xu3352.builder.Builder.main(), 直接执行运行即可 - 生成的代码在
target文件夹下可以看到 - 改造自己的模板, 生成专属代码
| 项目 | 说明 | 示例 ｜ |
|---|---|---|
project |
全局变量；可以在 mappings.dir 里使用；全部的模板文件(.ftl)里都可以使用，以 ${project} 方式嵌入 |
如：mars, com.domain.other |
alias |
全局变量；使用作用域同project一样，作为project的补充 |
如：littlemars |
author |
全局变量；作者名称 | 如Java注释里加上：xuyl |
dbConfig.driverClass |
数据库驱动 | 默认为Mysql的驱动，oracle为:oracle.jdbc.driver.OracleDriver |
dbConfig.username |
数据库账号 | |
dbConfig.password |
数据库密码 | |
dbConfig.dbName |
数据库名 | 作用域为所有的模版文件，sql生成时会用到 |
dbConfig.url |
数据库连接 | |
ignorePrefix |
表名转换为Java驼峰式命名时忽略的前缀，多个以英文逗号 , 分隔开 |
ignorePrefix 值如果为：t_ 时，表名 t_test_table 转换为类名时则是：TestTable |
tableExcludesRegex |
去除表的正则 | 匹配的表名都将剔除掉 |
tableIncludesRegex |
包含表的正则 | 只有匹配的表才可以保留下来 |
templateDir |
自定义模板根目录 | resources/template/ssm_cms/ |
mappings.template |
对应根目录下的模板文件名 | 比如POJO对应的模版：service.ftl |
mappings.output_path |
更加直观的表示输出路径(Java源文件路径) | 支持 ${project}, ${alias}, ${class_name}, ${instance} 这4个变量; 比如POJO对应的模版：${project}/web/${alias}/${class_name}Action.java |
class_name 和 instance 区别
${class_name}- 类名:由表名生成(配了前缀会自动去掉), 驼峰式, 首字母大写${instance}- 实体名:类名对应的实体名,${class_name}首字母小写
首先可以自己定义自己的模板文件，熟悉 Freemarker 语法的就轻车熟路了，支持迭代数据，格式化，简单的运算之类的
目前只针对 resources/template/ssm_cms 这套模板进行维护, 另外2套可能会有点小问题, 不再进行维护了!
模板里已支持使用的Freemarker参数:
project- 字符串，config.json里配置的alias- 字符串，类似projectauthor- 字符串，作者名dbName- 字符串，数据库名，生成sql语句时有时会用到package_path- Java类的包名(package)，每个java类都会有自己的包名，而这个包名就是类所在的文件目录的路径名，其实正好就是/斜杠换成.就可以了table_name- 表名，数据库查下到的table_column- 表对于的所有字段列表集合（数组）; 每个元素包含的字段:type, name, nameJ, remark; 请参考:com.xu3352.core.Columnclass_name- 类名，由表名根据规则（去掉前缀,Java驼峰式写法，下划线删掉，首字母大些）生成instance- 类对于的实例名，也就是类名首字母小写sysDate- 当前系统日期hasDateColumn- 字段中是否包含有日期格式的字段
├── README.md
├── lib
│ ├── freemarker-2.3.15.jar // 代码生成
│ ├── gson-2.2.2.jar // config.json 配置文件解析
│ ├── mysql-connector-java-5.1.12-bin.jar // mysql连库
│ └── ojdbc5.jar // oracle连库
├── resources
│ ├── config.json // 核心配置文件
│ ├── test.sql // 测试SQL
│ └── template // 自定义模板根目录
│ └── ssm_cms // 一套自定义模板，路径在config.json里指定 "templateDir" : "resources/template/ssm_cms/"
│ ├── action.ftl
│ ├── dao.ftl
│ ├── dao_impl.ftl
│ ├── jsp_list.ftl
│ ├── jsp_modify.ftl
│ ├── mybatis.ftl
│ ├── page.ftl
│ ├── pojo.ftl
│ ├── service.ftl
│ └── service_impl.ftl
└── src
└── com
└── xu3352
├── builder
│ └── Builder.java // 工具的入口，直接执行 main 函数即可
├── config // 配置文件解析相关的实体类
│ ├── DbConfig.java
│ ├── Group.java
│ ├── SetupConfig.java
│ └── TemplateMapping.java
├── core // 核心的生成逻辑处理类
│ ├── BuildFactory.java
│ └── Column.java
│ └── RemarkDict.java
├── jdbc // 数据库查下相关的接口和2个实现，主要是查下所有的表和表里的所有字段信息
│ ├── AbstractDaoSupport.java
│ ├── MysqlDao.java
│ └── OracleDao.java
└── util // 相关的工具类
├── DateUtil.java
├── MyUtils.java
└── StringUtil.java2018.04.23- 新增模板:z_other.ftl; mvc bean一起生成2018.04.19- mybatis.ftl模板:查询字段如果是String类型的, 那么使用regexp替代=2018.04.19- 可以根据表字段的备注生成下拉菜单选项; 作用范围:列表展示/列表搜索/添加或修改字段;
如:业余爱好:[1.美食 2.K歌 3.逛街 4.游戏 5.旅游 6.运动], 列表页面可以根据值为4时直接展示为游戏;添加页面则为对应的下拉2018.04.18- 新增模板:列表展示页面 和 添加/修改页面 (resources/template/ssm_cms/{jsp_list.ftl,jsp_modify.ftl})- 删除除了
mappings.template和mappings.output_path之外的字段; 另外2套模板的config.json更新 config.json去掉 groups 节点, 输出路径(和报名)以mappings.output_path为准config.json增加一个mappings.output_path更加直观的表示输出路径(Java源文件全路径)； 这样就可以取代 除了mappings.template之外的其他字段了;config.json增加过滤某些表的功能，比如白名单和黑名单之类的