合约公司管理系统设计与实现详细设计说明书

合约公司管理系统设计与实现详细设计说明书 1 第 1 页 共 16 页 合约公司管理系统设计与实现详细设计说明书 1 引言 写目的 合约公司管理系统详细设计是设计的第二个阶段，这个阶段的主要任务是在合约公司管理系统概要设计书基础上，对概要设计中产生的功能模块进行过程描述，设计功能模块的内部细节，包括算法和详细数据结构，为编写源代码提供必要的说明。 概要设计解决了软件系统总体结构设计的问题，包括整个软件系统的结构、模块划分、模块功能和模块间的联系等。详细设计则要解决如何实现各个模块的内部功能，即模块设计。具体的说，模块设计就是要为已经产生的合约公司管理各子系统设计详细的 算法。但这并不等同于系统实现阶段用具体的语言编码，它只是对实现细节作精确的描述，这样编码阶段就可以将详细设计中对功能实现的描述，直接翻译、转化为用某种程序设计语言书写的程序。 目背景 义 统服务器所使用的数据库管理系统（ 种用于访问查询数据库的语言。 事务流 :数据进入模块后可能有多种路径进行处理。 主键 :数据库表中的关键域，值互不相同。 外部主键 :数据库表中与其他表主键关联的域。 统一建模语言 。 类图 (表述系统中各个对象的类型及其间存在的各种静态关系。 交互图 (是表述各组对象如何依某种行为进行协作的模合约公司管理系统设计与实现详细设计说明书 2 第 2 页 共 16 页 型。 结构化查询语言。 2 总体设计 求概述 按照需求分析文档中的规格要求，使用数据库存储了公司的所有合同以及员工的基本信息，并且提供对存储的数据进行查询、修改、增添、删除的界面，方便用户使用。同时，系统最大限度地实现易安装，易维护性，易操作性，运行稳定，安全可靠 。 序结构说明 合约公司管理系统由三个大模块，六个小模块组成，系统的组织结构图如下图所示： 合约公司管理系统设计与实现详细设计说明书 3 第 3 页 共 16 页 合 约 公司 管 理系 统基 础 信 息 设 置查 询 子 系 统管 理 子 系 统公 司 合 同 信 息系 统 参 数 设 置管 理 员 设 置修 改 密 码添 加 用 户合 同 添 加合 同 执 行合 同 统 计项 目 信 息合 同 信 息 查 询员 工 信 息 查 询系 统 登陆客 户 信 息 查 询合 同 分 类图 约公司管理系统模块功能结构图 合约公司管理系统设计与实现详细设计说明书 4 第 4 页 共 16 页 3 程序描述 户登录程序模块 序特征描述 本程序模块是合约公司管理系统的一个子模块，操作对象是用户，负责用户登陆控制。 序功能描述 本模块的核心程序是 ，此类根据界面输入的用户名密码来请求服务器验证用户登陆 。 主要功能： 1. 根据用户输入的用户名密码进行登录验证，验证成功进入主界面，显示合约列表； 1）编写登陆界面：界面有用户名，密码两个输入框，有“登录”、“退出”连个功能按钮； a. 若点击“退出”按钮，退出程序。 b. 若点击“登录”按钮，开始用户登陆。 先显示查找服务器等待界面，若查找失败，提示失败原因，重新返回登陆界面，若成功，进入登陆等待界面； 在登陆等待界面，若登陆成功，进入程序主界面，显示合约列表。若登陆失败，提示用户失败原因，重新返回登陆界面。 2）编写查询服务 器等待界面：显示查找等待进度条。 3）编写登陆等待界面：显示登陆等待进度条。 4）编写合约列表界面。 2．要能处理网络连接出错等异常情况：发生异常后，均给出提示，再重新返回 登录界面 3. 输入的用户名，密码要进行合法性检查：用户名，密码不能为空 序性能描述 本模块要求各操作能独立完成，并且对于各种意外原因造成的操作中中断模合约公司管理系统设计与实现详细设计说明书 5 第 5 页 共 16 页 块能够有及时的处理。 序输入 /输出项 输入界面如下图所示： 图 陆界面视图 输入项： 登录界面的输入项如下图所示 ： 图 陆界面输入项 登录成功的输出界面如下图所示： 合约公司管理系统设计与实现详细设计说明书 6 第 6 页 共 16 页 图 录成功输出界面 法 本模块不设计复杂算法。 序逻辑 用户登录程序模块是整个合约公司管理系统的首界面，并且，也是系统安全性的正要保障。用户登录程序会将用户输入的用户名和密码与服务器端数据库中存储的管理员和软件使用者信息进行比较，如果信息匹配上，服务器就会返回一个信息，并调取登录成功的合同列表界面显 示在用户端浏览器上。并且在用户进行其他操作以及界面跳转时都不需要再进行用户名和密码的输入。 用户登录程序的逻辑结构如下图所示： 合约公司管理系统设计与实现详细设计说明书 7 第 7 页 共 16 页 用 户 登 陆 界 面进 入 查 询 服 务 器 界 面 ， 发 送d i s p a t c h 请 求 ， 获 取 服 务 器 地址 s e r v e r I 登 陆 等 待 界 面 ， 并 根 据 用户 名 ， 密 码 ， 向 服 务 器 发 送l o g i n 请 求 报 文登 陆成 功 返 回 s e r v e r i 退 出 程 序失 败从 服 务 器 接 收 到 报 文启 动 报 文 接 收 线 程当 前 是 登 陆 请 求 命 令调 用 报 文 解 析 模 块解 析 报 文登 陆 成 功提 示 登 陆 成 功 ， 发 送 合同 信 息 列 表停 止 报 文 接 收 线 程Y e sY e sN oY e 用 户 登 陆 失 败从 服 务 器 接 收 数 据否是 i q 报 文 ， 且 查 询j a b b e r : i q : r o st e rN 报 文 解 析 模 块解 析 合 同 报 文进 入 主 界 面 ， 显 示合 同 信 息 列 表图 序逻辑流程图 口 暂无 储分配 本模块无存储分配计划。 合约公司管理系统设计与实现详细设计说明书 8 第 8 页 共 16 页 制条件 由于应用软件的具体硬件设置和具体操作人员的熟练程度制约了登录的速度。 试要点 本模块的测试计划初步定为按照业务逻辑流程测试。 理模块程序 序功能描述 （ 1） 功能 类型：其他 （ 2） 功能概述：合同的起草添加、删除、修改、删除以及打印 （ 3） 前提业务：用户登陆模块 （ 4） 功能约束：权限约束 （ 5） 约束描述： （ 6） 操作权限：公司管理人员 功能流程图见图 示。 序性能描述 合约公司管理系统权限管理模块的操作只有管理员一级的用户拥有权限，不存在多用户并发访问的压力问题。但是对于用户的权限控制比较占用资源，可能存在的问题集中在多表操作上，在用户登录系统的验证和进入系统后的权限控制时会频繁访问数据库，造成可能的系统压力。用户列表的翻页操作，由于用户信息数据量大，可能随着翻页的增加导致系统速度变 慢。 序输入 /输出项 由于合同对于整个公司的重要性，程序输入的合同的各个信息，以及参与合同制定的相关人员的基本信息，都应保证准确无误，保证合同信息的完整性和正确性，方便一般用户的查询。 程序输入界面如下图所示： 合约公司管理系统设计与实现详细设计说明书 9 第 9 页 共 16 页 图 理模块程序界面 程序输出的是合同列表，如下图所示： 图 同列表界面 法 （ 1）用户可见窗体节点树的动态生成 用户所见的节点树由该用户所扮演的角色决定，事实上是由角色所具有的权限所决定的。数据库的“窗体表”中存储各窗体节点的信息，包括窗体名称、链接、节点编码等。节点编码体现节点的层次。 节点编码的位数除以２得到的值再减１即为该节点位于的层数，每个节点编码（根节点除外）去掉末尾的两位数后得到的编码即为此节点的父节点的编码。这样，只要有了一个节点集合以及这些节点的编码，就可以唯一确定并生成一棵树结构。因此，只要根据用户权限从数据库中读取出该用户所能操作的所有节点的合约公司管理系统设计与实现详细设计说明书 10 第 10 页 共 16 页 集合，就可以在用户界面上动态的创建出此用户所能够访问的节点（窗体）。 （ 2）页面按钮权限控制 对于页面和按钮的控制，是通过角色 管理实现的。首先，给已有的角色分配定义好的业务，存入数据库中的“角色 — 窗体 — 业务关系表”中。 当用户登录系统时，会根据用户的角色在“角色 — 窗体 — 业务关系表”中查询角色所拥有的业务和窗体，通过窗体可以生成如上的节点数，通过用户拥有的业务查询“业务 — 按钮对应表”则可以控制用户在刚窗体中的按钮是可见的。 序逻辑 ： （ 1） 对应 表 同列表） （ 2） 对应生成的权限树的节点关系 （ 3） 对应用户的个人详细信息 （ 4） 对应表 户角色表 ) ： （ 1） 责查询与合同相关的信息 （ 2） 责查询与权限相关的信息 （ 3） 责查询与用户相关的信息 ： （ 1） 用户角色相关的操作 （ 2） 合同相关的操作 合约公司管理系统设计与实现详细设计说明书 11 第 11 页 共 16 页 ： （ 1） 责处理合同相关的逻辑 1. 询系统所有合同 （ 2） 责处理权限相关的逻辑 1. 验登录用户名密码是否合法 （ 3） 责处理合同相关的逻辑 1. 查询所有合同信息 查询特定合同信息 3. 删除合同 修改合同信息 5. 加合同 口 1．人员管理 （ 1）人员信息管理页面 /a)查询人员权限信息 调用 用 回 )跳转到增加人员界 合约公司管理系统设计与实现详细设计说明书 12 第 12 页 共 16 页 调用 用 回 )删除人员 调用 用 回 )跳转到修改人员 信息界面 调用 用 回 （ 2） 增加人员页面 /用 用 回 （ 3） 修改角色页面 /用 用 回 ．合同管理 合同 管理 页面 /a)显示合同列表 调用 用 回 )按合同名查询合同信息 调用 用 回 )跳转到添加合同界面 调用 用 回 )删除合同 调用 用 回 )跳转到修改合同界面 调用 用 回 ： 1．创建 户角色关系，表示一个登录用户所拥有的所有角色的列表 户 系统对用户的唯一标识 户名称 户密码 有可以用于分配的权限的列表 个角色拥有的权限的列表 有合同信息列表 户可见窗体节点树的节点列表 2．调用 户 户名 户密码 制条件 此部分的功能应当只限于管理员一级的用户使用。 合约公司管理系统设计与实现详细设计说明书 14 第 14 页 共 16 页 试要点 由于合约公司系统管理模块的用户不会太多，一般 来说，主要是管理员一级的用户才有权限操作，所以测试的要点不应放在压力测试上，而应当放在边界值测试和操作权限控制测试上。因为系统管理的操作关系到整个系统的运作和用户的安全性，所以应当注意是否有可能通过非法路径执行系统相关操作从而破坏系统安全性，在对合同和员工信息进行增加、删除和修改操作后，数据库各表之间的数据一致性。此部分的各项操作都涉及到多表访问，需要增加必要的事务回滚。 对于用户登录系统并进行各种操作的权限控制比较复杂，需要进行压力测试，从而确定以牺牲一定的系统资源换取的系统安全性是否值得，找到一个平衡点 。 般用户查询程序 序功能描述 （ 1） 功能类型：查询合同信息和人员信息 （ 2） 功能概述：显示查询结果 （ 3） 前提业务：无 （ 4） 后继业务： （ 5） 功能约束：没有约束； （ 6） 约束描述： （ 7） 操作权限：面向所有用户 程序功能流程图如下图所示： 合 同 和 人 员 信 息 查询 . j s 项 检 验（ 非 空 ）提 交 所 填 内 容失 败合 同 和 人 员 查 询 数据 处 理 . j s 是 否 成 功执 行 数 据 库 操 作 查 询 结 果 . j s 失 败图 能流程图 序性能描述 合约公司管理系统一般用户查询模块的操作所有用户都拥有权限，存在多用户并发访问的压力问题。可能 存在的问题集中在多用户并发查询操作上，在大量用户同时登录查询系统并进入系统后会有大量访问数据库的操作，造成可能的系合约公司管理系统设计与实现详细设计说明书 15 第 15 页 共 16 页 统和数据库的压力。用户列表的翻页操作，由于合同和人员信息数据量大，可能随着翻页的增加导致系统速度变慢。 序输入 /输出项 程序的输入同图 示，但是不需要进行用户名和密码的验证。程序的输出如下图所示： 图 般用户查询程序输出界面 法 此程序用到的算法比较简单，只用到了按广度优先算法遍历数据库所有表的信息。 序逻辑 程序内部逻辑如下图所示： 般用户查询程序内部逻辑 合约公司管理系统设计与实现详细设计说明书 16 第 16 页 共 16 页 1、 于显示界面的内容，给用户显示一个查询接口 2、 来调度所有的页面，它根据传入的参数来决定包含哪一个 面来显示内容；在 面中，它根据传入的参数来决定包含哪一个 可以通过 ”/> ,利用 到相应页面； 3、 来显示查询到的结果列表。 4、 来显示查询到的合同和人员的各项信息。 口 暂无 储分配 所有项目、合同信息及合同流程和员工信息都存储在数据库表中。 制条件 此部分功能面向全部用户，只提供查询功能，不能进行修改、添加、删除，因此没有具体的限制条件。 试要点 由于合约公司系统管理模块的用户可能会很多，一般来说，全部用户都具有权限操作，所以测试的要点应放在压力测试上。因此应采用大量数据测试系统和数据库的承受能力，找到系统所能承受的极限值，以便更好的 进行系统优化和改进。