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

1、密级.深圳市华域无线技术有限公司文档编号页数共页本A.0软件概要设计说明书版生效日期HSWOKR 业务系统软件概要设计说明书制定： Ben Zhong审核：批准：深圳市华域无线技术有限公司Shenzhen Hojy Wireless Technology Co., Ltd.修订履历页次123发行版A .0最新版本A .0A .0A .0生效日期修订日期修订页次修改前版次修订后版次修订内容确认2012-03-26初稿钟斌2012-04-24修改接口：最新版本查询钟斌接口，验证码计算方法，去除 content-md5 ，增加IMEI 与 SN 做为 MD5 计算值2012-05-07更新 4.2

2、章节，增加相关钟斌的界面2012-05-29更新 4.1.1 章节，增加长钟斌度说明2012-6-12更新 3.2.2 与 3.2.3 章节，钟斌增加用户名命名规范与update.zip 升级包大小限制目录1引言 .11.1目的 .11.2范围 .11.3定义 .11.4参考资料 .12软件系统状态与交互描述.12.1软件系统结构和层次结构 .12.2软件系统原理描述 .22.3软件系统交互描述 .23软件系统设计 .33.1软件设计概念和原理 .33.2系统模块设计 .44接口设计 .74.1终端通讯接口 .74.2业务系统用户接口 .95可测试性设计 .116可移植性设计 .117异常设计

3、 .127.1软件系统的异常描述 .127.2软件系统的风险描述 .128其他设计 .128.1配置设计 .128.2数据库设计 .149附录 .149.1软件开发环境 .149.2软件生产环境 .159.3关键点的附录 .151 引言1.1 目的本设计文档的输入文档为HSWORK 解决方案 。它主要的目标是细化系统软件功能模块，定义系统软件架构，定义通讯接口，设计数据库结构及相关运行环境的配置等。1.2 范围本文档适用于 HSWORK 项目本文档适于开发人员，测试人员以及后续开发的设计人员1.3 定义UE ：user equipment 用户设备HSWORK ：华域升级业务系统OSS：Ope

4、n Storage Service 阿里巴巴云计算公司提供的开放云存储服务1.4 参考资料 13-产品版本管理办法 A_2.pdf 2 软件系统状态与交互描述2.1 软件系统结构和层次结构图中 HSWORK 业务系统 部分为本文档设计部分。2.2 软件系统原理描述1、发布版本 :1,1、制作升级包，将它放在阿里的云存储中。1.2、新增版本信息，配置策略2、查询版本信息3、返回当前版本信息，如果有更新，则返回升级包下载地址4、下载升级包5、终端升级2.3 软件系统交互描述View321Vcontroller4Jcontroller7Service56JSONpersistencedomain数据

5、数据数据数据系统软件设计图说明：1、界面链接请求，view 控制器处理请求；2、view 控制器加载界面内容；3、view 控制器将界面内容，返回给浏览器；4、如遇到界面为 Grid ，则发送 ajax 请求； json 控制器负责处理 ajax 数据请求；5、Json 控制器准备好格式化数据；6、Json 控制器通过调用 service 封装好的业务服务方法生成所需的json 数据；7、将 JSON数据返回浏览器，浏览器将会通过jqgrid 将数据呈现给用户；3 软件系统设计3.1 软件设计概念和原理HSWORKcontrollerpersistencejsondomainserviceco

6、ntroller此包主要用于接受相关的来自客户端 request请求，包括 GET ， POST， PUT ， DELETE ，以及 ajax 数据请求domain主要是与数据库表结构相关，一个数据库实体表对应一个类json此包提供 jqgrid 请求所需要的数据，通过json格式persistence它是一个数据库持久层，往下与数据库通讯，往上与业务层通讯此层主要是处理 SQL，它在 XML 中进行定义service此包主要一个业务接口层或是业务接口层，对外提供业务接口与业务接口封装实现3.2 系统模块设计基础数据管理模块1、 客户代码维护规则：两位数字组成操作： C（增加） U （修改）

7、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（查询）

8、 D （删除）5、 产品类型维护 (type)规则：1代表 TD 智能手机2代表 WCDMA智能手机3代表 USB 产品类型数据卡5代表 USB 及 UART 串口混合类型的Module6代表 mini-PCIE接口类型的Module8代表普通手机操作： C（增加） U （修改） R（查询） D （删除）软件版本维护模块1、 新增版本上传完整版本文件："V" + 产品类别 + 产品型号 + "R" + 0-9 + 0-9 + "C" + 0-9 + 0-9 + "S" +客户代码 .zip，此完整版本文件与工具中所

9、用的版本文件不一样，它是需要可以支持终端自主写flash 的。上传步长为1 的升级包文件： update.zip ，如当前最新的版本为上传步长为2 的升级包文件： update.zip ，如当前最新的版本为上传步长为3 的升级包文件： update.zip ，如当前最新的版本为R06,那么此升级包提供给R05 版本；R06,那么此升级包提供给R04 版本；R06,那么此升级包提供给R03 版本；update.zip 文件大小不超过10M2、 发布版本发布 Bata 版本：用于测试发布 Release 版本3、 版本管理维护历史版本，针对Release版本不允许删除与修改，系统设置模块升级策略配

10、置：控制升级终端的数量，指定哪些型号，哪个客户可以升级。用户维护用户名命名规则：1 、只能以字母开头2 、区分大小写，3 、只能由字母与数字组成4 、用户名长度为 616角色维护WebService接口模块 (详见接口设计部分 )1、 最新版本查询HSWORK 处理查询请求流程UE查询版本时序图2、 终端信息上报3、 升级包下载4 接口设计4.1 终端通讯接口最新版本查询请求消息接口：GET /newversion HTTP/1.1 rnDate: Wed, 12 Apr 2011 17:50:00 GMTrnX-HOJY-Version: V1312R01C01S99rnX-HOJY- Au

11、thorization: HOJY_c8fdb181845a4ca6b8fec737b3581d76rn注：X-HOJY-Authorization验证码计算方法如下："X-HOJY-Authorization: HOJY_" + MD5(MD5(X-HOJY-IMEI + X-HOJY-SN) +“n”+ DATE +“n”+ RequestResource)其中：DATE 表示此次操作的时间RequestResource 表示 http 请求中的资源，如此样例中为：/newversionDATE 和 RequestResource 不能为空响应消息接口：HTTP/1.1

12、 200 OKDate: Wed, 01 Mar 2011 12:00:00 GMTContent-Type: application/xmlContent-Length: 302Connection: closeServer:HServer<?xml version="1.0" encoding="UTF-8"?><firmwareupdate><firmware><ver> V1312R01C01S99</ver><num>1</num><name>fir

13、mware name </name><desc_cn>简体中文描述</desc_cn><desc_en>firmware release Description</desc_en><md5>c61ce360a734c018685fbf5e1662c0fd</md5><size>16787</size><level>0</level><needbackup>0</needbackup><needrestart>0</need

14、restart><downloadurl></downloadurl><downloadurl></downloadurl></firmware></firmwareupdate>字段说明序号字段名意义1ver版本2num文件数量3name名称4desc_cn中文说明5desc_en英文说明6md5MD5检验码7size大小8level层级： 0- 无差分，完整升级；1- 部分差分；2- 完全差分；9needbackup是否需要备份：0- 不需要； 1- 需要；10 needrestart是否需要重启： 0- 不需要

15、； 1- 需要；11downloadurlupdate.zip下载 URL注：如无最新的版本则返回201 消息。样例如下：HTTP/1.1 201 OKDate: Wed, 01 Mar 2011 12:00:00 GMTContent-Length: 0Connection: closeServer:HServer终端信息上报请求消息接口：PUT /deviceinfo HTTP/1.00rnDate: Wed, 12 Apr 2011 17:50:00 GMTrnContent-Md5: c8fdb181845a4ca6b8fec737b3581d76rnContent-Type: tex

16、t/plainrn长度参考13-产品版本管理办法 A_2.pdf 中嵌入式软件版本长度32255备注暂不启用，默认值为：1暂不启用暂不启用暂不启用暂不启用，默认值为：0暂不启用，默认值为：0暂不启用，默认值为：0X-HOJY- Authorization: HOJY_c8fdb181845a4ca6b8fec737b3581d76rn$data响应消息接口：HTTP/1.1 200 OKDate: Wed, 01 Mar 2011 12:00:00 GMT升级包下载4.2 业务系统用户接口登录界面主体界面新增版本信息发布升级包5 可测试性设计日志输出private static final L

17、ogger logger = LoggerFactory.getLogger(AjaxController.class);logger.debug("Received request to get all users");目录： $TOMCAT/logs日志文件： catalina.out6 可移植性设计OSS 部分将会与GOOGLE ，亚马逊API 集成Interface CloudStorageDrive/ TODO 输入你的 accessId 和 accessKey static String accessId;static String accessKey; sta

18、tic String ossEndpoint;/ TODO 输入你的 bucket 名称public static String bucketName = "hswork"/ TODO 输入你的object 名称public static String objectName = "update.zip"/上传文件接口public static void uploadFile()throws Exceptionpublic static void deleteFile()throws Exception/ 阿里云存储服务Class AliOss implements CloudStorageDrive / 亚马逊云存储服务Class AmazonS3Ex implements CloudStorageDrive 7 异常设计7.1 软件系统的异常描述针对上传更新包，由于系统限制为最大的升级步长，则需要判