详细设计说明书_v1.0范版.doc

编写：* 日期：2006-07-02 审核：日期： 批准：日期： 受控状态：是 发布版次：1.0日期：2006-07-02 编号：XS 1.0 协同办公系统协同办公系统 详细设计说明书详细设计说明书 变更记录变更记录 日期版本变更说明作者 2006-07-021.0初始版本王正韬、张敏 签字确认签字确认 系统模块对应章节对应部门负责人签字 目目 录录 1引言引言3 1.1编写目的3 1.2背景3 1.3基线3 1.4范围4 1.5定义4 1.6参考资料4 2模块命名规则模块命名规则5 3模块汇总模块汇总6 3.1模块汇总表6 3.2模块关系图7 4子系统模块设计子系统模块设计7 4.1数据库连接模块7 4.2公司通讯录模块 ADDRESS.8 4.3在线信息模块 MESSAGES.11 4.4名片夹模块 NAMECARD.15 4.5代办事项模块 NOTES.20 4.6个人文件夹模块 PERSONALFILE.24 4.7日程模块 SCHEDULE.30 4.8用户信息模块 USERINFORMATION.37 4.9系统管理模块 SYSTEMMANAGE41 1 引言引言 1.1 编写目的编写目的 本说明书目的在于明确说明系统各功能的实现方式，指导开发员进行编码。 本说明书的预期读者为：项目经理、+Teamgeist 项目组开发人员 1.2 背景背景 待开发软件系统的名称：协同办公系统 此软件系统任务提出者：项目经理 此软件系统任务开发者：*小组 1.3 基线基线 协同办公平台需求分析说明书 v1.1 1.4 范围范围 此说明书主要应用整个软件代码开发的生命周期以及测试周期 1.5 定义定义 无 1.6 参考资料参考资料 项目计划 V1.2 概要设计说明书 V1.0 2 模块命名规则模块命名规则 标识符类型命名规则例子 包（Packages）一个唯一包名的前缀总是全部小写的 ASCIIzimu 并且是一个顶级域名，通常 是 com,edu,gov,mil,net,org,或 1981 年 ISO3166 标准所指定的标识国家的英文 双字符代码。包名的后续部分根据不同 机构各自内部的命名规范而不尽相同。 这类命名规范可能以特定目录名的组成 来区分部门(department),项目（project） ， 及其（machine） ，或注册名（login name） 。包括基本为全小写的字母 com.sun.eng com.apple.quicktime.v2 .cs.bovik.cheese 类(Classes)类名是一个单词，采用大小写混合的方 式，每个单词的首字母大写。尽量使你 的类名简洁而富于描述。使用完整单词， 避免错写词（除非该错写词被更广泛使 用，像 URL，HTML） class Raster; class ImageSprite; 借口（Interfaces）命名规则：大小写规则与类名相似interface RasterDelegate; interface Storing; 方法（Methods）方法名是一个动词，采用大小写混合的 方式，第一个单词的首字母小写，其后 单词的首字母音大写 run(); runFast(); getBackground(); 变量（Variables）除了变量名外，所有实例，包括类，类 常量，均采用大小写混合的方式，第一 个单词的首字母小写，其后单词的首字 母大写。变量名不应以下划线或类元符 号开头，尽管这在语法上是允许的。变 量名应简短且富于描述。变量名的选用 应该易于记忆，即，能够指出其用途。 尽量避免单个字符的变量名，除非是一 次性的临时变量。临时变量通常被取名 为 i,j,k,m 和 n，它们一般用于整型； c，d，e，它们一般用于字符型。 int I; float myWidth; 实例变量(instance Variables) 大小写规则和变量名相似，处理前面需 要一个下划线 int_employeeld; String_name; Customer_customer; 常量（Constants）类常量和 ANSI 常量的声明，应该全部 大写，单词间用下划线隔开。 （尽量避免 ANSI 常量，容易引起错误） ，使用 static final 进行标明。 static final int MIN_WIDTH=4; static final int MAX_WIDTH=999; static final int GET_THE_CPU=1; 3 模块汇总模块汇总 3.1 模块汇总表模块汇总表 提示：提示：这里模块是指相对独立的软件设计单元，例如对象类、函数包等等。 子系统子系统 Address 公司通讯录公司通讯录 模块名称功能简述 公司通讯录通过人员姓名检索公司通讯录，通过公司组织树检索公司通讯录 子系统子系统 Messages 在线信息在线信息 模块名称功能简述 收件箱可以查询具体内容、删除信件 发件箱可以查询具体内容、增加、删除、修改、发送 草稿箱可以查询具体内容、增加、删除、修改、发送 搜索可以搜索符合要求的信件并查看信件的具体内容 子系统子系统 NameCard 名片夹名片夹 模块名称功能简述 名片夹可以查询具体内容、增加、删除、修改 子系统子系统 Notes 待办工作待办工作 模块名称功能简述 待办工作可以查看具体内容、增加、删除、修改 最近日程可以查看最近五条日程的内容，可以链接到所有日程列表 最近留言可以查看最近五条留言的内容，可以链接到所有留言列表 子系统子系统 PersonalFile 个人文件夹个人文件夹 模块名称功能简述 个人文件夹可以上传、删除文件，可以新建、修改、删除文件夹，可以修改文件夹名及属 性 共享文件夹可以下载共享文件 子系统子系统 Schedule 日程日程 模块名称功能简述 日程管理可以增加、修改、删除日程 代办设置可以授予或取消代办权限 读者设置可以授予或取消读者权限 日程查询可查询日程并查看具体内容 子系统子系统 UserInfo 个人信息管理个人信息管理 模块名称功能简述 基本信息管理可以修改自己的基本信息 密码修改可以修改密码 查询他人信息可以查询他人的公开信息 子系统子系统 DeptManage 部门管理部门管理 模块名称功能简述 部门管理可以增加、删除、修改部门，可以修改部门的联系电话 子系统子系统 RoleManage 角色管理角色管理 模块名称功能简述 角色列表管理可以增加、删除、修改角色列表 个人角色管理可以修改个人的角色 3.2 模块关系图模块关系图 数据库 数据库访问接口 个人办公 个人信息管理 名片管理 日程安排 在线信息 个人文件夹 登陆认证 系统管理 公司通讯录 角色管理 部门管理 待办事项 会议管理 控制器 个人办公界面系统管理界面 4 子系统模块设计子系统模块设计 4.1 数据库连接模块数据库连接模块 功能描述连接数据库 接口与属性 AbstractDAO getConnection() : Connection 函数功能：返回数据库连接对象 返回值：Connection（数据库连接对象） AbstractDAOFactory createDAO(): AbstractDAO 函数功能：创建数据库访问类的实例 返回值：数据库访问类的实例 DAOFactoryBuilder getFactory() : AbstractDAOFactory 函数功能：创建 DAO 工厂类 返回值：DAO 工厂 数据结构 与算法 采用工厂方法设计模式将 DAO 的创建与使用者分离，FactoryBuilder 负 责创建 DAOFactory 使得使用者不会因 DAOFactory 的改变而改变 补充说明 4.2 公司通讯录公司通讯录模块模块 Address 模块名称Address（公司通讯录） 功能描述查询通讯录、导出通讯录 接口与属性 getAddressByValue(key : String, value : String) : Object 函数功能：通过输入的查询条件、查询类别查询指定的员工、部门或者 所有的员工的通讯资料 输入参数：key : String, value : String 返回值：UserInfoBean、DeptBean（得到的个人、部门或者所有员工的通 讯资料） buildTreeFile() 函数功能：构建树型结构 数据结构 与算法 补充说明 : 户 户 : AddressServlet : AddressCtrl : AddressManager : Utility : DeptBean : UserInfoBean 1: 2: buildTreeFile( ) 4: 3: getTreeInfo( ) 6: getAllDeptAddress( ) 8: buildTreeFile( ) 7: new 5: new 用户打开公司通讯录 : 户 户 : AddressServlet : AddressCtrl : AddressManager : Utility : DeptBean : UserInfoBean 1: 2: buildTreeFile( ) 4: 3: getTreeInfo( ) 6: getAllDeptAddress( ) 8: buildTreeFile( ) 7: new 5: new 进行查询 : 户 户 : AddressServlet : AddressCtrl : AddressManager