基础框架文档中心

外观

项目规范 ​

项目规范规定了项目结构、必要的文件和内容。

命名 ​

  1. 项目名称包括中文名与英文名，尽量做到表义准确。同时应确定英文简称，方便交流使用。
  2. 项目代码根目录为 hzcc-{syscode}-api，{syscode} 为项目英文简称。
  3. 所有代码必须使用 com.hzcc 作为根包名。

依赖 ​

  1. 正常情况下，项目代码应当基于基础框架开发，使用框架提供的基础对象、功能、服务，避免重复开发相似功能。

    提示

    框架代码的使用方式为在 Git 中添加子模块（Submodule），使用但不修改框架代码。 框架代码应放置在framework目录中。

  2. 软件包依赖，应当使用 hzcc-frm-parent 中声明的版本，具体见下文介绍。

结构 ​

项目使用 Maven 多模块结构，包含 api、model、service、mapper 模块， 同时还有一些必需的目录和文件。

hzcc-{syscode}-api
├─ docs # 放置项目相关的设计、说明文档
├─ framework # 基础框架代码（Git 子模块）
├─ hzcc-{syscode}-api
├─ hzcc-{syscode}-mapper
├─ hzcc-{syscode}-model
├─ hzcc-{syscode}-service
├─ logs # 放置运行日志文件，不需要提交到 git
├─ .dockerignore
├─ .gitignore
├─ .gitlab-ci.yml
├─ dockerfile
└─ readme.md # 项目说明文档

模块 ​

模块名格式为 hzcc-{syscode}-xx，其中 {syscode} 为项目英文简称。

  • hzcc-{syscode}-api：控制器API层，依赖框架 hzcc-frm-base 模块
  • hzcc-{syscode}-mapper：ORM 映射层，依赖框架 hzcc-frm-mapper 模块
  • hzcc-{syscode}-service：业务服务层，依赖框架 hzcc-frm-service 模块
  • hzcc-{syscode}-model：模型对象层，依赖框架 hzcc-frm-model 模块。

同时，这些 Maven 模块都将 hzcc-frm-parent 设置为父模块，以使用统一的依赖版本号。

简介 ​

项目必须编写 readme.md 文件，介绍项目的基本情况。应包含以下内容：

  • 项目名称，包含中、英文名和英文简称。
  • 项目简述，介绍项目背景和系统功能。
  • 项目成员
  • 项目依赖，使用基础框架之外的组件名称与版本号。
  • 与本项目关联的其它项目，例如前端项目，应包含名称和 Git 仓库地址
  • Swagger 文档地址，出于安全考虑，仅需要写明主机地址。
  • 其它有必要说明的关键设计、注意事项等。

版本日志 ​

项目每次发布新版本时，应当编写版本日志文件，记录本次发布的日期、内容（新增、变更、修正、移除）、注意事项等。

提示

版本日志文件放置在项目根目录下的 docs 文件夹中。