面向对象详细设计模板示例

1    钻前工程    1

1.1.    功能概述    1

1.2.    包    1

1.3.    页面文件（JSP/HTML/JS/CSS）    1

1.4.    井口位置信息录入（程序块）    1

1.4.1.    程序设计    1

1.4.2.    数据库对象    3

1.4.3.    接口设计    3

1钻前工程

1.1.功能概述

钻前工程功能需求主要包括：钻前基本信息、钻前工程工作内容、钻杆排运行记录记录、钻前基本信息查询、钻前工程工作内容查询、钻杆排运行记录查询。在钻前工程阶段，钻井公司生产管理部值班人员使用数据维护功能对钻前工程数据进行维护。

1.2.包

1.4.1.程序设计

1.4.1.1.类图

图 41类图

第一层:接口，定义接口，约束具体功能层所必须实现的功能；第二次：公共抽象类，实现父类需要实现的方法以及方法调用关系；第三层：专业实现类，根据职能域专业特点，实现专业化通用方法；第四层：程序块功能实现类，定义实现具体业务功能模块的主要公共属性、公共方法。

具体程序块详细设计时只需要定义三、四层类图即可。

图 43顺序图

只需要表达主要的调用关系及调用顺序，把具体对象名、JSP名列出。

1.4.1.3.主要算法

1、类名：由包名、类名组成；

2、数据库对象名：英文名称；

3、使用说明：使用数据库对象的具体到方法名。

1.4.3.接口设计

1.4.3.1.用户界面

用户界面截屏

数据项说明

1、数据项，JSP页面需要显示的数据项或隐藏数据项；

2、取值方式包括：传递——从其它表、页面传递过来，不做修改直接保存；参照编辑——从其它表读取，修改保存；手工填写——文本框、下拉框、复选框等数据录入方式；系统自动赋值——默认值、根据规则系统自动编号等。

3、关联：来源基本表或视图、数据保存基本表；

4、显示，是否为隐藏参数；只读，是否可修改，主要用于传递类、自动赋值类数据项；必填，必须填写内容，即非空；

1.4.3.2.外部接口

与其它系统接口、与操作系统接口、与其它服务如FTP等接口。

1.4.3.3.内部接口

公共模块调用、其它模块调用。

1.4.3.4.配置文件

《Struts配置文件、其它所需配置文件……，系统参数，用户参数》