业务系统软件概要设计说明书.doc

深圳市华域无线技术有限公司深圳市华域无线技术有限公司 密级 文档编号页 数共 页 版 本A 0 软软件件 概概要要设设计计说说明明书书 生效日期 HSWOKR 业务系统软件概要设计说明书 制 定 Ben Zhong 审 核 批 准 深圳市华域无线技术有限公司 Shenzhen Hojy Wireless Technology Co Ltd 修订履历 页页 次次123发行版发行版A 0 最新版本最新版本 A 0 A 0 A 0 生效日期生效日期 修订日期修订日期修订页次修订页次修改前版次修改前版次修订后版次修订后版次修修 订订 内内 容容确认确认 2012 03 26初稿钟斌 2012 04 24修改接口 最新版本查询 接口 验证码计算方法 去除 content md5 增加 IMEI 与 SN 做为 MD5 计 算值 钟斌 2012 05 07更新 4 2 章节 增加相关 的界面 钟斌 2012 05 29更新 4 1 1 章节 增加长 度说明 钟斌 2012 6 12更新更新 3 2 2 与与 3 2 3 章节 章节 增加用户名命名规范与增加用户名命名规范与 update zip 升级包大小限升级包大小限 制制 钟斌钟斌 目 录 1引言引言 1 1 1 目的 1 1 2 范围 1 1 3 定义 1 1 4 参考资料 1 2软件系统状态与交互描述软件系统状态与交互描述 1 2 1 软件系统结构和层次结构 1 2 2 软件系统原理描述 2 2 3 软件系统交互描述 2 3软件系统设计软件系统设计 3 3 1 软件设计概念和原理 3 3 2 系统模块设计 4 4接口设计接口设计 7 4 1 终端通讯接口 7 4 2 业务系统用户接口 9 5可测试性设计可测试性设计 11 6可移植性设计可移植性设计 11 7异常设计异常设计 12 7 1 软件系统的异常描述 12 7 2 软件系统的风险描述 12 8其他设计其他设计 12 8 1 配置设计 12 8 2 数据库设计 14 9附录附录 14 9 1 软件开发环境 14 9 2 软件生产环境 15 9 3 关键点的附录 15 深圳市华域无线技术有限公司 专业专业源于源于专专注 合作注 合作创创造双造双赢赢 第 1 页 共 3 页 1 引言 1 1 目的 本设计文档的输入文档为 HSWORK解决方案 它主要的目标是细化系统软 件功能模块 定义系统软件架构 定义通讯接口 设计数据库结构及相关运行环境 的配置等 1 2 范围 1 2 1本文档适用于 HSWORK 项目 1 2 2本文档适于开发人员 测试人员以及后续开发的设计人员 1 3 定义 UE user equipment 用户设备 HSWORK 华域升级业务系统 OSS Open Storage Service 阿里巴巴云计算公司提供的开放云存储服务 1 4 参考资料 13 产品版本管理办法 A 2 pdf 2 软件系统状态与交互描述 2 1 软件系统结构和层次结构 深圳市华域无线技术有限公司 专业专业源于源于专专注 合作注 合作创创造双造双赢赢 第 2 页 共 3 页 图中HSWORK业务系统业务系统部分为本文档设计部分 2 2 软件系统原理描述 1 发布版本 1 1 制作升级包 将它放在阿里的云存储中 1 2 新增版本信息 配置策略 2 查询版本信息 3 返回当前版本信息 如果有更新 则返回升级包下载地址 4 下载升级包 5 终端升级 2 3 软件系统交互描述 V Vc co on nt tr ro ol ll le er r V Vi ie ew w J Jc co on nt tr ro ol ll le er r S Se er rv vi ic ce e d do om ma ai in n 数据数据数据数据 JSON p pe er rs si is st te en nc ce e 1 2 3 4 5 6 7 系统软件设计图 说明 1 界面链接请求 view控制器处理请求 2 view控制器加载界面内容 深圳市华域无线技术有限公司 专业专业源于源于专专注 合作注 合作创创造双造双赢赢 第 3 页 共 3 页 3 view控制器将界面内容 返回给浏览器 4 如遇到界面为Grid 则发送ajax请求 json控制器负责处理ajax数据请求 5 Json控制器准备好格式化数据 6 Json控制器通过调用service封装好的业务服务方法生成所需的json数据 7 将JSON数据返回浏览器 浏览器将会通过jqgrid将数据呈现给用户 3 软件系统设计 3 1 软件设计概念和原理 H HS SW WO OR RK K c co om m h ho oj jy y h hs sw wo or rk ka ap pp p c co on nt tr ro ol ll le er r c co om m h ho oj jy y h hs sw wo or rk ka ap pp p d do om ma ai in n c co om m h ho oj jy y h hs sw wo or rk ka ap pp p s se er rv vi ic ce e c co om m h ho oj jy y h hs sw wo or rk ka ap pp p p pe er rs si is st te en nc ce e c co om m h ho oj jy y h hs sw wo or rk ka ap pp p j js so on n controller 此包主要用于接受相关的来自客户端request请求 包括GET POST PUT DELETE 以及ajax 数据请求 domain 主要是与数据库表结构相关 一个数据库实体表对应一个类 json 此包提供jqgrid请求所需要的数据 通过json格式 persistence 它是一个数据库持久层 往下与数据库通讯 往上与业务层通讯 此层主要是处理SQL 它在XML中进行定义 service 此包主要一个业务接口层或是业务接口层 对外提供业务接口与业务接口封装实现 深圳市华域无线技术有限公司 专业专业源于源于专专注 合作注 合作创创造双造双赢赢 第 4 页 共 3 页 3 2 系统模块设计 3 2 1基础数据管理模块 1 客户代码维护 规则 两位数字组成 操作 C 增加 U 修改 R 查询 D 删除 2 产品名称维护 规则 V 产品类别 产品型号 R 0 9 0 9 C 0 9 0 9 S 客户代码 操作 C 增加 U 修改 R 查询 D 删除 3 产品类别维护 class 规则 1 代表 TD 类 2 代表 WCDMA 类 3 代表 EDGE 类 操作 C 增加 U 修改 R 查询 D 删除 4 产品型号维护 model 规则 产品类型 0 9 0 9 操作 C 增加 U 修改 R 查询 D 删除 5 产品类型维护 type 规则 1 代表 TD 智能手机 2 代表 WCDMA 智能手机 3 代表 USB 产品类型数据卡 5 代表 USB 及 UART 串口混合类型的 Module 6 代表 mini PCIE 接口类型的 Module 8 代表普通手机 操作 C 增加 U 修改 R 查询 D 删除 3 2 2软件版本维护模块 1 新增版本 上传完整版本文件 V 产品类别产品类别 产品型号产品型号 R 0 9 0 9 C 0 9 0 9 S 深圳市华域无线技术有限公司 专业专业源于源于专专注 合作注 合作创创造双造双赢赢 第 5 页 共 3 页 客户代码客户代码 zip 此完整版本文件与工具中所用的版本文件不一样 它是需要可以支持终端自主写 flash 的 上传步长为 1 的升级包文件 update zip 如当前最新的版本为 R06 那么此升级包提供给 R05 版 本 上传步长为 2 的升级包文件 update zip 如当前最新的版本为 R06 那么此升级包提供给 R04 版 本 上传步长为 3 的升级包文件 update zip 如当前最新的版本为 R06 那么此升级包提供给 R03 版 本 update zip 文件大小不超过 10M 2 发布版本 发布 Bata 版本 用于测试 发布 Release 版本 3 版本管理 维护历史版本 针对 Release 版本不允许删除与修改 3 2 3系统设置模块 升级策略配置 控制升级终端的数量 指定哪些型号 哪个客户可以升级 用户维护 用户名命名规则 1 只能以字母开头 2 区分大小写 3 只能由字母与数字组成 4 用户名长度为 6 16 角色维护 3 2 4WebService 接口模块 详见接口设计部分 1 最新版本查询 深圳市华域无线技术有限公司 专业专业源于源于专专注 合作注 合作创创造双造双赢赢 第 6 页 共 3 页 HSWORK处理查询请求流程 UE查询版本时序图 2 终端信息上报 深圳市华域无线技术有限公司 专业专业源于源于专专注 合作注 合作创创造双造双赢赢 第 7 页 共 3 页 3 升级包下载 4 接口设计 4 1 终端通讯接口 4 1 1最新版本查询 请求消息接口 请求消息接口 GET newversion HTTP 1 1 r n Host r n Date Wed 12 Apr 2011 17 50 00 GMT r n X HOJY Version V1312R01C01S99 r n X HOJY Authorization HOJY c8fdb181845a4ca6b8fec737b3581d76 r n X HOJY IMEI 12234567890000 r n X HOJY SN 1234567898888 r n r n 注 注 X HOJY Authorization 验证码计算方法如下 验证码计算方法如下 X HOJY Authorization HOJY MD5 MD5 X HOJY IMEI X HOJY SN n DATE n RequestResource 其中 其中 DATE 表示此次操作的时间表示此次操作的时间 RequestResource 表示表示 http 请求中的资源 如此样例中为 请求中的资源 如此样例中为 newversion DATE 和和 RequestResource 不能为空不能为空 响应消息接口 响应消息接口 HTTP 1 1 200 OK Date Wed 01 Mar 2011 12 00 00 GMT Content Type application xml Content Length 302 Connection close Server HServer V1312R01C01S99 1 firmware name 简体中文描述 firmware release Description c61ce360a734c018685fbf5e1662c0fd 16787 深圳市华域无线技术有限公司 专业专业源于源于专专注 合作注 合作创创造双造双赢赢 第 8 页 共 3 页 0 0 0 http 10 0 0 1 hswork update zip http 10 0 0 2 hswork update zip 字段说明 序号字段名意义长度备注 1ver 版本 参考 13 产品版本管 理办法 A 2 pdf 中嵌 入式软件版本长度 2num 文件数量 暂不启用 默认值为 1 3name 名称 暂不启用 4desc cn 中文说明 暂不启用 5desc en 英文说明 暂不启用 6md5 MD5 检验码 32 7size 大小 8level 层级 0 无差分 完整升级 1 部分差分 2 完全差分 暂不启用 默认值为 0 9needbackup 是否需要备份 0 不需要 1 需要 暂不启用 默认值为 0 10needrestart 是否需要重启 0 不需要 1 需要 暂不启用 默认值为 0 11downloadurl update zip 下载 URL 255 注 如无最新的版本则返回 201 消息 样例如下 HTTP 1 1 201 OK Date Wed 01 Mar 2011 12 00 00 GMT Content Length 0 Connection close Server HServer 深圳市华域无线技术有限公司 专业专业源于源于专专注 合作注 合作创创造双造双赢赢 第 9 页 共 3 页 4 1 2终端信息上报 请求消息接口 请求消息接口 PUT deviceinfo HTTP 1 00 r n Host r n Date Wed 12 Apr 2011 17 50 00 GMT r n Content Md5 c8fdb181845a4ca6b8fec737b3581d76 r n Content Type text plain r n X HOJY Authorization HOJY c8fdb181845a4ca6b8fec737b3581d76 r n X HOJY IMEI 12234567890000 r n X HOJY SN 1234567898888 r n r n data 响应消息接口 响应消息接口 HTTP 1 1 200 OK Date Wed 01 Mar 2011 12 00 00 GMT 4 1 3升级包下载 4 2 业务系统用户接口 登录界面 深圳市华域无线技术有限公司 专业专业源于源于专专注 合作注 合作创创造双造双赢赢 第 10 页 共 3 页 主体界面 新增版本信息 发布升级包 深圳市华域无线技术有限公司 专业专业源于源于专专注 合作注 合作创创造双造双赢赢 第 11 页 共 3 页 5 可测试性设计 日志输出 private static final Logger logger LoggerFactory getLogger AjaxController class logger debug Received request to get all users 目录 TOMCAT logs 日志文件 catalina out 6 可移植性设计 OSS 部分将会与 GOOGLE 亚马逊 API 集成 Interface CloudStorageDrive TODO 输入你的 accessId 和 accessKey static String accessId static String accessKey static String ossEndpoint TODO 输入你的 bucket 名称 public static String bucketName hswork TODO 输入你的 object 名称 public static String objectName update zip 上传文件接口 public static void uploadFile throws Exception public static void deleteFile throws Exception 阿里云存储服务 Class AliOss implements CloudStorageDrive 亚马逊云存储服务 Class AmazonS3Ex implements CloudStorageDrive 深圳市华域无线技术有限公司 专业专业源于源于专专注 合作