TWS软件体系结构设计文档

1、TWS 体系结构设计文档TWS 体系结构设计文档小组成员: * 时间：2009/4 1TWS 体系结构设计文档2摘要：针对FastRepair公司提出的要求，总结出了用户需求，首先写出需求规格说明书，并画出用例图，对各个需求做具体分析讨论。其次，根据对用户需求的总结，选择出一种合适的体系结构风格。然后，根据质量属性，对工具仓库管理系统（简称TWS）进行体系结构设计。随后选择一种主流商业架构给出员工工具管理系统（简称ETMS）详细设计的体系结构图，给出了具体的分析。运用ATMA评估方法对仓库管理系统（简称WMS）软件体系结构进行了评估。最后，分别对ETMS 和WMS 进行简单构建与实现，并对整个

2、系统做了总体的分析与评价。 目录1问题描述.4 2 需求分析和 TWS 用例图 .5 2.1序.5 2.1.1编写需求规格说明书的目的.5 2.1.2 项目背景.6 2.1.3定义.6 2.1.4参考资料.6 2.2软件产品的一般性描述.6 2.2.1运行环境与资源.6 2.2.2 软件产品的功能.7 2.2.3用户特征.7 2.2.4限制与约束.8 2.3功能行为需求.8 2.3.1用例图.8 2.3.2参与者.9 2.3.3相应用例展开.10 2.3.3.1登录注册.10 2.3.3.2管理个人信息. 11 2.3.3.3管理普通工具.12 2.3.3.4管理贵重工具.13 2.3.3.5

3、查询.14 2.3.3.6租借工具.15 2.3.3.7仓库维护.15 2.3.3.8抓取工具.16 2.3.3.9维修请求.17 2.3.3.10传送工具.17 TWS 体系结构设计文档32.4性能需求.18 2.4.1数据精确度.18 2.4.2时间特性（响应，传输，运行时间等）.18 2.4.3适应性（运行环境，计划发生变化的响应等应具有的适应能力） .18 2.4.4故障处理.19 2.5运行需求.19 2.5.1用户界面.19 2.5.2硬件界面.19 2.5.3软件界面.19 2.6其他要求.19 3体系结构风格分析.20 3.1引言.20 3.2设计考虑因素.20 3.3体系结构

4、风格的选择.21 3.3.1 ETMS 的风格.21 3.3.2 WMS 的风格.23 4质量属性及体系结构设计.25 4.1背景描述.25 4.2 ETMS 系统质量属性分析 .26 4.3 WMS 系统质量属性分析 .27 5在 JAVA.EE 下 ETMS 的体系结构.29 5.1对于 java.ee 商业架构的一些叙述.29 5.2具体设计.30 5.2.1 具体的结构设计.30 5.2.2 架构具体设计.30 5.2.3连接件的描述.32 5.2.4 EJB 的具体实现结构设计.32 5.3 总结陈述.34 6WMS 体系结构的 ATAM 架构评估 .34 6.1 ATAM 方法的描

5、述.34 2.1.1 概述.34 2.1.2 质量属性.34 2.1.3 敏感点与折衷点.35 6.2商业动机的描述.35 6.3场景集合.35 6.4每个场景的构架方法分析.36 6.4.1场景 1：重名的用户采用的是同样的注册信息.36 6.4.2场景 2：用户登录时用户名或密码输入错误.36 6.4.3场景 3：用户按下“登录”按钮后系统没有反应 .37 6.4.4场景 4：平台总服务器无响应.37 6.4.5场景 5：各子公司仓库服务器状态不一致.38 6.4.6场景 6：查看工具详细信息时出现信息不对应.38 6.4.7场景 7：管理员添加了重名的工具.38 6.4.8场景 8：管理

6、员删除用户正在使用的工具.39 TWS 体系结构设计文档46.4.9场景 9：管理员修改用户正在使用的工具信息.39 6.5所确定的敏感点和权衡点集合.40 6.5.1 敏感点集合.40 6.5.2 权衡点集合.40 6.6 有风险和无风险决策.41 6.6.1 有风险决策.41 6.6.2 无风险决策.41 7ETMS 和 WMS 的构建、实现与演示.42 8综合分析与评估.46 1 问题描述FastRepair®是一家大型的跨国机械电子修理公司，建立于 1980年。公司总部位于美国印第安纳州，印第安纳波利斯。目前公司总部有超过 10000人的全职雇员。该公司拥有 8家较小的子公司

7、，位于整个美国境内，每个子公司的全职员工人数在 3000到 9000之间。公司的每一个员工都有两类工具（Tool），每类工具有50-100件左右。第一类工具是放入员工工具箱中的一组常用廉价工具（Inexpensive Tool），另外一类是一些贵重的工具（Expensive Tool）。对于工具箱中的廉价工具，员工在领取 时 需 要 进 行 登 记 （ Register ）， 自 行 保 管 ， 但 在 损 坏 时 需 要 进 行 注 销（Cancellation）。而对于贵重工具（>200$的工具），必须通过工具仓库管理系统进行统一管理。在使用时需要办理租借（Lend）手续。需要注意的

8、是，对于一般员工，只能借与自己专长相关的工具（也就是本部门内的工具），而对于专家，则可以借所有类型的工具。由于工具种类庞杂，数量巨大；某些工具重量也很大；且分布在不同的地理位置。FastRepair 决定开发一套工具仓库管理系统（Tool Warehouse System, TWS）。TWS 主要分为两个部分，第一部分是员工与工具信息管理系统（Employ and Tool Management System, ETMS），详细记录工具的借、还与工具状态，公司内部员工可以通过本地企业局域网（Intranet）查询自己工具的借还情况，并发出TWS 体系结构设计文档对贵重工具的请求。对于本地没有的

9、特殊工具，员工可以使用 ETMS 通过互联网（Internet）在总公司或各个子公司的仓库中查找特定工具，并发出借用该工具的请求。第二部分是一个仓库的实时管理系统（Warehouse Management System , WMS），位于总公司和每个子公司的工具仓库，在提取具体工具时，用户需要到具体的工具仓库进行工具的提取（也可以在工具仓库现场借工具）。FastRepair 对WMS的具体要求如下。 5仓库的实时管理系统中存在多个工具抓取机器人，每个机器人都可从货柜上 获取工具并将其放在工具传送带上，工具传送带装置根据重量传感器得知是否有工具在传送带上，并将工具传送到出口处。 用户在仓库的出口

10、处向仓库管理员提交工具租借请求，由管理员将该请求输 入仓库控制电脑，电脑将控制仓库中的机器人抓取相应的工具并将其放到工具传送带上，一旦机器人出现故障，将通知控制电脑以便及时进行维修。带开发的软件系统需要能够将分布在控制电脑，机器人以及工具传送带上。（不考虑工具归还系统） 2 需求分析和 TWS 用例图2.1序2.1.1 编写需求规格说明书的目的此需求规格说明书对 Tool Warehouse System 软件做了全面细致的用户需求分析，明确所要开发的软件应具有的功能、性能与界面，使系统分析人员及软件开发人员能清楚地了解用户的需求，并在此基础上进一步提出概要设计说明书和完成后续设计与开发工作。

11、本说明书的预期读者为客户、业务或需求分析人员、测试人员、用户文档编写者、项目管理人员。TWS 体系结构设计文档2.1.2 项目背景FastRepair®是一家大型的跨国机械电子修理公司，建立于 1980年。公司总部位于美国印第安纳州，印第安纳波利斯。目前公司总部有超过 10000人的全职雇员。该公司拥有 8家较小的子公司，位于整个美国境内，每个子公司的全职员工人数在 3000到 9000之间。6FastRepair 的 业 务 主 要 涉 及 四 个 领 域 ： 大 型 建 筑 设 备 修 理（ ConstructionDevice Repair ）、 汽 车 修 理 （ Autom

12、obile Repair ）、 家 电 修 理（Appliance Repair）和计算机修理（Computer Repair），相应的划分为四个大的部门（Department）。每个公司的普通员工（Employee）隶属于一个部门。高级员工（Specialist）独立于任何部门。公司的每一个员工都有两类工具，每类工具有 50-100件左右。第一类工具是放入员工工具箱中的一组常用廉价工具，另外一类是一些贵重的工具。由于工具种类庞杂，数量巨大；某些工具重量也很大；且分布在不同的地理位置。所以 FastRepair 决定开发一套工具仓库管理系统以解决上述问题。2.1.3 定义1）工具仓库管理系统（

13、Tool Warehouse System,TWS）2）员工与工具信息管理系统（Employ and Tool Management System, ETMS）3）仓库的实时管理系统（Warehouse Management System ,WMS）2.1.4 参考资料project-本-20102.2软件产品的一般性描述2.2.1 运行环境与资源1）操作系统：windows XP 及以上操作系统。2）数据库管理系统：SQLlte。3）开发工具：Microsoft Visval C+ 6.0。4）本系统是基于 C/S 结构的。并根据 TCP/IP 协议管理系统。TWS 体系结构设计文档5）公司

14、内部员工可以通过本地企业局域网（Intranet）访问本系统。也可以使用ETMS 通过互联网（Internet）访问。2.2.2 软件产品的功能如图 2-1 所描述：仓库工具信息工具租借7仓库管理员2.2.3 用户特征用户工具信息仓库管理描述TWS 图 2-1 TWS 关联图表 2-1 个人信息工具管理员工员工公司所用的全职雇员。公司总部有超过10000人的全职雇员。该公司拥有的的8家子公司各有 3000到 9000的全职员工。员工分为普通员工和高级员工。普通员工根据自己的专业特 长 隶属 于 一个 部门 ， 而 具 有跨 行业 技 能的 高 级员 工TWS 体系结构设计文档（Speciali

15、st）独立于任何部门。仓库管理员主要负责对仓库的维护，接受员工的租借请求提取仓库中的工具，接受仓库机器人的维修请求。管理员仓库管理员需要具备相关的专业技能，需要接受培训以更好地管理该系统2.2.4 限制与约束81) 员工有两类工具（Tool）廉价工具（Inexpensive Tool）和贵重工具（Expensive Tool）。对于工具箱中的廉价工具，员工在领取时需要进行登记（Register），自行保管，但在损坏时需要进行注销（Cancellation）。而对于贵重工具（>200$的工具），必须通过工具仓库管理系统进行统一管理。在使用时需要办理租借（Lend）手续。2）普通员工，只能借

16、本部门内的工具，高级员工，可以借所有类型的工具。2.3功能行为需求2.3.1 用例图如图 2-2 所示：TWS 体系结构设计文档TWS 员工 机器人 管理普通工具 管理贵重工具查询登录注册管理个人信息 抓取工具维修请求租借工具仓库维护ETWS 9仓 库管理员 传送带2.3.2 参与者主要参与者WMS 传送工具图 2-2 TWS 用例图表 2-2 用例TWS 体系结构设计文档员工仓库管理员2.3.3 相应用例展开2.3.3.1 登录注册用例 ID UC-1 用例名称登录注册初始参与者员工，仓库管理员登录注册管理个人信息管理普通工具管理贵重工具登录注册管理个人信息租借工具仓库维护表 2-3 10描

17、述前置条件后置条件主要过程用户通过客户端向服务器发送登录请求，服务器端验证用户密码，通过则进入主界面，否则提示登录错误信息。通过客户端注册新用户，将用户信息存储在服务器上。已注册的员工才能登录。已登录本地企业局域网（Intranet）用户置为已登录状态a. 1. 已注册用户在客户端选择用户类别（员工或仓库管理员），输入用户名，密码等信息后，发送登录请求2. 服务器端接受请求，验证用户名信息是否完整和正确3. 验证通过，进入主界面，用例终止b. 1. 没有注册的用户填写注册表（用户种类,用户名,密码,部门等信息）并提交TWS 体系结构设计文档2. 服务器端接收到注册信息，检查信息完整性及合法性1

18、1分支过程异常3. 服务器端检查通过，存储新用户信息，并提示注册成功，返回主界面，用例终止E1验证时间超时1. 客户端提示连接超时2a用户选择返回重新登录2b用户退出，客户端关闭，用例终止E2用户名或密码不正确或未注册1. 客户端系统提示用户名或密码不正确或未注册2a用户选择重新登录2b用户选择注册2c用户退出，客户端关闭，用例终止E3当前用户已经登录1. 客户端系统提示当前用户已经登录2a用户端返回重新登录2b用户退出，客户端关闭，用例终止E4. 输入信息不完整或不合法1. 客户端提示注册信息出错2a. 用户选择重试2b. 用户退出，客户端关闭，用例终止2.3.3.2 管理个人信息用例 ID

19、 UC-2 用例名称管理个人信息初始参与者员工，仓库管理员表 2-4 描述用户在客户端浏览并修改个人信息，将修改结果发送到服务器，TWS 体系结构设计文档服务器端更新用户个人信息前置条件用户已登录进入系统后置条件无主要过程用户从主界面进入“管理个人信息”界面客户端从服务器端获取当前用户个人信息并显示用户在客户端根据需要对个人可修改信息进行修改，并提交修改后的数据从客户端发送到服务器端，服务器端进行更新更新完毕后提示修改完成，返回主界面，用例终止异常E1提交后服务器端响应时间超时2a用户选择返回重试2b用户退出，客户端关闭，用例终止E2. 输入信息不完整或不合法客户端提示新提交的信息出错2a.

20、用户选择重试，返回“管理个人信息”界面2b. 用户选择退出，返回主界面，用例终止2.3.3.3 管理普通工具表 2-5 用例 ID UC-3 用例名称工具登记注销初始参与者员工12描述前置条件后置条件主要过程系统输出员工的普通工具，用户可对每个工具项进行登记或注销操作（领取常用工具时需要登记，在损坏时需要注销）用户已登录进入系统系统显示出该用户所有普通工具用户对任意工具项进行登记或注销操作，并提交TWS 体系结构设计文档修改后的数据从客户端发送到服务器端，服务器端进行更新更新完毕后提示修改完成，返回管理普通工具界面，用例终止分支过程异常E1连接时间超时客户端提示连接超时2a用户选择返回重试2b

21、用户退出，客户端关闭，用例终止2.3.3.4 管理贵重工具表 2-6 用例 ID UC-4 用例名称管理贵重工具初始参与者员工13描述前置条件后置条件主要过程分支过程异常系统输出该员工已租借或已预定的所有贵重工具信息，用户可对预定工具项进行取消预定操作，查询工具操作员工已登录系统无系统显示该员工已租借或已预定的所有贵重工具信息用户对预定工具项进行取消预定操作员工进行查询操作用户选择退出，返回主界面，用例终止查询E1提交时间超时（第 1 步）客户端提示提交超时，操作失败2a选择重试2b选择退出，返回管理贵重工具界面，用例终止TWS 体系结构设计文档2.3.3.5 查询用例 ID UC-5 用例名

22、称查询初始参与者员工表 2-7 14描述前置条件后置条件主要过程分支过程异常用户在客户端查询特定工具，服务器端接收请求，查询并显示工具详细信息，用户可预定工具员工已登录系统无员工在客户端输入工具的名称，或功用，提交查询请求服务器端接收请求，查询并显示工具详细信息用户可对工具选择预定用户选择返回，进入管理贵重工具界面，用例中止无E1查询时间超时1.客户端提示查询超时2a选择重试2b选择退出，返回主界面，用例终止E2无与查询相关的信息1. 客户端系统提示无相关信息2a用户检查或更改查询信息，重新查询2b用户退出，返回主界面，用例终止E3用户没有预定所选工具权限1. 客户端系统提示当前用户没有权限用

23、户退出，返回查询界面，用例终止TWS 体系结构设计文档2.3.3.6 租借工具用例 ID UC-6 用例名称租借工具初始参与者管理员表 2-8 15描述前置条件后置条件主要过程分支过程异常管理员接受来自员工的请求，从仓库租借工具管理员已登录进入系统无管理员进入客户端的“租借工具”界面管理员在客户端填写员工信息，所需工具，并提交服务器端接受信息，向 TMW 发出提取该工具命令E1获取信息超时1系统提示超时错误2返回租借工具界面，用例结束E2提交后响应时间超时1系统提示超时错误2回到“租借界面”，用例结束E3. 未预定1 . 进入预定界面，用例结束E4 仓库中当前没有该工具或已被别人预先预定系统提

24、示相应错误，返回主界面，用例结束2.3.3.7 仓库维护用例 ID UC-7 用例名称仓库维护初始参与者仓库管理员表 2-9 描述仓库管理员添加或删除工具TWS 体系结构设计文档层次前置条件管理员已登录进入系统后置条件无主要过程管理员进入客户端的“仓库管理”界面仓库管理员填写要修改工具名称管理员对某个用户的详细信息进行浏览/修改，并提交服务器端接受到修改后的信息，进行更新更新后提示修改成功，用例终止分支过程异常E1获取列表信息超时（第 2 步）1系统提示超时错误2回到管理员登录界面，用例结束E2提交后响应时间超时（第 3 步）1系统提示超时错误2回到管理员登录界面，用例结束2.3.3.8 抓取

25、工具表 2-10 用例 ID UC-8 用例名称抓取工具初始参与者机器人16描述层次前置条件后置条件主要过程机器人获得控制电脑的命令，从货柜上获取工具并将其放在工具传送带上无机器人获得下一个抓取工具命令机器人从货柜上获取所需工具将其放在工具传送带上，用例终止TWS 体系结构设计文档分支过程异常E1获取列表信息超时（第 2 步）1系统提示超时错误2回到管理员登录界面，用例结束E2提交后响应时间超时（第 3 步）1系统提示超时错误2回到管理员登录界面，用例结束2.3.3.9 维修请求表 2-11 用例 ID UC-9 用例名称注册初始参与者普通用户描述用户通过客户端注册新用户，将用户信息存储在服务

26、器上层次前置条件安装有客户端后置条件无主要过程点击客户端的“注册”进入注册界面用户输入要注册的用户名、密码、用户信息等，并提交服务器端接收到注册信息，检查信息完整性及合法性服务器端检查通过，存储新用户信息更新后提示注册成功，返回登录界面，用例终止分支过程异常2.3.3.10 传送工具表 2-12 用例 ID UC-10 用例名称传送工具17TWS 体系结构设计文档初始参与者传送带18描述前置条件后置条件主要过程分支过程异常工具传送带装置根据重量传感器得知是否有工具在传送带上，并将工具传送到出口处无工具传送带装置根据重量传感器得知有工具在传送带上将工具传送到出口处，用例终止2.4 性能需求2.4.1