143 Star 228 Fork 125

xautlx / s2jh4net

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
250.代码生成.md 2.49 KB
一键复制 编辑 原始数据 按行查看 历史

概要说明

从开发框架的目标来说会尽可能的提取封装基本的CURD基类实现,但是对于各个业务功能开发还是需要一些基本的框架代码作为添加业务逻辑实现的基础, 有一个基本的框架代码生成工具,既可以有效提升开发效率,也能提升编码的风格一致性和潜在的后期重构需求。

框架提倡以Code First的开发模式,按照JPA注解规范定义基本的Entity对象类,框架实现了一个基础的代码生成工具,基于Freemarker模板定义, 搜索所有Entity注解的实体类,生成基本的DAO、Service、Test、Contoller、JSP等框架页面代码文件生成。大致介绍如下:

  • 模板文件位置:entdiy-devops/entdiy-dev-codebuilder/src/main/resources/com/entdiy/dev/builder/template,可自行根据项目需要调整模板定义格式
  • 生成的代码在:target/generated-codes目录下,其中standalone是一个Entity一个目录,用于偶尔重复生成拷贝某一个Entity相关代码之用,integrate是整合到一起的目录结构。注意:生成的代码都在当前tools工程中,需自行根据需要拷贝所需相关代码到对应的业务工程目录或Package下,然后在业务工程中基于框架代码添加相关业务逻辑代码

基本用法

整个代码工具全部模板文件和源代码都在entdiy-devops/entdiy-dev-codebuilder工程下,如果在运行过程出现问题或有兴趣改进优化其实现,可以自行修改代码逻辑或模板定义以适合自己的项目需要, 以下简单介绍一下使用步骤,具体原理可结合相关配置文件和源代码理解。

  • 按照JPA注解规范定义基本的Entity对象类
  • 参考框架各工程目录的bin目录下source-code-builder.xxx脚本,复制到新建的maven模块的bin目录下,修改脚本文件相关参数值
  • 运行业务模块bin目录下定制的不同操作系统平台的脚本
  • 执行完成后可刷新工程展开工程target/generated-codes目录下,找到所需框架代码拷贝到对应业务工程代码目录下
  • 刷新业务工程如果新代码没有编译错误,则说明生成代码基本可用,可以尝试通过UI界面进行基本的CRUD功能验证
  • 然后在框架代码基础之上追加特定的业务代码实现即可

技巧提示

对于新模块,除了使用代码生成工具生成一些基础框架代码文件,也可以采用直接从一些现有模块或基础框架代码文件复制,做简单修改实现新功能编码。

Java
1
https://gitee.com/xautlx/s2jh4net.git
git@gitee.com:xautlx/s2jh4net.git
xautlx
s2jh4net
s2jh4net
master

搜索帮助