欢迎使用CSDN-markdown编辑器

文档编号 V1.0.0
文档负责人
文档名称 天元木业系统总统设计说明书

天元木业系统总体设计说明书

版本号 日期 说明 作者
V1.0 2017-08-07 为了满足天元木业的简便管理和数据报表 钱建

目 录

1 引言 1
1.1 编写背景 1
1.1.1 系统名称及版本号 1
1.2 参考资料 1
2 系统概述 2
2.1 系统目标 2
2.2 系统架构 2
2.2.1 业务功能 2
2.2.2 整体架构 2
2.2.3 部署结构 2
2.3 系统划分 2
2.3.1 管理前端 2
2.3.2 基础服务 3
2.4 技术选型 3
2.4.1 技术选型 3
2.4.2 技术说明 3
2.4.3 调用关系 3
2.4.4 前端说明 3
3 数据库设计 4
3.1 平台相关表 4
3.1.1 权限类表 4
4 模块功能设计 5
4.1 交互流程 5
4.1.1 统一登录 5
4.2 管理前端 6
4.2.1 系统管理 6
4.2.1.1 角色管理 6
4.2.1.2 用户管理 6
4.2.1.3 字典管理 6
4.2.1.4 任务管理 7
4.2.2 采购管理 7
4.2.2.1 原材料管理 7
4.2.2.2 供应商管理 7
4.2.3 考勤管理 7
4.2.3.1 员工出勤数据 7
4.2.4 供应链管理 7
4.2.4.1 产品列表 7
4.2.4.2 订单列表 7
4.2.5 报表统计 7
4.2.5.1 日产能统计 7
4.2.5.2 月产能统计 8
4.2.5.3 月总收入支出显示 8
4.2.5.4 月收入支出明细 8
4.2.5.5 订单跟踪 8
4.2.6 生产管理模块 8
4.2.6.1 裁料 8
4.2.6.2 冲胚 8
4.2.6.3 捆胚 8
4.2.6.4 硫熏 9
4.2.6.5 蒸煮 9
4.2.6.6 烤干 9
4.2.6.7 成型 9
4.2.6.8 抛光 9
4.2.6.9 品选 9
4.2.6.10 入库 9
4.3 基础模块 9
4.3.1 权限模块 9
4.3.1.1 使用者 9
4.3.1.2 角色分类 9
4.3.1.3 权限分组 10
4.3.2 数据分析 10
4.3.2.1 订单服务 10
4.3.2.2 数据分析服务 10
4.3.3 定时任务 11
4.3.4 导出EXCEL 11
4.3.5 安全设计 11
4.3.5.1 传输安全 11
5 安全设计 11
5.1 系统安全 11
5.1.1 分层部署 11
5.1.2 安全防护 12
5.1.3 容灾机制 12
5.1.3.1 多点接入 12
5.1.3.2 负载均衡 12
5.1.3.3 主备容灾 12
5.2 信息安全 12
5.2.1 信息安全 12
5.2.2 数据安全 12
5.3 业务安全 13
5.3.1 系统防护 13
6 出错处理 13
6.1 出错信息设计 13
6.1.1 错误码规范 13
6.2 异常情况处理 13
7 附录 13

1 引言
1.1 编写背景
1.1.1 系统名称及版本号
如产品版本号“V1.0”。
研发版本号为：V1.0.20170807
1.2 参考资料
序号 文档名称 版本号 文档输出人

2 系统概述
2.1 系统目标
通过互联网技术，为天元木业提供更为便捷的员工管理，更为方便的财务管理，更为精准的产能输出，提供整个公司的效率。
2.2 系统架构
2.2.1 业务功能
补充图。
 用户模块:管理用户权限资源
 财务模块:管理销售入账，采购出账，工资管理，基本水电费支出
 考勤模块:记录员工出勤
 采购模块:统计原材料，经销商，客户商家
 供应链模块:订单，客户，订单，产品，库存
 生产管理模块:整个产品的加工流程，输入到输出，成品和废品
 报表模块:统计日周月各个维度数据，提供决策力
 提供导出EXCEL能力。

2.2.2 整体架构
补图
2.2.3 部署结构
补图
2.3 系统划分
2.3.1 管理前端
提供web端访问方式：通过浏览器访问，请求后端服务器，前后端分离，后续可扩展，提供APP端访问方式。
2.3.2 基础服务
权限服务(auth-server)：权限服务模块主要用于平台统一登录以及授权管理
数据分析(tra-server)：用于数据分析统计，为报表系统以及管理平台提供服务
基础资料服务(base-server)：用户基础信息服务模块用于管理模块
报表服务(bi-server)：数据展现模块，用于展示和导出数据分析结果
生产管理服务(product-server)：整个系统的生产和输出产品的核心功能
日志服务(log-server)：统一日志服务用于收集日志信息
2.4 技术选型
2.4.1 技术选型
使用框架包括：Maven + Spring4 + spring boot + Mybatis + jquery + dwz + mysql
2.4.2 技术说明
为了提高开发效率，让开发人员更专注业务，提供了一个符合工程结构的代码生成工具，可根据数据结构excel生成代码，包括jsp、controller、dto、service、facade、model、entity、mybatis映射文件、数据库DDL语句。生成的代码包含的功能有新增、编辑、作废、详情、导出等。
2.4.3 调用关系

2.4.4 前端说明
采用前后端分离模式进行开发，前端采用主流前端框架开发，与后端统一采用json格式数据传输。
3 数据库设计
后续补充完善
3.1 平台相关表
3.1.1 权限类表
由相关模块负责人补充完整

4 模块功能设计
该系统主要由管理平台、业务系统、报表系统三大部分组成，以下对各部分需求以及后台相关接口分别介绍说明。
4.1 交互流程
4.1.1 统一登录

4.2 管理前端
统一采用json数据传输，通过前后端并向开发分离。
4.2.1 系统管理
4.2.1.1 角色管理
新增/编辑角色，支持按菜单与操作按钮分配权限。
4.2.1.2 用户管理
新增/编辑用户，并支持为用户分配角色以及重置密码，支持对用户进行添加/停用/开启。
4.2.1.3 字典管理
4.2.1.3.1 系统参数管理
提供系统配置参数维护管理模块
4.2.1.3.2 系统类型管理
提供系统配置参数维护管理模块
4.2.1.3.3 部门管理
提供部门基础数据管理
4.2.1.3.4 机组管理
提供机组基础数据管理

4.2.1.3.5 产品类型管理
4.2.1.3.6 物料管理
4.2.1.3.7 经销商管理
4.2.1.4 任务管理
提供数据分析任务管理，考勤数据生成任务
4.2.2 采购管理
4.2.2.1 原材料管理
查询，录入，删除和修改原材料采购的明细
4.2.2.2 供应商管理
供应商基础数据
4.2.3 考勤管理
4.2.3.1 员工出勤数据
员工上下班时间详细记录，提供查询，录入和导出功能
后续可以提供远程手机打卡功能
4.2.4 供应链管理
4.2.4.1 产品列表
产品新增、修改、查找、删除
4.2.4.2 订单列表
显示订单录入的详情和提供新增，修改，查询功能
4.2.5 报表统计
4.2.5.1 日产能统计
支持以天为单位查询到每到工序的产能，转化率，损耗
4.2.5.2 月产能统计
支持以月为单位查询到每到工序的产能，转化率，损耗
4.2.5.3 月总收入支出显示
支持查询月为单位每个月收入支出的账单
4.2.5.4 月收入支出明细
支持每个月工资支出，采购支出，水电费支出明细
4.2.5.5 订单跟踪
查询订单
4.2.6 生产管理模块
4.2.6.1 裁料
物料经过采购入库，由生产管理员统一调配原料，对领取原料的相关人员和原料数量进行编号和记载，便于后期跟踪和产品的输出，
裁料是最开的一环，裁料主要记录裁料的过程，输出的成品和废品
4.2.6.2 冲胚
记录冲胚的过程和结果
4.2.6.3 捆胚
同上
4.2.6.4 硫熏
4.2.6.5 蒸煮
4.2.6.6 烤干
4.2.6.7 成型
4.2.6.8 抛光
4.2.6.9 品选
4.2.6.10 入库
成品入库，输出的产品结果。
4.3 基础模块
统一采用http协议，支持独立部署，亦支持压制部署，要求分为数据库操作层、服务代理层。
4.3.1 权限模块
权限分为操作权限以及数据权限两部分。
补图
4.3.1.1 使用者
老板，生产员
4.3.1.2 角色分类
根据使用者岗位进行角色分类，分为超级管理员、系统管理员、老板、业务员、财务、用户等角色，该处角色根据新需求存在新增。
超级管理员：由系统默认分配，拥有对应平台所有操作以及数据权限
系统管理员：由对应平台超管分配指定权限，建议分配对应系统管理类权限
老 板：由对应平台系统管理员或超级管理员创建，建议分配查看公司经营数据权限
业 务 员：由服务商平台系统管理员或超级管理员创建，建议仅分配该业务员数据查询权限，查看该业务员对应门店组数据
财 务 员：由对应平台系统管理员或超级管理员创建，建议分配财务对账、结算查询权限，查看对应平台对账以及结算信息。
用 户：由具有创建角色的用户创建，建议由系统管理员统一创建
4.3.1.3 权限分组
根据角色职能将菜单功能分为管理员菜单权限、业务员数据菜单权限、财务数据菜单权限、老板数据菜单权限。
管理员菜单权限：
业务员数据菜单权限：
财务数据菜单权限：
老板数据菜单权限：
4.3.2 数据分析
4.3.2.1 订单服务
4.3.2.1.1 批量订单查询
支持根据时间段分页查询订单。
4.3.2.1.2 订单号查询
支持订单号查询。
4.3.2.1.3 订单退款服务
选定订单，进行退款。
4.3.2.2 数据分析服务
4.3.2.2.1 财务统计服务
支持按财务数据分别统计日期查询。
4.3.2.2.2 生产管理统计服务
支持按每个生产流程的材料和输出。
4.3.3 定时任务
定时任务模块。
4.3.4 导出EXCEL
根据查询数据条数进行分批次写入，控制一次拉取数据导致服务不可用。

4.3.5 安全设计
4.3.5.1 传输安全
4.3.5.1.1 传输协议
统一采用https post传输保证信息传输链路安全可靠。
4.3.5.1.2 签名机制
通过对请求/响应报文进行签名验证，防止信息报文篡改。
4.3.5.1.3 加解密
关键信息加密存储以及传输过程中进行加密传输，防止关键信息泄露。
5 安全设计
5.1 系统安全
5.1.1 分层部署
根据业务调用关系将服务进行网络隔离分层部署，每层各司其职保证系统部署安全。
业务分为Nginx层、网关层、内部服务层、数据库层、通道层。
Nginx 层：公网接入层，通过nginx进行业务接入，以及流量限制
网 关 层：主要负责接收外部请求，通过限流防刷等风控功能对内部系统进行安全保护，并负责与具体业务服务进行通信调用。
内部服务层：主要负责与数据库交互，以及仅内部服务调用，无公网访问权限
数据库层：存放数据库服务器，可与内部服务放同一个区，无公网访问权限
通 道 层：主要负责与第三分通道进行数据交互，仅开通出公网权限
5.1.2 安全防护
通过云服务商大禹防护系统、知道创宇安全防御平台，进行ddos、cc攻击流量清洗防护，阻止包括 XSS、SQL注入、木马、0day攻击、DDoS僵尸网络、DNS 攻击等一系列针对Web系统的安全威胁
定期项目安全扫描以及渗透测试机制，保证业务安全性，防止恶意入侵以及越权访问。
针对端口进行开放限制以及监控，预防通过端口进行攻击
5.1.3 容灾机制
5.1.3.1 多点接入
通过在北京、上海和广东部署多个公网接入点，通过不同域名接入，客户端SDK配置多域名，在运营商公网故障、接入点故障等导致主域名不可访问时，客户端SDK能自动切换访问备用域名。
同时支持通过dnspod机制人工切换主域名对应接入城市，保障区域网络故障时，不影响交易。
5.1.3.2 负载均衡
从接入层、应用均在不同机房部署多台，通过负载均衡机制，保障单机房、单机故障时，业务能正常使用。
5.1.3.3 主备容灾
数据库通过主->备->跨机房备 机制实现数据库容灾，支持数据库故障时主动切换
5.2 信息安全
5.2.1 信息安全
外部请求统一采用https post传输保证信息传输链路安全可靠。
通过报文签名机制以及关键信息加密传输机制防止信息篡改，确保信息的保密性、完整性、可靠性以及防抵赖性。
5.2.2 数据安全
通过关键信息加密存储、数据库访问权限隔离等措施，防止数据库拖库、撞库等风险，保障数据存储安全;通过系统访问权限控制防止信息泄露
5.3 业务安全
5.3.1 系统防护
业务限流、限频防雪崩
黑名单机制，防止恶意请求
密码保护机制

6 出错处理
6.1 出错信息设计
6.1.1 错误码规范

6.2 异常情况处理
【说明】错误处理方案与帮助手段。
7 附录