软件质量管理之一：总体开发规范(数据工厂)

友莘居士

已于 2023-11-30 10:15:54 修改

阅读量850

点赞数 1

文章标签：规格说明书源代码管理代码规范流程图设计规范

于 2022-03-23 14:51:06 首次发布

本文链接：https://blog.csdn.net/qq_37713191/article/details/123685650

版权

本文档旨在规范系统部署流程、数据库设计、代码编写和版本管理，提升系统可用性和流畅性。主要内容包括：按平台建库建表，统一表命名，模块化代码组织，流程图绘制，版本命名和合并策略，以及SNAPSHOT和RELEASE版本的lib包管理。通过这些规范，以期优化开发效率，确保系统质量。

摘要由CSDN通过智能技术生成

1、概述

1.1编写背景

介于当前部署时版本不明确，部署流程不健全；系统划分不规范等影响商务合作、客户运营人员使用等问题，为了演示更流畅，部署更便捷，系统边界划分更清晰，现针对以上存在问题，做以下相关规范，以达到提升系统可用性、流畅性，提高系统质量的目的。

1.2 阅读对象

本规范阅读对象为各平台开发人员、产品经理、项目经理，及各位后端组长参考。

2、数据库设计规范

2.1 数据库

2.1.1 建库规则

数据库建立是要以平台为单位创建，便于统一管理和查找，也会减少不同平台间公用某系统表等问题

2.2 数据表

2.2.1 表的归属

当前一个数据库中包含了多个平台的数据表，部署时需要与研发确认需要那些表，为了方便运维、提升部署效率，建议以大平台为单位建立数据库，比如：数享平台、地市分析平台可以分别建库，有时候出现特殊项目是也可以独立建库，如核酸检测和疫苗预约项目。

2.2.2 表的命名

目前已有的表的名称大致有三种方式：

t_+模块名称+表用途，t_indicators_audit
平台简写+模块名称+表用途，acs_assets_request
模块名称名称+表用途，例子data_asset_level

数据库名如果已经使用了平台名称，考虑有时候表用途英文较长，建议使用上述第③种方式命名数据表。

2.3 表字段

使用简短英文表示，不宜过长。

3、代码编写规范

3.1 业务模块归类

目前一些平台还存在包含其他平台模块的情况，对于还未归类的平台，后续根据实际情况，逐渐做好归类工作，对于已经归类的如数享2.0，需要严格把关，不接非本平台的模块，保持各个平台独立、纯净。

3.2 代码层级规范

现状：目前总体分为两种层级管理方式

方式一:每个模块建立一套相同的层级块

方式二：模块公用一个层级块

建议新建项目以第二中方式为准，减少文件夹创建，便于快速查找文件。

3.3 流程图

对于复杂的业务流程，需要绘制对应的流程图，一来可以知道自己开发，二来可以可以方便其他同事修改。

4、版本管理规范

4.1版本命名规范

现状：各个平台基本分为了dev、demo、master、其他版本四类，其中dev为开发环境，demo为演示环境、master为主干分支，其他版本属于个人根据项目部署情况，自行定义的版本。

由于各个版本命名不统一，导致部署的程序与sql、配置文件不兼容，导致演示问题频出，所以需要对版本号建立做一个规划，分为4个分支，分别是dev、sit、demo、master四个分支，dev为总的开发分支，每次有模块迭代，需要从dev分支拉取一个分支作为迭代分支，建议命名[dev+版本_+模块_+上线日期]，如dev2.0_datafactory_20220325。