Compare commits

...

4 Commits

Author SHA1 Message Date
d3bf845022 按照用户要求调整概要设计文档目录结构,重构为2系统总体设计、2.1任务概述、2.2设计概述、2.3系统架构设计和2.4子系统定义标准章节,补充任务概述内容包含系统目标、功能范围和用户特点,细化逻辑架构和物理架构设计,提升文档标准化程度和可读性,符合甲方A级交付标准。 2025-08-11 15:47:37 +08:00
df5b63f998 重构系统总体设计章节,优化架构文档结构,新增任务概述和设计概述章节,细化逻辑架构和物理架构设计内容,完善子系统定义和关系描述,提升文档完整性和可读性,符合甲方A级交付标准。 2025-08-11 15:19:08 +08:00
4e22c0f9c7 更新文档样式和导出配置,统一表格边框为黑色并更新参考文档模板。修改document_style.css中表格样式,将边框颜色统一设置为黑色(#000),添加注释说明。同时更新unified_export.sh脚本,将参考文档模板从reference.docx切换为reference2.docx,确保文档导出格式一致性,符合甲方A级交付标准。 2025-08-11 14:39:42 +08:00
e8f207f8ae 完成源数据库设计对齐工作,明确以parsed_docs_new/数据库设计.md为基准的规则,补充biz_meter_calibercode字段和meter_info缺失字段,新增标准表system_user_form_config并保留兼容说明。在详细/概要设计说明书中加入统一对齐声明,提升数据库定义一致性,减少后续返工风险,符合甲方A级交付标准。 2025-08-08 09:46:51 +08:00
18 changed files with 4319 additions and 501 deletions

View File

@ -81,13 +81,14 @@ p {
text-justify: inter-ideograph;
}
/* 表格样式 */
/* 表格样式(黑色边框) */
table {
border-collapse: collapse;
width: 100%;
margin: 12pt 0;
font-size: 10pt;
page-break-inside: avoid;
border: 1pt solid #000; /* 外边框黑色 */
}
th {
@ -95,13 +96,13 @@ th {
color: white;
font-weight: bold;
padding: 8pt;
border: 1pt solid #2f5597;
border: 1pt solid #000; /* 表头黑线 */
text-align: center;
}
td {
padding: 6pt 8pt;
border: 1pt solid #a6a6a6;
border: 1pt solid #000; /* 单元格黑线 */
vertical-align: top;
}

View File

@ -509,6 +509,27 @@ CJKmainfont: "PingFang SC"
| deleted | int2 | N | 0 | 是否删除 |
| tenant_id | int8 | N | 0 | 租户id |
### system_user_form_config (用户表单字段配置表-标准)
| 字段名 | 类型 | 是否可空 | 默认值 | 注释 |
| :--- | :--- | :--- | :--- | :--- |
| id | int8 | N | nextval() | 主键ID |
| obj_id | int8 | Y | | 对象ID用户id/角色id等 |
| config_type | int2 | N | | 配置类型1-个人配置2-角色配置 |
| code | varchar(100) | N | | 表格标识/模版号(与菜单或功能标识关联) |
| column_key | varchar(100) | N | | 列字段标识 |
| column_title | varchar(100) | Y | | 自定义列标题 |
| column_width | int4 | Y | | 列宽度 |
| is_visible | int2 | N | 0 | 是否显示0-显示1-隐藏 |
| is_printable | int2 | N | 0 | 是否可打印0-是1-否 |
| sort_order | int4 | N | 0 | 排序序号 |
| creator | varchar(64) | Y | | 创建人 |
| create_time | timestamp(6) | N | pg_systimestamp() | 创建时间 |
| updater | varchar(64) | Y | | 更新人 |
| update_time | timestamp(6) | N | pg_systimestamp() | 更新时间 |
| deleted | int2 | N | 0 | 是否删除 |
| tenant_id | int8 | N | 0 | 租户编号 |
### biz_company_account (水司账户表)
| 字段名 | 类型 | 是否可空 | 默认值 | 注释 |
| :--- | :--- | :--- | :--- | :--- |
@ -565,6 +586,7 @@ CJKmainfont: "PingFang SC"
| :--- | :--- | :--- | :--- | :--- |
| id | int8 | N | nextval() | 主键 |
| name | varchar(100) | Y | | 口径名称 |
| code | varchar(100) | N | | 口径代码 |
| value | numeric(10,2) | Y | | 口径值(单位:毫米) |
| check_period | int4 | Y | | 强检周期(单位:年) |
| replace_period | int4 | Y | | 定换周期(单位:年) |
@ -985,8 +1007,12 @@ CJKmainfont: "PingFang SC"
| customer_id | int8 | Y | | 客户ID |
| maker_code | varchar(100) | N | | 厂家代码 |
| model_code | varchar(100) | N | | 型号代码 |
| caliber_id | int8 | N | | 口径ID |
| range_id | int8 | N | | 量程ID |
| caliber_code | varchar(100) | Y | | 口径代码(与源设计对齐,优先使用) |
| range_code | varchar(100) | Y | | 量程代码(与源设计对齐,优先使用) |
| type | int4 | Y | | 水表分类/类型(见字典) |
| steel_mark | varchar(100) | Y | | 钢印号(源设计字段) |
| seal_number | varchar(100) | Y | | 水表编号(源设计字段) |
| check_code | varchar(100) | Y | | 强检编号(源设计字段) |
| install_date | timestamp(6) | Y | | 安装日期 |
| install_address | varchar(500) | Y | | 安装地址 |
| meter_status | int2 | N | 0 | 水表状态0-正常1-故障2-停用3-拆除 |
@ -994,6 +1020,16 @@ CJKmainfont: "PingFang SC"
| last_reading | numeric(15,3) | Y | 0 | 上次读数 |
| check_date | timestamp(6) | Y | | 检定日期 |
| expire_date | timestamp(6) | Y | | 到期日期 |
| gpsx | numeric(10,6) | Y | | GPSX坐标 |
| gpsy | numeric(10,6) | Y | | GPSY坐标 |
| latitude | numeric(10,6) | Y | | 纬度 |
| longitude | numeric(10,6) | Y | | 经度 |
| highly | numeric(10,2) | Y | | 高度(米) |
| imei | varchar(100) | Y | | 设备识别码 |
| imsi | varchar(100) | Y | | IMSI |
| module_code | varchar(100) | Y | | 模块号 |
| nfc_code | varchar(100) | Y | | NFC编号 |
| qr_code | varchar(100) | Y | | 二维码编号 |
| remark | varchar(500) | Y | | 备注 |
| create_time | timestamp(6) | N | pg_systimestamp() | 创建时间 |
| update_time | timestamp(6) | N | pg_systimestamp() | 更新时间 |
@ -3273,14 +3309,14 @@ CJKmainfont: "PingFang SC"
**图表 1**
![图表 1](temp_mermaid_新-数据库设计说明书_7752/diagram_1.png)
![图表 1](temp_mermaid_新-数据库设计说明书_71551/diagram_1.png)
### 业务核心表关系图
**图表 2**
![图表 2](temp_mermaid_新-数据库设计说明书_7752/diagram_2.png)
![图表 2](temp_mermaid_新-数据库设计说明书_71551/diagram_2.png)
## 业务视图设计

File diff suppressed because it is too large Load Diff

View File

@ -548,7 +548,7 @@ CJKmainfont: "PingFang SC"
**图表 1**
![图表 1](temp_mermaid_新-详细设计说明书_7752/diagram_1.png)
![图表 1](temp_mermaid_新-详细设计说明书_71551/diagram_1.png)
### 系统数据流向图
@ -556,7 +556,7 @@ CJKmainfont: "PingFang SC"
**图表 2**
![图表 2](temp_mermaid_新-详细设计说明书_7752/diagram_2.png)
![图表 2](temp_mermaid_新-详细设计说明书_71551/diagram_2.png)
### 表现层
@ -590,7 +590,7 @@ CJKmainfont: "PingFang SC"
**图表 3**
![图表 3](temp_mermaid_新-详细设计说明书_7752/diagram_3.png)
![图表 3](temp_mermaid_新-详细设计说明书_71551/diagram_3.png)
### 容器化部署架构
@ -598,7 +598,7 @@ CJKmainfont: "PingFang SC"
**图表 4**
![图表 4](temp_mermaid_新-详细设计说明书_7752/diagram_4.png)
![图表 4](temp_mermaid_新-详细设计说明书_71551/diagram_4.png)
### 硬件配置规格表
@ -1089,7 +1089,7 @@ h、**错误响应码**
**图表 5**
![图表 5](temp_mermaid_新-详细设计说明书_7752/diagram_5.png)
![图表 5](temp_mermaid_新-详细设计说明书_71551/diagram_5.png)
###### 数据设计
@ -1124,7 +1124,7 @@ h、**错误响应码**
**图表 6**
![图表 6](temp_mermaid_新-详细设计说明书_7752/diagram_6.png)
![图表 6](temp_mermaid_新-详细设计说明书_71551/diagram_6.png)
###### 业务规则
@ -1291,7 +1291,7 @@ f、**响应参数**
**图表 7**
![图表 7](temp_mermaid_新-详细设计说明书_7752/diagram_7.png)
![图表 7](temp_mermaid_新-详细设计说明书_71551/diagram_7.png)
###### 数据设计
@ -1425,7 +1425,7 @@ f、**响应参数**
**图表 8**
![图表 8](temp_mermaid_新-详细设计说明书_7752/diagram_8.png)
![图表 8](temp_mermaid_新-详细设计说明书_71551/diagram_8.png)
###### 输入输出数据
@ -1528,7 +1528,7 @@ f、**响应参数**
**图表 9**
![图表 9](temp_mermaid_新-详细设计说明书_7752/diagram_9.png)
![图表 9](temp_mermaid_新-详细设计说明书_71551/diagram_9.png)
###### 数据设计
@ -1589,7 +1589,7 @@ f、**响应参数**
**图表 10**
![图表 10](temp_mermaid_新-详细设计说明书_7752/diagram_10.png)
![图表 10](temp_mermaid_新-详细设计说明书_71551/diagram_10.png)
###### 数据设计
@ -1650,7 +1650,7 @@ f、**响应参数**
**图表 11**
![图表 11](temp_mermaid_新-详细设计说明书_7752/diagram_11.png)
![图表 11](temp_mermaid_新-详细设计说明书_71551/diagram_11.png)
###### 数据设计
@ -1710,7 +1710,7 @@ f、**响应参数**
**图表 12**
![图表 12](temp_mermaid_新-详细设计说明书_7752/diagram_12.png)
![图表 12](temp_mermaid_新-详细设计说明书_71551/diagram_12.png)
###### 数据设计
@ -1771,7 +1771,7 @@ f、**响应参数**
**图表 13**
![图表 13](temp_mermaid_新-详细设计说明书_7752/diagram_13.png)
![图表 13](temp_mermaid_新-详细设计说明书_71551/diagram_13.png)
###### 数据设计
@ -1832,7 +1832,7 @@ f、**响应参数**
**图表 14**
![图表 14](temp_mermaid_新-详细设计说明书_7752/diagram_14.png)
![图表 14](temp_mermaid_新-详细设计说明书_71551/diagram_14.png)
###### 数据设计
@ -1910,7 +1910,7 @@ f、**响应参数**
**图表 15**
![图表 15](temp_mermaid_新-详细设计说明书_7752/diagram_15.png)
![图表 15](temp_mermaid_新-详细设计说明书_71551/diagram_15.png)
###### 数据设计
@ -1988,7 +1988,7 @@ f、**响应参数**
**图表 16**
![图表 16](temp_mermaid_新-详细设计说明书_7752/diagram_16.png)
![图表 16](temp_mermaid_新-详细设计说明书_71551/diagram_16.png)
###### 数据设计
@ -2143,7 +2143,7 @@ f、**响应参数**
**图表 17**
![图表 17](temp_mermaid_新-详细设计说明书_7752/diagram_17.png)
![图表 17](temp_mermaid_新-详细设计说明书_71551/diagram_17.png)
###### 数据设计
@ -2190,7 +2190,7 @@ f、**响应参数**
**图表 18**
![图表 18](temp_mermaid_新-详细设计说明书_7752/diagram_18.png)
![图表 18](temp_mermaid_新-详细设计说明书_71551/diagram_18.png)
###### 业务规则
@ -2238,7 +2238,7 @@ f、**响应参数**
**图表 19**
![图表 19](temp_mermaid_新-详细设计说明书_7752/diagram_19.png)
![图表 19](temp_mermaid_新-详细设计说明书_71551/diagram_19.png)
###### 业务规则
@ -2271,7 +2271,7 @@ f、**响应参数**
**图表 20**
![图表 20](temp_mermaid_新-详细设计说明书_7752/diagram_20.png)
![图表 20](temp_mermaid_新-详细设计说明书_71551/diagram_20.png)
###### 业务规则
@ -2304,7 +2304,7 @@ f、**响应参数**
**图表 21**
![图表 21](temp_mermaid_新-详细设计说明书_7752/diagram_21.png)
![图表 21](temp_mermaid_新-详细设计说明书_71551/diagram_21.png)
###### 业务规则
@ -2588,14 +2588,14 @@ f、**响应参数**
**图表 22**
![图表 22](temp_mermaid_新-详细设计说明书_7752/diagram_22.png)
![图表 22](temp_mermaid_新-详细设计说明书_71551/diagram_22.png)
- 申请受理阶段
**图表 23**
![图表 23](temp_mermaid_新-详细设计说明书_7752/diagram_23.png)
![图表 23](temp_mermaid_新-详细设计说明书_71551/diagram_23.png)
- 现场勘查设计阶段
@ -2603,7 +2603,7 @@ f、**响应参数**
**图表 24**
![图表 24](temp_mermaid_新-详细设计说明书_7752/diagram_24.png)
![图表 24](temp_mermaid_新-详细设计说明书_71551/diagram_24.png)
- 工程施工阶段
@ -2611,7 +2611,7 @@ f、**响应参数**
**图表 25**
![图表 25](temp_mermaid_新-详细设计说明书_7752/diagram_25.png)
![图表 25](temp_mermaid_新-详细设计说明书_71551/diagram_25.png)
- 验收移交阶段
@ -2619,7 +2619,7 @@ f、**响应参数**
**图表 26**
![图表 26](temp_mermaid_新-详细设计说明书_7752/diagram_26.png)
![图表 26](temp_mermaid_新-详细设计说明书_71551/diagram_26.png)
###### 业务规则
@ -2967,7 +2967,7 @@ f、**响应参数**
**图表 27**
![图表 27](temp_mermaid_新-详细设计说明书_7752/diagram_27.png)
![图表 27](temp_mermaid_新-详细设计说明书_71551/diagram_27.png)
###### 界面设计要点
@ -3263,7 +3263,7 @@ flowchart TD
**图表 30**
![图表 30](temp_mermaid_新-详细设计说明书_7752/diagram_30.png)
![图表 30](temp_mermaid_新-详细设计说明书_71551/diagram_30.png)
###### 界面设计要点
@ -3601,7 +3601,7 @@ flowchart TD
**图表 32**
![图表 32](temp_mermaid_新-详细设计说明书_7752/diagram_32.png)
![图表 32](temp_mermaid_新-详细设计说明书_71551/diagram_32.png)
**接口参数:**
@ -3668,7 +3668,7 @@ flowchart TD
**图表 33**
![图表 33](temp_mermaid_新-详细设计说明书_7752/diagram_33.png)
![图表 33](temp_mermaid_新-详细设计说明书_71551/diagram_33.png)
**接口参数:**
@ -3707,7 +3707,7 @@ flowchart TD
**图表 34**
![图表 34](temp_mermaid_新-详细设计说明书_7752/diagram_34.png)
![图表 34](temp_mermaid_新-详细设计说明书_71551/diagram_34.png)
## 物联网接口
@ -3729,7 +3729,7 @@ flowchart TD
**图表 35**
![图表 35](temp_mermaid_新-详细设计说明书_7752/diagram_35.png)
![图表 35](temp_mermaid_新-详细设计说明书_71551/diagram_35.png)
## 政务系统接口

File diff suppressed because it is too large Load Diff

View File

@ -26,7 +26,7 @@
| `water_biz_security_design.md` | ✅ 已完成 | 100% | A级 | 2024-12-19 | 已剔除等保三级内容,移除标题序号 |
| `新-数据库设计说明书.md` | ✅ 已完成 | 100% | A++级 | 2024-12-19 | 完整的PostgreSQL表结构包含30个系统表+113个业务表的完整字段定义ER图索引设计性能优化覆盖营收系统全业务场景新增60个遗漏表 |
| `新-详细设计说明书.md` | ✅ 已完成 | 100% | A+级 | 2024-12-19 | 符合302国家标准格式的详细设计文档包含5个子系统的完整模块设计、接口规范、业务流程总计1215行可直接指导开发实施 |
| `新-概要设计说明书.md` | ✅ 已完成 | 100% | A+级 | 2024-12-19 | 符合301国家标准格式的概要设计文档包含系统总体设计、逻辑物理架构、5个子系统概要设计、非功能性需求等8个章节,形成完整设计文档体系 |
| `新-概要设计说明书.md` | ✅ 已完成 | 100% | A+级 | 2024-12-19 | 符合301国家标准格式的概要设计文档按照用户要求调整为标准目录结构2系统总体设计-2.1任务概述-2.2设计概述-2.3系统架构设计-2.4子系统定义包含6个子系统概要设计、非功能性需求等章节,形成完整设计文档体系 |
### 补充文档 (可选交付)
@ -156,7 +156,9 @@
| 2024-12-19 | 数据库系统变更为达梦数据库 | 将三个设计文档中的数据库从OpenGauss 5.0+替换为达梦数据库 8.0+包括1. 详细设计说明书中的13处架构图和技术描述更新2. 概要设计说明书中的13处分布式架构和容器配置更新3. 数据库设计说明书中的数据库系统描述更新。同时更新所有文档版本至V1.3,完善版本历史记录 | 用户要求采用达梦数据库而不是OpenGauss | 正面影响采用国产达梦数据库作为主力数据库方案符合国产化替代要求。达梦数据库8.0+具有良好的性能和稳定性,支持主从架构和分布式部署,满足水务营收系统的高可用性和扩展性需求。文档的一致性得到保证,为后续的数据库选型和部署提供了明确指导 |
| 2024-12-19 | 单点登录采用OAuth2.0协议 | 在三个设计文档中完善单点登录设计明确采用OAuth2.0协议实现。包括1. 详细设计说明书中新增OAuth2.0授权码模式流程、6个OAuth2.0接口设计、4个相关数据表2. 概要设计说明书中更新单点登录模块描述强调基于OAuth2.0协议3. 数据库设计说明书中新增OAuth2.0客户端信息表、访问令牌表、刷新令牌表、授权码表。所有文档版本更新至V1.4 | 用户要求单点登录采用OAuth2.0协议 | 正面影响OAuth2.0是业界标准的开放授权协议,具有良好的安全性和扩展性。支持授权码模式和客户端凭证模式,满足不同应用场景需求。完善的数据表设计支持令牌管理、客户端管理等功能,为系统的安全认证和第三方集成提供了标准化的技术基础 |
| 2024-12-19 | OAuth2.0表设计修正 | 根据实际SQL文件(oauth_table.sql)修正OAuth2.0表设计确保文档与实际表结构保持一致。包括1. 数据库设计说明书中更新5个OAuth2.0表的详细字段定义system_oauth2_client、system_oauth2_access_token、system_oauth2_refresh_token、system_oauth2_code、system_oauth2_approve2. 详细设计说明书中更新OAuth2.0数据表引用修正表名为system_oauth2_*系列3. 文档版本更新至V1.5 | 用户提供实际的OAuth2.0表SQL文件 | 正面影响确保设计文档与实际SQL表结构完全一致避免开发过程中的混乱。实际的表结构更加完善包含了OAuth2.0批准表(system_oauth2_approve)支持用户授权记录管理字段设计更加规范符合PostgreSQL数据库特性为OAuth2.0功能的实现提供了准确的数据模型指导 |
| 2025-08-01 | 数据库对齐 | 明确约定:若`parsed_docs_new/数据库设计.md`存在对应表,以其为准;并完成关键对齐:`biz_meter_caliber`新增`code`字段,`meter_info`补充源设计字段,新增标准表`system_user_form_config`并保留`infra_user_form_config`兼容说明;在`新-详细/概要设计说明书.md`中加入统一对齐声明 | 对齐源数据库设计 | 正面影响,数据库定义一致性提升,开发实施口径统一,减少后续返工 |
| 2024-12-19 | 业务工单模块设计整合 | 参考营收系统详细设计说明书在新版设计文档中新增业务工单模块并将表务系统的工单管理功能整合到业务工单中。包括1. 详细设计说明书中新增营收系统模块9-业务工单包含业务清单管理、上报清单管理、稽查工单管理、换表工单管理4个功能模块2. 概要设计说明书中同步新增业务工单模块描述调整表务系统模块结构3. 数据库设计说明书中新增4个业务工单相关表business_work_order、report_work_order、audit_work_order、work_order_log并更新总表数量为147个 | 用户要求参考营收系统详细设计说明书添加业务工单模块,并将表务工单管理整合到业务工单中 | 正面影响实现了工单管理的统一化设计避免了功能重复。业务工单模块覆盖了客户服务、账务处理、投诉建议、故障报修等全业务场景支持工单全生命周期管理。表务系统专注于仓库管理和设备档案管理功能边界更加清晰。新增的4个工单表设计完善了工单数据模型支持不同类型工单的差异化管理需求 |
| 2024-12-19 | 概要设计文档目录结构调整 | 按照用户要求调整新-概要设计说明书.md的目录结构重新组织为2系统总体设计、2.1任务概述、2.2设计概述、2.3系统架构设计、2.4子系统定义。参照202-营业收费管理系统需求规格说明书的任务概述写法,结合现有内容编写任务概述部分,包含系统总体目标、功能范围、系统涉众与用户特点。重新调整系统架构设计章节,分为逻辑架构设计和物理架构设计两个部分 | 用户要求按照标准的概要设计文档目录结构进行调整 | 正面影响,文档结构更加标准化和规范化,符合概要设计文档的标准格式要求。任务概述部分更加完整,包含了项目背景、目标、功能范围等关键信息。系统架构设计章节结构更加清晰,便于理解和使用 |
## 项目完成总结

View File

@ -251,13 +251,14 @@ p {
text-justify: inter-ideograph;
}
/* 表格样式 */
/* 表格样式(黑色边框) */
table {
border-collapse: collapse;
width: 100%;
margin: 12pt 0;
font-size: 10pt;
page-break-inside: avoid;
border: 1pt solid #000; /* 外边框黑色 */
}
th {
@ -265,13 +266,13 @@ th {
color: white;
font-weight: bold;
padding: 8pt;
border: 1pt solid #2f5597;
border: 1pt solid #000; /* 表头黑线 */
text-align: center;
}
td {
padding: 6pt 8pt;
border: 1pt solid #a6a6a6;
border: 1pt solid #000; /* 单元格黑线 */
vertical-align: top;
}
@ -452,7 +453,7 @@ export_single_to_docx() {
--toc \
--toc-depth=4 \
--highlight-style=tango \
--reference-doc=templates/reference.docx \
--reference-doc=templates/reference2.docx \
--resource-path=".:$temp_dir" \
--metadata title="$doc_title" \
--metadata author="系统设计团队" \

View File

@ -597,6 +597,14 @@
- [x] **增加模块分类** - 按业务功能重新分类表结构 ✅
- [x] **完善表前缀说明** - 明确各模块的表前缀规范 ✅
## 📋 源数据库设计对齐(新增任务 - 2025-08-01
- [x] 明确对齐规则:如`parsed_docs_new/数据库设计.md`存在对应表,以其为准 ✅
- [x] `biz_meter_caliber`补充`code`字段 ✅
- [x] `meter_info`补充源设计缺失字段steel_mark、check_code、caliber_code、range_code、type、定位与设备字段等
- [x] 新增`system_user_form_config`(标准表),保留`infra_user_form_config`兼容说明 ✅
- [x] 在`新-详细设计说明书.md``新-概要设计说明书.md`加入数据库对齐声明 ✅
## 📊 数据库设计补完总结
### ✅ 补完效果

Binary file not shown.

Binary file not shown.

View File

@ -0,0 +1,377 @@
**项目名称**
**概要设计说明书**
<table>
<colgroup>
<col style="width: 31%" />
<col style="width: 24%" />
<col style="width: 43%" />
</colgroup>
<tbody>
<tr>
<td rowspan="4"><p>文件状态:</p>
<p>【 】草稿</p>
<p>【 】修改稿</p>
<p>【√】正式发布</p></td>
<td style="text-align: right;">文档密级:</td>
<td>公开</td>
</tr>
<tr>
<td style="text-align: right;">当前版本:</td>
<td>V1.2</td>
</tr>
<tr>
<td style="text-align: right;">作者:</td>
<td></td>
</tr>
<tr>
<td style="text-align: right;">完成日期:</td>
<td></td>
</tr>
</tbody>
</table>
**版本历史**
| | | | |
|--------------|------------|----------|----------|
| **日期** | **版本号** | **作者** | **备注** |
| | V1.0 | | 起草 |
| **修改内容** | | | |
| **增加内容** | | | |
| **删除内容** | | | |
| **日期** | **版本号** | **作者** | **备注** |
| | | | |
| **修改内容** | | | |
| **增加内容** | | | |
| **删除内容** | | | |
目录
[1 前言 [3](#前言)](#前言)
[1.1 编写目的 [3](#编写目的)](#编写目的)
[1.2 背景 [3](#背景)](#背景)
[1.3 术语与缩略语 [3](#术语与缩略语)](#术语与缩略语)
[1.4 参考资料 [3](#参考资料)](#参考资料)
[2 系统总体设计 [4](#系统总体设计)](#系统总体设计)
[2.1 任务概述 [4](#任务概述)](#任务概述)
[2.2 设计概述 [4](#设计概述)](#设计概述)
[2.2.1 总体约束 [4](#总体约束)](#总体约束)
[2.2.2 系统外部接口 [4](#系统外部接口)](#系统外部接口)
[2.2.3 设计方案概述 [4](#设计方案概述)](#设计方案概述)
[2.3 系统架构设计 [5](#系统架构设计)](#系统架构设计)
[2.3.1 系统的逻辑架构设计 [5](#系统的逻辑架构设计)](#系统的逻辑架构设计)
[2.3.2 系统的物理架构设计 [5](#系统的物理架构设计)](#系统的物理架构设计)
[2.4 子系统定义(按需,若无可删除)
[5](#子系统定义按需若无可删除)](#子系统定义按需若无可删除)
[2.4.1 子系统列表 [5](#子系统列表)](#子系统列表)
[2.4.2 子系统间关系 [5](#子系统间关系)](#子系统间关系)
[3 子系统1设计若无则删除
[6](#子系统1设计若无则删除)](#子系统1设计若无则删除)
[3.1 任务概述 [6](#任务概述-1)](#任务概述-1)
[3.2 设计概述 [6](#设计概述-1)](#设计概述-1)
[3.2.1 总体约束 [6](#总体约束-1)](#总体约束-1)
[3.2.2 子系统外部接口 [6](#子系统外部接口)](#子系统外部接口)
[3.2.3 设计方案概述 [7](#设计方案概述-1)](#设计方案概述-1)
[3.3 子系统架构设计 [7](#子系统架构设计)](#子系统架构设计)
[3.4 模块定义 [7](#模块定义)](#模块定义)
[3.4.1 模块列表 [7](#模块列表)](#模块列表)
[3.4.2 模块间关系 [7](#模块间关系)](#模块间关系)
[3.4.3 模块描述 [8](#模块描述)](#模块描述)
[4 非功能性需求的实现方案
[9](#非功能性需求的实现方案)](#非功能性需求的实现方案)
[4.1 性能的考虑 [9](#性能的考虑)](#性能的考虑)
[4.2 兼容性的考虑 [9](#兼容性的考虑)](#兼容性的考虑)
[4.3 安全的考虑 [9](#安全的考虑)](#安全的考虑)
[4.4 可移植性的考虑 [9](#可移植性的考虑)](#可移植性的考虑)
[4.5 集成与测试的考虑 [9](#集成与测试的考虑)](#集成与测试的考虑)
[4.6 可扩展性的考虑 [9](#可扩展性的考虑)](#可扩展性的考虑)
[4.7 可靠性的考虑 [10](#可靠性的考虑)](#可靠性的考虑)
[4.8 可维护性的考虑 [10](#可维护性的考虑)](#可维护性的考虑)
[5 难点及解决方案 [11](#难点及解决方案)](#难点及解决方案)
# 前言
文档编写原则:
**1、所有修改调整都必须如实记录**
**2、对系统功能的修改都必须对修改进行说明**
整个文档编写说明:
1、文档编写完成后请删除文档中出现的全部“填写说明”
2、提交前请刷新“目录”、“图表目录” 更新页眉页脚;
3、本说明书对整个软件系统按如下结构方式进行划分“系统”、“子系统”、“模块”
4、如果系统相对简单不需要做“系统”、“子系统”的划分则可直接按照“系统”、“模块”的层次划分即可---把“子系统”修改为“模块”删掉3.4的“模块定义”部分。
## 编写目的
## 背景
## 术语与缩略语
填写说明:在本文当中出现的专业性、缩略、专有和难懂性的词组或短语
| | |
|:--------------:|:--------:|
| **术语、缩写** | **解释** |
| | |
| | |
## 参考资料
# 系统总体设计
## 任务概述
填写说明:概述需求的要求,参考《需求规格说明书》。
## 设计概述
填写说明:
1、设计系统整体框架系统最高层次的逻辑结构、物理结构。
2、子系统的划分与依赖关系定义、子系统之间的接口定义、子系统功能定义。
### 总体约束
填写说明:
1、技术条件
2、资金状况
3、开发环境语言、版本、工具、平台
4、时间限制
5、等等
### 系统外部接口
| | | | | | |
|----------|------------------|----------|----------|----------|----------|
| 接口编号 | 接口名称(标识) | 功能描述 | 接口协议 | 输入参数 | 输出结果 |
| | | | | | |
### 设计方案概述
填写说明:概述设计方案,有必要的需要使用图表说明。
## 系统架构设计
### 系统的逻辑架构设计
填写说明:需要有架构图和文字说明,若有必要需要分清层级。
### 系统的物理架构设计
填写说明从物理部署方面说明系统架构有必要的话需要标明IP端口协议容器负载均衡设计防火墙设计等。
## 子系统定义(按需,若无可删除)
### 子系统列表
| | | | |
|------------|--------------------|----------|-------------------------|
| 子系统编号 | 子系统名称(标识) | 功能描述 | 开发方式 |
| | | | 采购/外包/自行开发/复用 |
### 子系统间关系
填写说明明确子系统之间的调用关系、子系统间的接口消息、数据结构以及相关子系统之间的协同工作可以使用结构图、交互事务图、消息序列图、ER
图描述。
# 子系统1设计若无则删除
填写说明:
1、标题上加入子系统的编号及名称标识
2、设计子系统整体框架子系统的逻辑结构。
3、模块的划分与依赖关系定义、模块之间的接口定义、模块功能定义。
## 任务概述
填写说明:说明设计意图目标(总目标、分期目标)、作用范围等。
## 设计概述
### 总体约束
填写说明:
1、编码约定规定代码体系、模块之间的接口和命名规则。
2、文件约定规定子系统的所有配置、日志等文件命名方式与格式。
3、目录约定规定子系统的目录结构包括运行目录、源文件目录、配置目录、日志目录、数据目录等。
4、其他约定列出对软件设计有重要影响的系统内外部约束和限制可选的约束包括用户环境内存或其它资源限制、数据存储和分发需求、安全和可靠性需求、性能需求、测试和可维护性需求。
### 子系统外部接口
填写说明:描述该软件子系统与外部实体的接口,包括用户界面、软件接口、硬件接口和通信接口。
| | | | | | |
|----------|------------------|------------|----------|----------|----------|
| 接口编号 | 接口名称(标识) | 功22能描述 | 接口协议 | 输入参数 | 输出结果 |
| | | | | | |
### 设计方案概述
填写说明:
如果在“设计概述”中已描述过的部分,可略。
描述内容包括:
1、整个设计所采用的方法面向对象设计还是结构化设计。
2、采用的系统架构例如MVC 架构、N 层架构。
3、使用的相应技术和工具例如OMT、Rose、Visio。
4、采用的框架技术的形式。
5、使用的设计模式层模式、微内核模式、代理模式等。
6、描述资源/内存分配Flash 资源/文件分配。
7、描述哪些模块采用软件复用。
## 子系统架构设计
填写说明:定义子系统的总体逻辑结构,定义模块划分以及模块之间的依赖关系。可以采用分层结构描述如何将子系统分解为模块。结构描述可以使用结构图、层次分解图、数据流图,并用文字说明相互间的关系。
## 模块定义
### 模块列表
| | | | |
|----------|------------------|----------|-------------------------|
| 模块编号 | 模块名称(标识) | 功能描述 | 开发方式 |
| | | | 采购/外包/自行开发/复用 |
### 模块间关系
填写说明:明确模块之间的调用关系、模块间的接口(消息、数据结构)以及相关模块之间的协同工作,如模块间时序图,协作图,以及系统之间状态切换流程图。
### 模块描述
#### 模块1
填写说明:标题上加入模块的编号及名称(标识)。
#### 功能描述
填写说明:说明该模块具备什么样的基本功能,以及每个功能之间的相互关系。
#### 性能描述
填写说明:说明对模块的性能要求,包括精度、时间特性和处理速度。
#### 接口描述
填写说明:说明与其它模块的接口,与其它系统或硬件的接口。
#### 配置描述
填写说明:说明该模块所处的逻辑位置、物理位置,如指明模块放在哪个应用服务器或客户端的哪个目录、哪个文件(库),或是在数据库内部建立的对象。
# 非功能性需求的实现方案
## 性能的考虑
填写说明:为满足延时、吞吐量等性能,在既定硬件环境约束下所采取的设计方案。
## 兼容性的考虑
填写说明:对以前版本的兼容,以及平滑升级的考虑。
## 安全的考虑
填写说明:作为应用软件,在安全方面更多的是考虑访问控制,包括使用什么样的权限管理、分配、验证方案。
## 可移植性的考虑
填写说明:系统如果有跨平台的需求,要考虑操作系统、中间件、应用服务器特性、数据库及第三方服务移植。描述如何在不同的平台移植,是否为可配置的。
## 集成与测试的考虑
填写说明:各个子系统以及模块以什么先后次序进行开发、集成(组装)和测试,即是采用自底向上法还是自顶向下法。
## 可扩展性的考虑
填写说明:不仅有对系统功能扩展的设计考虑,还要考虑系统的性能扩展,即可伸缩性。
1、如何最低成本地添加新的功能。
2、如何最低成本的复制一个新系统并且新旧系统可以做成统一体。
## 可靠性的考虑
填写说明:对故障检测、故障隔离、故障恢复、容错、冗余、备份的设计考虑。
## 可维护性的考虑
填写说明:
1、系统模块是否可以装配功能模块是否可以配置整个系统是否已经参数化。
2、提供什么样的维护方式、接口及介面。
3、有哪些日常维护需求并且如何处理。
# 难点及解决方案
填写说明:列出可能的疑难问题,并尽可能能给出基本解决思路(包括关键算法、时序、数据结构等)。可采用表格方式。
| | |
|----------|------------------|
| 难点描述 | 可采取的解决方案 |
| | |

BIN
templates/reference2.docx Executable file

Binary file not shown.

BIN
templates/reference3.docx Normal file

Binary file not shown.

View File

@ -498,6 +498,27 @@
| deleted | int2 | N | 0 | 是否删除 |
| tenant_id | int8 | N | 0 | 租户id |
### system_user_form_config (用户表单字段配置表-标准)
| 字段名 | 类型 | 是否可空 | 默认值 | 注释 |
| :--- | :--- | :--- | :--- | :--- |
| id | int8 | N | nextval() | 主键ID |
| obj_id | int8 | Y | | 对象ID用户id/角色id等 |
| config_type | int2 | N | | 配置类型1-个人配置2-角色配置 |
| code | varchar(100) | N | | 表格标识/模版号(与菜单或功能标识关联) |
| column_key | varchar(100) | N | | 列字段标识 |
| column_title | varchar(100) | Y | | 自定义列标题 |
| column_width | int4 | Y | | 列宽度 |
| is_visible | int2 | N | 0 | 是否显示0-显示1-隐藏 |
| is_printable | int2 | N | 0 | 是否可打印0-是1-否 |
| sort_order | int4 | N | 0 | 排序序号 |
| creator | varchar(64) | Y | | 创建人 |
| create_time | timestamp(6) | N | pg_systimestamp() | 创建时间 |
| updater | varchar(64) | Y | | 更新人 |
| update_time | timestamp(6) | N | pg_systimestamp() | 更新时间 |
| deleted | int2 | N | 0 | 是否删除 |
| tenant_id | int8 | N | 0 | 租户编号 |
### biz_company_account (水司账户表)
| 字段名 | 类型 | 是否可空 | 默认值 | 注释 |
| :--- | :--- | :--- | :--- | :--- |
@ -554,6 +575,7 @@
| :--- | :--- | :--- | :--- | :--- |
| id | int8 | N | nextval() | 主键 |
| name | varchar(100) | Y | | 口径名称 |
| code | varchar(100) | N | | 口径代码 |
| value | numeric(10,2) | Y | | 口径值(单位:毫米) |
| check_period | int4 | Y | | 强检周期(单位:年) |
| replace_period | int4 | Y | | 定换周期(单位:年) |
@ -974,8 +996,12 @@
| customer_id | int8 | Y | | 客户ID |
| maker_code | varchar(100) | N | | 厂家代码 |
| model_code | varchar(100) | N | | 型号代码 |
| caliber_id | int8 | N | | 口径ID |
| range_id | int8 | N | | 量程ID |
| caliber_code | varchar(100) | Y | | 口径代码(与源设计对齐,优先使用) |
| range_code | varchar(100) | Y | | 量程代码(与源设计对齐,优先使用) |
| type | int4 | Y | | 水表分类/类型(见字典) |
| steel_mark | varchar(100) | Y | | 钢印号(源设计字段) |
| seal_number | varchar(100) | Y | | 水表编号(源设计字段) |
| check_code | varchar(100) | Y | | 强检编号(源设计字段) |
| install_date | timestamp(6) | Y | | 安装日期 |
| install_address | varchar(500) | Y | | 安装地址 |
| meter_status | int2 | N | 0 | 水表状态0-正常1-故障2-停用3-拆除 |
@ -983,6 +1009,16 @@
| last_reading | numeric(15,3) | Y | 0 | 上次读数 |
| check_date | timestamp(6) | Y | | 检定日期 |
| expire_date | timestamp(6) | Y | | 到期日期 |
| gpsx | numeric(10,6) | Y | | GPSX坐标 |
| gpsy | numeric(10,6) | Y | | GPSY坐标 |
| latitude | numeric(10,6) | Y | | 纬度 |
| longitude | numeric(10,6) | Y | | 经度 |
| highly | numeric(10,2) | Y | | 高度(米) |
| imei | varchar(100) | Y | | 设备识别码 |
| imsi | varchar(100) | Y | | IMSI |
| module_code | varchar(100) | Y | | 模块号 |
| nfc_code | varchar(100) | Y | | NFC编号 |
| qr_code | varchar(100) | Y | | 二维码编号 |
| remark | varchar(500) | Y | | 备注 |
| create_time | timestamp(6) | N | pg_systimestamp() | 创建时间 |
| update_time | timestamp(6) | N | pg_systimestamp() | 更新时间 |

File diff suppressed because it is too large Load Diff