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

《业务系统软件概要设计说明书.docx》由会员分享，可在线阅读，更多相关《业务系统软件概要设计说明书.docx（19页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、.深圳市华域无线技术有限公司深圳市华域无线技术有限公司密级文档编号软件概要设计说明书软件概要设计说明书页数共页版本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修改接口：最新版本查询接口，验证码计算方法

2、，去除 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引言引言.11.1 目的.11.2 范围.11.3 定义.11.4 参考资料.12软件系统状态与交互描述软件系统状态与交互描述.12.1 软件系统结构和层次结构.12.2 软件系统原理描述.22.3 软件系统交互描述.23软件系统设计软件系

3、统设计.33.1 软件设计概念和原理.33.2 系统模块设计.34接口设计接口设计.74.1 终端通讯接口.74.2 业务系统用户接口.95可测试性设计可测试性设计.116可移植性设计可移植性设计.117异常设计异常设计.127.1 软件系统的异常描述.127.2 软件系统的风险描述.128其他设计其他设计.128.1 配置设计.128.2 数据库设计.149附录附录.149.1 软件开发环境.149.2 软件生产环境.159.3 关键点的附录.151 引言1.1 目的本设计文档的输入文档为HSWORK解决方案。它主要的目标是细化系统软件功能模块，定义系统软件架构，定义通讯接口，设计数据库结构

4、及相关运行环境的配置等。1.2 范围1.2.1本文档适用于 HSWORK 项目1.2.2本文档适于开发人员，测试人员以及后续开发的设计人员1.3 定义UE：user equipment 用户设备HSWORK：华域升级业务系统OSS：Open Storage Service 阿里巴巴云计算公司提供的开放云存储服务1.4 参考资料13-产品版本管理办法 A_2.pdf2 软件系统状态与交互描述2.1 软件系统结构和层次结构图中HSWORK业务系统业务系统部分为本文档设计部分。2.2 软件系统原理描述1、发布版本:1,1、制作升级包，将它放在阿里的云存储中。1.2、新增版本信息，配置策略2、查询版本

5、信息3、返回当前版本信息，如果有更新，则返回升级包下载地址4、下载升级包5、终端升级2.3 软件系统交互描述系统软件设计图说明：1、界面链接请求，view控制器处理请求；2、view控制器加载界面内容；3、view控制器将界面内容，返回给浏览器；4、如遇到界面为Grid，则发送ajax请求；json控制器负责处理ajax数据请求；5、Json控制器准备好格式化数据；6、Json控制器通过调用service封装好的业务服务方法生成所需的json数据；7、将JSON数据返回浏览器，浏览器将会通过jqgrid将数据呈现给用户；3 软件系统设计3.1 软件设计概念和原理controller此包主要用于

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

7、品型号+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 串口混合类型的 Module6 代表 mini-PCIE 接口类型的 Module8 代表

8、普通手机操作：C（增加）U（修改）R（查询）D（删除）3.2.2软件版本维护模块1、新增版本上传完整版本文件：V+产品类别产品类别+产品型号产品型号+R+0-9+0-9+C+0-9+0-9+S+客户代码客户代码.zip，此完整版本文件与工具中所用的版本文件不一样，它是需要可以支持终端自主写flash 的。上传步长为 1 的升级包文件：update.zip，如当前最新的版本为 R06,那么此升级包提供给 R05 版本；上传步长为 2 的升级包文件：update.zip，如当前最新的版本为 R06,那么此升级包提供给 R04 版本；上传步长为 3 的升级包文件：update.zip，如当前最新的版

9、本为 R06,那么此升级包提供给 R03 版本；update.zip 文件大小不超过 10M2、发布版本发布 Bata 版本：用于测试发布 Release 版本3、版本管理维护历史版本，针对 Release 版本不允许删除与修改，3.2.3系统设置模块升级策略配置：控制升级终端的数量，指定哪些型号，哪个客户可以升级。用户维护用户名命名规则：1、只能以字母开头2、区分大小写，3、只能由字母与数字组成4、用户名长度为 616角色维护3.2.4WebService 接口模块(详见接口设计部分)1、最新版本查询HSWORK处理查询请求流程UE查询版本时序图2、终端信息上报3、升级包下载4 接口设计4.

10、1 终端通讯接口4.1.1最新版本查询请求消息接口：请求消息接口：GET/newversion HTTP/1.1 rnHost: rnDate:Wed,12Apr 2011 17:50:00 GMTrnX-HOJY-Version:V1312R01C01S99rnX-HOJY-Authorization:HOJY_c8fdb181845a4ca6b8fec737b3581d76rnX-HOJY-IMEI:12234567890000rnX-HOJY-SN:1234567898888rnrn注：注：X-HOJY-Authorization 验证码计算方法如下：验证码计算方法如下：X-HOJY-A

11、uthorization:HOJY_+MD5(MD5(X-HOJY-IMEI+X-HOJY-SN)+“n”+DATE+“n”+RequestResource)其中：其中：DATE 表示此次操作的时间表示此次操作的时间RequestResource 表示表示 http 请求中的资源，如此样例中为：请求中的资源，如此样例中为：/newversionDATE 和和 RequestResource 不能为空不能为空响应消息接口：响应消息接口：HTTP/1.1 200 OKDate:Wed,01 Mar 2011 12:00:00 GMTContent-Type:application/xmlConte

12、nt-Length:302Connection:closeServer:HServer V1312R01C01S991firmware name 简体中文描述firmware release Descriptionc61ce360a734c018685fbf5e1662c0fd16787000http:/10.0.0.1/hswork/update.ziphttp:/10.0.0.2/hswork/update.zip字段说明序号字段名意义长度备注1ver版本参考13-产品版本管理办法 A_2.pdf 中嵌入式软件版本长度2num文件数量暂不启用，默认值为：13name名称暂不启用4desc_

13、cn中文说明暂不启用5desc_en英文说明暂不启用6md5MD5 检验码327size大小8level层级：0-无差分，完整升级；1-部分差分；2-完全差分；暂不启用，默认值为：09needbackup是否需要备份：0-不需要；1-需要；暂不启用，默认值为：010needrestart是否需要重启：0-不需要；1-需要；暂不启用，默认值为：011downloadurlupdate.zip 下载 URL255注：如无最新的版本则返回 201 消息。样例如下：HTTP/1.1 201 OKDate:Wed,01 Mar 2011 12:00:00 GMTContent-Length:0Conne

14、ction:closeServer:HServer4.1.2终端信息上报请求消息接口：请求消息接口：PUT/deviceinfo HTTP/1.00rnHost:rnDate:Wed,12Apr 2011 17:50:00 GMTrnContent-Md5:c8fdb181845a4ca6b8fec737b3581d76rnContent-Type:text/plainrnX-HOJY-Authorization:HOJY_c8fdb181845a4ca6b8fec737b3581d76rnX-HOJY-IMEI:12234567890000rnX-HOJY_SN:1234567898888r

15、nrn$data响应消息接口：响应消息接口：HTTP/1.1 200 OKDate:Wed,01 Mar 2011 12:00:00 GMT4.1.3升级包下载4.2 业务系统用户接口登录界面主体界面新增版本信息发布升级包5 可测试性设计日志输出private static final Logger logger=LoggerFactory.getLogger(AjaxController.class);logger.debug(Received request to get all users);目录：$TOMCAT/logs日志文件：catalina.out6 可移植性设计OSS 部分将会

16、与 GOOGLE，亚马逊 API 集成Interface CloudStorageDrive/TODO 输入你的 accessId 和 accessKeystatic 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 up

17、loadFile()throws Exceptionpublic static void deleteFile()throws Exception/阿里云存储服务ClassAliOss implements CloudStorageDrive/亚马逊云存储服务ClassAmazonS3Ex implements CloudStorageDrive 7 异常设计7.1 软件系统的异常描述针对上传更新包，由于系统限制为最大的升级步长，则需要判断最新版本与基础版本的步长是否大于 3，如果是，则需要提醒用户，异常数据。7.2 软件系统的风险描述无。8 其他设计8.1 配置设计部署数据库初始化配置系统数

18、据持久层配置系统登录鉴权配置8.2 数据库设计9 附录9.1 软件开发环境开发框架：Spring 3.1.0+MyBatis+jQuery1.7.2+jqGrid 4.1.1+jQuery UI 1.8.19数据库：mysql 5.0+Web服务器：tomcatJDK环境：jdk7+开发环境：JSP、MYSQL：xampp-win32-1.7.7-VC9.7z开发工具：springsource-tool-suite-2.9.1.RELEASE-e3.7.2-win32.zip9.2 软件生产环境数据库：mysql 5.0.8Web服务器：CentOS release 5.7+Tomcat/7.0.27JDK环境：jdk 1.7.0_02-b139.3 关键点的附录说明软件系统引用的关键技术，关键算法，关键接口等，在上面不好展开说明，都可在附录详细描述。