详细设计报告.docx

详细设计报告.docx

《详细设计报告.docx》由会员分享，可在线阅读，更多相关《详细设计报告.docx（12页珍藏版）》请在冰点文库上搜索。

详细设计报告

XXX人资信息管理系统

详细设计报告

文件状态：

[√]草稿

[]正式发布

[]正在修改

文件标识：

当前版本：

1.0

作者：

完成日期：

2014-12-4

1引言

1．1编写目的

本说明在概要设计的基础上，对软件项目的各模块、程序、子系统分别进行了实现层面上的要求和说明。

软件开发小组的产品实现成员应该阅读和参考本说明进行代码的编写、测试。

1．2适用范围

本详细设计文档提供给系统开发人员，包括程序员和项目组成员，不得提供给公司外人员。

1．3背景

说明：

软件系统的名称：

XXX人资信息管理系统

任务提出者：

开发者：

实现完成的系统将在公司的部门使用。

本系统将是独立的系统，所产生的输出都是独立的。

本系统将使用作为数据库存储系统。

2系统结构

2．1软件结构

本系统采用SSH3种框架，即Spring+Struts+Hibernate。

Struts对Model，View和Controller都提供了对应的组件。

Spring是一个轻量级的控制反转（IoC）和面向切面（AOP）的容器框架，它由RodJohnson创建。

它是为了解决企业应用开发的复杂性而创建的。

Hibernate是一个开放源代码的对象关系映射框架，它对JDBC进行了非常轻量级的对象封装，完成数据持久化的重任。

2．2程序结构

1.模块汇总表

用户界面

模块名称

功能简述

Zhgjbxx

完成职工基本信息的增、删、改、查、导入、导出、信息审核等操作

Zhgdaxx

完成职工档案信息的增、删、改、查、导入、导出、信息审核等操作

Zhggwgchxx

完成职工岗位过程信息的增、删、查等操作

User

完成用户的角色权限设置操作

模块方法表

模块名称

类

方法

Zhgjbxx

ZhgjbxxAction

select（）、index（）、yiRuSSGCH（）、yiRuZHYFZRGCH（）、save（）、exportZhgName（）、exportZhgPhone（）、removeZhgjbxx（）

ExportData

exportExcel（HttpServletResponseresponse,Listlist,Stringflag）、exportSelectedExcel（HttpServletResponseresponse,Listlist,String[]ziduan）

ZhgjbxxConstant

定义常量和工具方法

Zhgdaxx

ZhgdaxxAction

select（）、index（）、save（）、exportZhgdaxx（）、removeZhgdaxx（）、editZhgdaxx（）

Zhggwgchxx

ZhggwgchxxAction

select（）、index（）、save（）、exportZhggwgchaxx（）、removeGWGC（）、editZhgdaxx（）、isNumeric（Stringstr）

User

UserDao

findUsersByPermission（Permissionperm）、findUsersByPermission（Permissionperm）

PermissionManager

getByRole（Rolerole）、isNameInUse（Stringname）、save（Permissionperm）、remove（Permissionperm）、

RoleManager

getRolesByUser（Useruser）、save（Rolerole）、remove（Rolerole）

UserManager

findUsersByPermission（Permissionperm）、findPermissionsByUser（Useruser）、getUser（StringloginId,Stringpassword）、getUser（StringloginId）、updateLoginInformation（Useruser,StringloginIp）、save（Useruser,booleanencodePassword）、getUserByType（Stringtype）、getOldPassword（IntegeruserId）、changePassword（Usermodel,StringoldPassword）、changePasswords（StringuserName,StringnewPass）

UserAction

Index（）、save（）、index（）changePassword（）、remove（）、editInfo（）、checkName（）、checkIdCard（）

3设计说明

3．1应当遵循的界面设计规范

软件的界面使用Sun公司提供的Swing组件设计开发，而目前行业对于Swing的开发并未形成统一的行业标准与规范。

为此，我们以用户需求为基础，同时结合行业通用软件界面设计原则及所使用的开发工具，总结制定出如下的界面设计规范：

1.用户原则

产品只有满足用户的需要才能得到用户认可。

为了达到用户要求，并保证符合行业标准，还必须将两者结合起来进行综合考虑。

用户针对本产品提出了以下界面需求：

A为了避免引起视觉疲劳，程序运行界面以灰色、浅蓝色等冷色作为主色调。

B主窗体的初始启动位置应位于屏幕的中央。

子窗体起始位置在MDI窗体的中央。

2.一致性原则

风格一致的界面，包括相近的颜色、统一的字体、类似的窗体布局等，这些都会带给用户统一的感觉，不会使他们感到混乱，从而使产品的支持度增加。

不仅如此，界面的一致性同时也增强了用户对产品界面的理解与认知度，当用户在不同的界面进行切换时，不会产生陌生甚至困惑的感觉。

为了做到真正的一致，制定如下要求：

A窗体布局：

统一采用两纵两横样式，上方是系统logo和用户基本信息，下方是系统功能应用，下方左侧是树形菜单，右侧是系统显示与操作。

组件左右边缘在垂直方向上保证左对齐或右对齐，组件在水平方向上保证组件显示文本基线对齐。

B字体样式：

统一采用开发工具提供的默认字体样式：

正常；黑色；宋体；12，对于提示性、警告性的文本，应加粗显示或者用红色提示。

C组件颜色：

根据用户的需求，窗体背景颜色采用灰白色和浅蓝色作为主色调。

组件颜色采用开发工具提供的默认背景色和前景色。

D组件大小：

组件的高度均为开发工具提供的默认高度。

宽度依照控件显示文本的长度可自动调整，同时兼顾窗体整体布局的要求。

3.对比性原则

对比性原则主要适用组件彼此间颜色差异的规定。

该原则应符合行业通用规范的要求或工业标准，例如选用黄色代表安全，绿色体现环保，蓝色表现时尚，紫色蕴含浪漫，淡色可以使人舒适，暗色做背景使人不觉得累等等。

设计组件颜色时应避免使用反差大，对比强烈，让人产生憎恶感的颜色，除非组件使用的场合具有特殊要求。

根据以上原则，本产品界面组件颜色选择开发工具提供的默认颜色（浅蓝色）。

其中，工具栏按钮的图标尺寸根据实际窗体的大小建议选择32×32、48×48，为了与窗体主色调保证协调一致，图标颜色优先选择以黑色、浅蓝色、白色为底色的图像，图像文件格式一律为GIF格式。

3.规律性原则

规律性原则主要考虑以下几个方面的要求：

A对于常用的可操作性控件，应根据用户的实际情况安排在相对固定的位置。

比如按钮控件，按操作习惯，应放置在窗体的右下方。

如果有多个按钮，还要考虑他们排放时的顺序。

本产品在开发中规定：

增加、删除、保存、关闭按钮作为一组按钮出现时，应位于窗体的右方，排列顺序以上述顺序为准。

B功能相近的一组控件应有效的组合在一起，比如可以放在一个带边框的面板中，并为该边框指定功能性说明文字。

C按Tab键的访问顺序，按照从上向下，从左向右的顺序访问窗体上的每个组件。

D对于每个菜单和菜单项必须指定合适的访问键。

访问键的形式为（Key）,例如用户（U）

4.帮助提示原则

一个设计优良的程序除了应该具备友好的界面，还应具备必要的帮助和提示性信息。

因此，对于本产品中界面上的按钮组件和工具栏组件在操作中必须提供相关信息的提示。

A工具栏组件中的按钮添加ToolTip提示性信息。

B具有重要功能的按钮组件在点击后或功能操作完毕后必须显示消息提示对话框，用来确认用户执行的操作或者提示用户操作是否成功等等。

消息提示语言应该友好，并尽量做到简洁明确。

3．2界面的关系图和工作流程图

3．2．1界面功能一览

1.登录界面

通过输入用户名、密码完成系统的登录，如果登录失败在下方给出红色提示信息。

2.登录界面控件清单

控件名称

控件类型

功能

username

TextBox

用于输入用户名

Password

TextBox

用于输入密码

captcha

TextBox

用于输入验证码

系统首页

登录成功后，进入首页，首页上方左侧是系统logo，右侧是用户个人信息，；页面下方左侧是系统的树形菜单，右侧是应用操作。

3.查看、编辑、添加员工基本信息页面

当点击添加或者编辑职工基本信息后，进入该界面，在该界面，完成后点击提交，数据保存到系统数据库中

4导出员工基本信息界面

该界面通过选择职工和需要导出的字段，将相应职工的相应信息导出到excel表中。

5.导出各项信息

6.导入各项信息

该界面可以将从其他系统导出的一些固定格式的Excel信息表导入到系统中

7.用户管理

该界面对系统中的用户角色进行管理，如，启用或者禁用某些用户，给用户分配角色，初始化用户的登录信息等

8.角色管理界面

在该界面给系统设置角色，不同角色具有不同的操作权限。

9.权限管理界面

该界面给系统中的权限分配资源，就是什么样的权限可以访问系统的那些操作。

10.Ip管理界面

点击“IP地址管理”进入该界面，在该界面可以查看系统允许的ip访问地址段，并根据实际需要进行添加、编辑或者删除IP段。