路障跟踪与维修系统总体设计说明书.doc

路障跟踪与维修系统 Software Engineering 路障跟踪与维修系统总体设计说明书姓名XXX年级20XX级院系XXX学院专业计算机科学与技术时间20XX.X.X 目录1. 引言.- 6 - 1.1 编写目的.- 6 - 1.2 背景.- 6 - 1.3 定义.- 6 - 1.4 参考资料.- 6 -2. 总体设计.- 7 - 2.1 需求分析.- 7 - 2.1.1 系统功能.- 7 - 2.1.2 系统性能.- 8 - 数据精度.- 8 - 时间特性要求.- 9 - 可靠性.- 9 - 稳定性.- 9 - 适应性.- 10 - 可维护性.- 10 - 2.1.3 输入输出要求.- 10 - 2.1.4 数据管理能力要求.- 10 - 2.1.5 故障处理要求.- 11 - 2.1.6 其他专门要求.- 11 - 2.2 运行环境.- 11 - 2.2.1 设备.- 11 - 2.2.2 支持软件.- 12 - 2.2.3 接口.- 13 - 硬件接口.- 13 - 软件接口.- 13 - 控制.- 13 - 2.3 基本设计概念和处理流程.- 13 - 2.3.1 系统建设的原则.- 13 - 2.3.2 基本设计概念.- 14 - 2.3.3 ACD图.- 14 - 2.3.4 原型图.- 15 - 2.3.5 映射DFD到层次结构图.- 16 - DFD总图.- 16 - Level-1层次结构图.- 17 - Level-2层次结构图.- 18 - 2.3.6 体系结构风格.- 20 - 2.3.7 处理流程.- 20 - 2.4 功能需求与系统模块的关系.- 21 - 2.5 人工处理过程.- 22 -3.接口设计.- 22 - 3.1 用户接口 （市民的接口）.- 22 - 3.1.1 主界面.- 22 - 3.1.2 登陆界面.- 23 - 3.1.3 注册界面.- 24 - 3.1.4 找回密码界面.- 24 - 3.1.5 功能列表.- 25 - 3.2 外部接口.- 29 - 3.3 内部接口.- 29 - 3.3.1 类1：用户类.- 29 - 3.3.2 类2：查询类.- 30 - 3.3.3 信息显示.- 30 - 4. 运行设计.- 31 - 4.1 运行模块组合.- 31 - 4.2 运行控制.- 32 - 5.系统数据库结构设计.- 33 - 5.1逻辑结构设计要点.- 33 - 5.1.1用户个人资料数据库.- 34 - 5.1.2路障信息数据库.- 34 - 5.1.3 施工命令数据库.- 34 - 5.1.4 损失报告数据库.- 35 - 5.1.5施工队信息数据库.- 36 - 5.1.6 路障工具数据库.- 36 - 5.2 物理结构设计要点.- 37 - 5.3 数据结构与程序关系.- 37 -6.系统出错处理设计.- 38 - 6.1出错信息.- 38 - 6.2 补救措施.- 39 - 6.3 系统维护设计.- 40 - 1. 引言1.1 编写目的 本说明书为路障跟踪与维修系统的总体设计说明书，详细阐述了系统建立一个损失报告文件，记录此路障造成的损失所提出的设计方案，对系统中的各项功能需求、技术需求、实现环境及所使用的实现技术进行了明确定义。同时，对软件应具有的功能和性能及其他有效性需求也进行了定义。此外，本说明书还明确了系统的数据结构和软件结构，还将给出内部软件和外部系统部件之间的接口定义，各个软件模块的功能说明，数据结构的细节以及具体的装配要求。1.2 背景 路障跟踪与维修系统建立一个损失报告，记录此路障造成的损失，包括市民的姓名、地址、电话、损失类型、以及损失量。帮助有关部门提供更多更确切的路障信息，以此来更好的管理街道。1.3定义 （1）PHTRS是一个在线系统,可以帮助用户查询. （2）Windows 2000/2003/Xp: 运行环境。 （3）VC+：软件开发语言1.4 参考资料软件工程-实践者之路（第六版）信息系统分析与设计杨选辉，清华大学出版社Visual Basic管理信息系统开发案例武新华，西安电子科技大学出版社2. 总体设计2.1需求分析 本路障跟踪与维修系统是专门为某市政部门开发的，主要是为了让民众可以网上上报路障并由相关的部门及时的派出维修队伍。于此同时，记录路障的具体信息、维修路障的施工命令和最后的损失报告文件。并支持一般用户和相关的人员在网上同步的查询路障维修的各种信息。 该系统可以帮助相关部门更好的跟踪路障、分配施工工具和队伍、统计路障所带来的损失。同时也可以让大家及时的了解到路障维修的最新状况和各种消息。此系统对于实时性的要求比较高，因为要即时的去维修一些比较的紧急的路障。也要求有一个可以判断信息是否正确的系统，这样就可以避免一些不必要的损失。 2.1.1系统功能 该软件是为一般民众上报路障、相关部门进行路障评判、施工队伍的派出和最后的损失报告文件的提交提供一些便利。让各种信息及时的提交到网上，然后大家都可以在网上及时的查看路障的各种信息。也是让相关部门在最快的时间内对某个路障做出一定的反应，减少路障带来的损失。 本系统主要分成两个部分：外部功能和内部功能 1.外部功能：实现可视化窗口，主要是登录、提交信息及查找信息的窗口； 2.内部功能 （1）用户登录系统：向用户提供必要的用户名和密码，并且还要位第一次登录的用户提供一个注册链接。同时，还给不同类型的用户给不同的权限。 （2）路障上报系统：该功能提供给所有的用户。主要是提供一个界面可以让用户提交有关路障的信息。且该信息主要包括：街道地址、大小（按1比10的比例）、位置（路中、人行道上等等）。还可以自动生成路障的识别号码、）、所属街区（根据街道地址得出）、以及维修优先级（根据其大小确定）。另外还附带一个信息确认功能，主要是有两个状态，需要上级部门在确认信息之后，修改该状态。 （3）施工命令系统：该系统要在信息确认之后，才会起作用。主要是给施工队伍下达施工命令。主要包括：路障位置、大小、施工队编号、施工人数、配备工具、维修的工时数，路障状态（施工中、已修复、临时修复、未修复）、材料用量、维护费用（根据维修工时、人数、材料及工具等计算得出）。 （4）损失报告系统：该系统是由施工队伍填报。一般用户不可以进入该界面。主要包括：市民的姓名、地址、电话、损失类型、以及损失量（以元为单位）。并由提交和修改功能。 （5）PHTRS在线查询系统：这个系统提供给每一个用户的。主要是要用户输入要查询的一个信息，就可以得出其他的相关信息。 2.1.2系统性能 数据精度 该系统中用到很多的数据，其中的一些数据的精度要求较高，而另外一些则不是那么高。 街道的大小很重要，因为优先级就是按这个来定的。要求是小数点后一位。这样可以避免太多的街道位于同一优先级上。（如：12.2） 至于施工编号则是系统自动生成。只要求是有一定的区别就好。（如20111016044，表示2011/10/16的第044件路障）. 在损失量上面来看，要求不是很高。以元为单位，只要是小数点后一位就可以了。（如：23.8元）对于数据的要求是按照共利者的具体需求而来。 时间特性要求 时间特性要求主要描叙该系统运行过程中，各个环节所需要的大概的时间。而且这里所说的时间特性是基于后面所说的硬件、软件平台和网络而言。系统响应时间：一般控制在1分钟以内。数据传输与传输时间：大概在1分钟左右。更新处理时间：一般是1分钟更新一次。 可靠性 该系统主要是基于用户提供的路障维修信息，之后采取一系列的动作。因为用户要提供一个路障信息时，要求他又注册过，提交过自己的个人信息。所以路障信息在一定程度上市有保证的。而且路障信息还要通过管理员的审核，才会给施工队伍发送施工命令。 稳定性 系统在设计时应注意风格统一，使系统可调试性良好，尽可能把系统的错误消灭在调试阶段，系统一旦交付使用，就应该有很好的稳定性。 适应性 开发基于的平台要考虑向上兼容性，如操作系统，数据库等要考虑个更高版本的兼容性。 当需求发生变化时系统应具有一定的适应能力，要求系统能够为将来的变更提供以下的支持：能够在系统变更用户界面和数据库设计，甚至在更新后，系统的现有设计和编码能够最大程度的重用，以保护现阶段的投资和保证软件系统能够在较少后续投入的情况下适应的扩展和更新。 可维护性 系统在设计时应备齐各类文档，操作人员只需阅读文档就可以知道所有的操作。维护人员可以通过文档了解系统结构、设计思路，以便快速掌握整个系统。程序设计时应保持良好的变成风格，结构清晰、注释明确，使调试、测试人员能快速定位各种错误。 2.1.3 输入输出要求输入：一般为键盘输入，结合鼠标使用。输出：一般为屏幕输出。 2.1.4 数据管理能力要求要求数据库具有较好的更新能力，对磁盘内存也是较高的，因为随着用户的增加，信息会越来越多。同时，也要求数据库应该能够对并发时间和错误信息有较强的处理能力。 2.1.5 故障处理要求 通讯故障：用户、管理员和维修队员的个人电脑和系统服务器不能通讯，导致整个系统瘫痪，应检查通讯线路及设置，保证网络通讯畅通。 数据服务故障：数据无法访问，业务暂停，应有备件或备机代替。 2.1.6 其他专门要求（1）必须保证该系统可以连接在线网络，并且基本所有的用户的个人电脑可以访问。（2）保证在网络繁忙的时候，还是可以处理用户提交上来的信息。（3）必须能够判定用户交上来的信息是不是重复的。如果是已经处理该路障，就要给用户一个提示。2.2 运行环境本系统运行环境为PC机（需保证联网），内存的最低要求96MB。支持的操作系统为windows或linux等；开发软件为java,web。 2.2.1 设备 已联网的PC机 处理器：450 megahertz (MHz) Pentium -class processor600 MHz Pentium -class process recommended 最小内存：Microsoft Windows Server 2003 160 megabtyes(MB)Windows XP Professional 160 MBWindows XP Home Edition 96 MBWindows 2000 Professional 96 MBWindows 2000 Server 192 MB 硬盘空间：20 MB可用硬盘空间 显示器：256色VGA（1024X768）或更高分辨率显示器。 2.2.2 支持软件 支持以下操作系统：Microsoft Windows Server 2003Windows XP ProfessionalWindows XP Home EditionWindows 2000Windows Millennium Edition(Window Me)Windows 98Windows 7RedhatDebianUbuntu 编译软件：JRE 1.4.2J2SDK 1.5JRE 1.5 数据库：MYSQL5.0 网络服务器：Tomcat 2.2.3 接口 硬件接口无特别要求，通用就好。网络硬件接口要求：现实中要求具有高速以太网以实现联网操作。 软件接口 Windows标准接口，要求与其他软件无冲突错误发生。 控制 在操作系统时，主要通过终端用户的鼠标点击和键盘输入来控制。2.3 基本设计概念和处理流程 2.3.1 系统建设的原则 该系统是某政府为人民及时的上报路障信息和让施工队伍及时的进行路障维修。该系统是面对广大的人民群众，所以在设计的时候必须操作简单明了，让大家一看就知道要怎么做，并且不会产生歧义。该系统上面的数据也必须有很高的正确性，才可以得到大家的信任。同时，还要具有一定的实时性。里面的信息不能太久不刷新，特别对于那些用户提交上来的路障信息。 2.3.2 基本设计概念本系统中主要用的概念有： 数据库管理：数据库中主要有5个表格，包括用户个人信息表、路障信息表、施工命令表、损失报告表和施工队伍信息表。这里面的每一个表格和其他的表格都有一定的联系，这样就可以在具体的实践中给出相关的信息。 网页的设计：这个是在用户看到的网页界面上的设计，要求要简单明了、大方美观。 网络建设：本系统建立在B/S体系结构上，所以必须为每个用户提供一个网站，以便用户访问并查询相关的路障信息。 2.3.3 ACD图 因为该系统的主要共利者是：一般市民（也就是一般用户）、路障维修人员和系统管理人员（也就是管理人员）。且系统中主要包含的部分是：查询系统、路障系统（负责市民上报路障信息的一个系统）、维修系统（是控制路障维修命令的一个系统）和损失系统（主要负责在维修过后系统的损失报告，由施工队伍填写）。同时，该系统是以数据库为基础。所以ACD图如下所示： 2.3.4 原型图 本系统是在网上发布信息，而且也是通过网络使得一般市民和政府部门进行交互信息的。所以，原型图如下： 2.3.5 映射DFD到层次结构图 DFD总图 Level-1层次结构图(上图) Level-2层次结构图查询系统结构图：路障系统结构图：维修系统结构图：损失系统结构图：修改密码结构图： 2.3.6 体系结构风格 在这个系统中，每一个功能都是可以数据库位中，在数据库中得到信息，再返回或者存储信息。所以，以数据存储为中心建立一个体系结构图，如下： 2.3.7 处理流程本系统的处理流程如下：2.4 功能需求与系统模块的关系2.5 人工处理过程 该系统需要人工处理的过程主要是管理员要处理的。管理员要在用户提交路障信息之后，考察该信息是否正确。同时，也要考虑损失报告是否能够通过。因为这两个地方要考虑的关系很多，而且比较灵活，不能直接用软件编程弄好。3. 接口设计 3.1 用户接口 （只设计了市民的接口） 为方便说明，我们做了一些简易的界面。 3.1.1 主界面 登陆http:/www.xxx.xxx.xxx，进入网上路障跟踪与修复系统，进入如下的主界面。主界面主要是显示最新的路障信息情况（包括市民报告的路障信息，系统对市民的反馈，最新生成的施工信息，以及最新的路障修复完成的情况）。另外，还有“登陆”和“注册”，以及市民能够进行操作的功能列表。点击相应的功能市民可以进行相应的操作。 3.1.2 登陆界面 点击“登陆”，市民可以进入如下登陆界面进行登陆，登陆后即可进行相应的操作。 对于第一次登陆的用户，需要注册一个新帐号。点击“注册”，进入注册界面。 3.1.3 注册界面 用户进入注册页面后，正确填写相关信息，即可完成注册。 3.1.4 找回密码界面 用户在登陆时，如果忘记了密码，则可以通过点击“找回密码”，进入下面的界面。用户输入自己的用户名和相应信息，如果信息核对正确，则用户可以找回密码。 3.1.5 功能列表 正确登录后，可以进行相应的功能操作。 若市民的个人信息还没完善，可以点击“完善个人信息”，进入如下界面完善个人信息。 市民若发现路障，可以进入“报告路障信息”，按照要求填写相应信息，完成报告。 市民报告了路障信息后，若想要查询路障信息，可以点击“路障信息查询”，进行查询。市民可以用系统返回的路障标识直接查询，也可以根据路障的相关信息进行查询（路障大小、路障地址等）。 若市民想要查看路障修复状况，可以点击“施工命令查询”，查看路障状态，若没有找到对应的路障标识，则说明路障还没有开始进行修复。 市民若要查询路障最后修复完成后的损失情况，可以点击“损失报告查询”，输入路障标识进行查询。 若市民发现之前报告的路障信息有误，则可以点击“修改路障信息”，在出现的自己提交的路障信息报告中找到相应的路障，对其进行修改后保存。3.2 外部接口 本子系统需要连接数据库，通过JDBC和JSP 实现从数据库中提取、管理、显示数据的功能。3.3 内部接口 本系统预计一共有两个类，分别是Users和Querying： 3.3.1 类1 ：用户类 用户类（Users）定义用户需求处理功能Register() 注册新用户 Login() 校对用户名和密码，允许用户登录系统 Find_Password() 找回密码 Barrier_infor_input() 市民报告路障信息 Modify_infor_citizen() 市民修改完善个人信息 Barrier_infor_modify()市民或者管理人员修改路障信息Modify_infor_project()施工队完善信息Loss_input()损失报告文件录入 3.3.2 类2： 查询类 查询（Querying） 定义 信息查询处理 功能 Query_by_Code() 通过路障标识查询 Query_by_Infor() 通过路障信息（两个参数）查询 3.3.3 信息显示 本系统通过JSP显示数据库中的信息。4.运行设计 4.1 运行模块组合 a.注册： 系统通过JDBC连接数据库。数据库首先检查用户名是否已经存在，接着检查用户填写的信息是否符合有关要求。如果都符合条件，则数据库中添加此用户信息，用户注册成功。 b.登录： 用户输入自己的用户名和密码后，点击“登录”。系统通过JDBC连接数据库。数据库核对用户名与密码是否匹配，如果匹配，则登录成功，用户直接进入系统主页面。c.查询路障信息： 系统首先调用“Querying”类，根据查询内容判断是调用函数Query_by_Code() 还是Query_by_Infor()。接着系统通过JDBC连接数据库，查出路障相关信息。另外，“Querying”类里也需要调用“Users”类，根据类里用户的不同判断是否显示相应的路障信息。d.修改密码： 系统通过JDBC连接数据库。数据库首先核对旧密码是否正确，接着检查新密码是否符合要求。如果都符合，则修改密码成功，数据库里的资料更新。e.报告路障信息：系统通过JDBC连接数据库。数据库首先检查是否已经存在相同的路障信息，若不存在，检查输入信息是否符合要求，若符合，则数据库添加这条信息。f.完善个人资料：系统通过JDBC连接数据库。检查输入信息是否符合要求，若符合，则数据库添加这条信息。4.2 运行控制 （1）注册：让用户填写相关的资料。在提交信息之后，在数据库中检查是否有用户名一样的用户，避免重复注册。要是重复则要求用户改名字。若条件都符合要求的话，就注册成功。（2）登陆：用户在首页填写自己的用户名和对应的密码，并且提交。若能够在数据库中找到该用户名，并且密码也是一样的，则用户可以进入该系统的主页。（3）查询：用户在主页中点击“查询”，进入查询的主页。根据已经知道的信息，选择查询的类型。如根据路障位置查询。只要在对应的地方写上相关信息，然后提交即可。（4）修改密码：密码是在进入系统主页之后才可以修改，只要在主页上选择“修改密码”。就可以进入修改密码的主页，填写相关信息，就可以修改密码。（5）提交路障信息：在主页中，选择“提交路障信息”。进入填写路障信息的页面。并且提交，弹出窗口提示成功即可。（6）完善个人信息：在主页中，选择“完善个人信息”。进入页面，完善相应的资料。5.系统数据库结构设计5.1逻辑结构设计要点 该系统需要建立6个数据库，分别是：用户个人资料数据库（包含一般用户、施工队员和管理人员，只不过他们的权限不同）、路障信息数据库（包含有关路障的各种信息）、施工命令数据库、损失报告数据库、施工队伍信息数据库、路障工具数据库。如下：数据库名称功能用户个人资料数据库主要储存用户的个人信息，如姓名、性别、家庭地址等。路障信息数据库主要储存路障有关的信息，如街道地址、大小、位置。施工命令数据库主要储存施工命令的各种数据，如施工队伍、施工人数、配备工具、路障状态、维修工时数等。损失报告数据库主要储存有损失的市民的相关资料，如市民的地址、电话、姓名、受损的类型以及损失的单位等。施工队伍信息数据库主要施工队伍的具体信息，如某队伍中包含的人数、队伍里面有的工具、队伍所在地址、队伍的施工状态等。路障工具数据库主要储存所有施工队伍共享的一些工具，如工具现在是否被使用、在哪一个队伍里面、该工具的数量有多少等。 5.1.1用户个人资料数据库数据项格式数值范围精度姓名*（张三）不超过8个字地址*（真南路）不超过20个字电话*长度为8位12345678身份证号码*长度为15位123456789012345密码*不超过16位 5.1.2路障信息数据库数据项格式数值范围精度路障识别号*不超过11个字地址*（真南路）不超过20个字大小*不超过10位12345678.0位置*路边，路中123456789012345所属街区*优先级*数字整数注解：优先级的数字越高，优先级越高。 5.1.3施工命令数据库数据项格式数值范围精度路障识别号*不超过11个字施工队编号*施工人数*整数配备工具*维修的工时数*数字维修的状态*1-41材料用料维修费用*数字123456789.0（元）注解： 1、配备的工具是写的工具的编号，该处假定所有类型的工具都有一个编号； 2、路障状态是分为4个状态，1施工中、2已修复、3临时修复、4未修复； 3、根据维修工时、人数、材料及工具等计算得出。 5.1.4损失报告数据库数据项格式数值范围精度路障识别号*不超过11个字市民姓名张三不超过8个字地址*（真南路）不超过20个字电话*长度为8位12345678损失类型*损失量*整数 5.1.5施工队信息数据库数据项格式数值范围精度施工队编号XXXXXX长度固定为5个字符施工队名称*不超过10个字人数*人1-50人1人当前工作状态*工作，空闲 5.1.6路障工具数据库数据项格式数值范围精度工具编号XXXXXX长度固定为5个字符当前使用状态*使用或谓使用使用的队伍*同类工具数量*整数未使用同类数量*整数注解：