日志系统用概要设计计划书

1 日志系统用概要设计计划书 1 引言 写目的 本文档系统描述了 日志 系统的设计，主要阅读对象 为日志系统的项目经理及软件开发人员，测试日志系统的测试人员， 需求分析师 等。 项目经理：阅读本文档的全部描述信息， 开发人员：重点阅读是外部接口和内部接口部分。 需求分析师以及测试人员：重点阅读是需求概述部分。 围 软件系统名称：日志系统 义 列出本文件中用到的专门术语的定义和缩写词的原词组。 2 考资料 2 总体设计 求规定 本功能 日志系统 无论是作为一个独立的系统还是作为其他系统的子系统都应具备 2个基本的功能 志来源 日志来源可以是使用日志系统的用户自己或者其他调用日志系统的人，又或是其他需要记录软件日志的使用者。 志输出 作为一个日志系统，需要有提供日志显示的功能。当日志系统记录了日志时就应当提供日志显示的功能给使用者查看这些日志，这样才能提现这些日志的价值。 当然日志系统还可以根据用户的需要增加一些自定义的功能：比如：日志的导出和日志的打印，以便用户在需要对有价值的信息进行特定格式的保存或者 打印成文档的时候使用。 3 本需求 录日志功能 日志系统提供记录日志的功能，记录的日志可以有软件的运行、用户的操作行为。软件的运行包括：软件的运行状态，用户的操作行为包括：用户使用软件提供的功能时的行为。记 录的日志信息包括：操作类型、操作结果、操作时间、操作者、操作目标、操作者的 询日志功能 日志系统提供用户日志、物流配送日志、员工信息日志、教务管理系统日志供用户查询，使用者可以根据 日志系统提供的查询条件自行指定的条件进 行查询。 用户日志可以根据：用户 户级别、开始时间、结束时间5个条件来查询 需要的日志； 物流配送日志可以依据：子系统、操作类型、操作结果、用户 文件、目的文件、开始 时间、结束时间等 9个条件来查询； 员工信息管理系统日志可以根据：子系统、操作类型、操作结果、用户置点编号、目标地址、开始时间、结束时间等 9个条件来查询； 教务管理系统日志则可以根据：子系统、用户 作类型、操作目标、操作结果、开始时间、结束时间 等 6个条件查询。 使用者可以自行决定搜 索条件来查询所需要的日志，日志系统将符合搜索条件的日志显示到界面供用户查看。 志的导出功能 当使用者通过日志查询查询出日志后，可以选中某些需要保存的日志使用日志导出功能将这些日志保存为 是 式的文件。如果要保存为 须保证使用者的电脑已经安装了 则 4 会导出失败。 志的打印功能 当使用者通过日志查询查询出日志时，可以将对选中的日志信息进行打印操作。使用打印操作之前必须保证电脑已经连接上了打印机，否则将无法打印 。 行环 境 1 硬件环境 处理器： 或性能更好的 处理器 。 内存： 512以上。 硬盘空间： 500以上的剩余空间。 本系统对于硬件的要求不算太高，选择计算机主要是本着经济、运行稳定的原则。目前主流的 就可以满足本系统的运行要求。 2 软件环境 系统环境：只支持 微软 ) 操作系统。 版本代号为 者比次版本更高的系统，如： 2003，7。 数据库： 据库或更高版本的 作系统以其友好的图形界面，以及简单的操作要求，深受用户的青睐，另外他对使用者要求相对其他系统简单，所以一般用户都能直接上手。基于上述的考虑，选择 统作为软件的运行环境，方便使用者的操作。 5 本设计概念和处理流程 始化用户界面流程 开 始结 束初 始 化 界 面连 接 数 据 库读 用 户 日 志关 闭 数 据 库连 接 数 据 库 是否 成 功 入软件运行日志流程 7 8 出软件运行日志流程 开 始连 接 数 据 库是 否 连 接 成 功 ？结 束是否关 闭 数 据 库读 取 相 应 的 日 志 表 9 索日志流程 开 始结 束获 取 搜 索 信 息连 接 数 据 库是 否 连 接 成 功 ？按 要 求 搜 索 数 据 库显 示 结 果是否关 闭 数 据 库 10 流程或分支处理流程设计 据库操作模块流程图处理设计 开 始连 接 数 据 库 成 功 ？对 数 据 库 进 行 操 作关 闭 数 据 库结 束是否 11 开 始初 始 化 用 户 界 面接 受 用 户 操 作结 束数 据 库 操 作 模 块返 回 结 果 12 入日志信息 日 志 信 息 信 息 拆 分 拆 分 后 的 信 息执 行 S Q L 语句对 应 表 中 的 信 息数 据 出日志信息 执 行 S Q L 语 句 展 示 在 列 表 中 的 信 息读 取 命 令日 志 信 索用户日志 执 行 S Q L 语 句 展 示 在 列 表 中 的 信 息搜 索 命 令日 志 信 息 13 构 用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系。 14 能需求与程序的关系 数据库操作模块 日志系统用户界面模块 外部接口 连接数据库 执行 句 获取行 获取值 获取字段长度 释放数据指 针 关闭数据库 初始化界面 选择日志类型 读取日志 写入日志 搜索日志 退出客户端 15 工处理过程 说明在本软件系统的工作过程中不得不包含的人工处理过程（如果有的话）。 未解决的问题 说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。 3 接口设计 部接口 接口数据类型说明： 字符指针 常量 尔型 空 返回值 函数 功能 需求对应 1 根据 类型写入对应的日志 显示日志系统用户界面，便于用户查询日志和导出、打印日志 4 功能：写入日志，根据 日志。 参数：第一个参数以结构体字符串常量形式传入， 16 第二个为一个整形变量，可选值为其下面其中之一： 户日志 ; 流配送日志 工信息日志 务系统日志； 返回值：若写入成功，返回 则返回 无返回值 功能：显示日志系统用户界面。 参数：无。 返回值：无。 部接口 接口 列表如下： 返回值 函数 功能 1 初始化数据库 2 关闭数据库 3 将登录过主系统的用户的 4 将登录过主系统的用户的 5 当用户对软件运行日志进行搜索时，获取用户选择的筛选条件 6 当用户对用户 日志进行搜索时，获取用户选择的筛选条件 7 对除用户 8 对列表控件进行初始化 9 将软件运行日志从数据库中读出 10 将用户日志从数据库中读出 11 初始化图标列表 17 12 取得数据库中最后一个用户记录，作为当前系统的使用者 13 搜索软件运行日志 14 搜索用户日志 功能：初始化数据库。 参数：无。 返回值：若成功返回 则返回 功能：关闭数据库。 参数：无。 返回值：若成功返回 则返回 功能：将登录过主系统的用户的 参数：无。 返回值：若成功返回 则返回 功能：将登录过主系统的用户的 参数：无。 返回值：若成功返回 则返回 功能：当用户对软件运行日志进行搜索时，获取用户选择的筛选条件。 参数：无。 18 返回值：若成功返回 则返回 功能：当用户对用户日志进行搜索时，获取用户选择的筛选条件。 参数：无。 返回值：若成功返回 则返回 功能：对除用户 参数：无。 返回值：若成功返回 则返回 功能：对列表控件进行初始化。 参数：无。 返回值：若成功返回 则返回 功能：将软件运行日志从数据库中读出。 参数：若需要读取存储系统，传入 ” ，若需要读取云台系统，传入 ” ，大小写不透明。 返回值：若成功返回 则返回 功能：将用户日志从数据库中读出。 参数：无。 返回值：若成功返回 则返回 19 功能：初始化图标列表。 参数：无。 返回值：若成功返回 则返回 功能：取得数据库中最后一个用户记录，作为当前系统的使用者。 参数：无。 返回值：若成功返回 则返回 功能：搜索软件运行日志。 参数：无 返回值：若成功返回 则返回 功能：搜索用户日志。 参数：无 返回值：若成功返回 则返回 4 运行设计 行模块组合 说明对系统施加不同的外界运行控制时 所引起的各种不同的运行模块组合，说明每种运行所历经的内部模块和支持软件。 20 行控制 第一阶段实例化对象并初始化。 ;实例化数据库对象： 调用函数 布尔值 ，初始化数据库 象。 21 布尔值 连接数据库。 如果成功，第二 阶段。 布尔值 ,初始化下拉列表 字符串 ，获取用户在筛选区中说要获取日志信息的条件。 布尔值 从数据库中获取用户所需要的用户日志 布尔值 从数据库中获取用户所需要的物流配送日志 布尔值 从数据库中获取用户所需要的员工信息日志 布尔值 从数据库中获取用户所需要的教务系统信息日志 布尔值 ，关闭数据库 第三阶段： 当整个系统退出时，调用 布尔值 释放资源，退出系统。 读取日志程序调用流程如图所示： 22 读取日志程序调用流程图 开 始初 始 化 数 据 是 否 成 功连 接 数 据 库 是 否 成 功初 始 化 下 拉 列 表 是 否 成 功获 取 用 户 的 筛 选 信息查 询 数 据 库 是 否 成 功关 闭 数 据 库 ， 退 出日 志 系 统结 束是 否 退 出 系 统 查 询 结 果3 写入日志程序调用流程如图 是 否 写 入 日 志获 取 写 入 信 息写 入 数 据 库 是 否 成 功关 闭 数 据 库结 束 化 数 据 是 否 成 功开 始连 接 数 据 库 是 否 成 功 24 行时间 日志系统可以作为一个系统独立运行，也可以作为其 他项目的子系统。当作为其他系统的子系统时，其生命周期从日志系统被初始化开始到其他子系统停止工作时结束。 本系统主要是作为整个软件的一部分，并为其他的子系统提供服务的，所以他的运行时间主要取决于其他几个子系统的运行时间，如果其他子系统（物流配送，员工信息，教务管理系统等）一直没有退出或是关闭的话，本系统将一直运行下去，直至所有的子系统关闭。 5 系统数据结构设计 辑结构设计要点 给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的 或表格的相互关系。 理结构设计要点 给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。 据结构与程序的关系 说明各个数据结构与访问这些数据结构的各个程序之间的对应关系，可采用如下的矩阵图的形式： 程序 1 程序 2 程序 m 数据结构 1 数据结构 2 25 数据结构 n 6 系统出错处理设计 错信息 用一览表的方式说明每种可能的 出错或故障情况出现时，系统输出信息的形式、含意及处理方法。 救措施 说明故障出现后可能采取的变通措施，包括： a 后备技术：说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和