短租网系统设计文档.docx
《短租网系统设计文档.docx》由会员分享，可在线阅读，更多相关《短租网系统设计文档.docx（55页珍藏版）》请在冰点文库上搜索。
短租网系统设计文档
项目名称
ProjectName
密级
ConfidentialityLevel
轻松短租网
仅供收件方查阅
项目编号
ProjectID
版本
Version
文档编号
DocumentCode
v9.4348.2761.32
2.0
v9.4348.2761.32_SD_001
ShortrentSoftwareSystemHighLevelDesignSpecification
轻松短租网软件系统概要设计说明书
Preparedby
拟制
黄蓉
Date
日期
2015-07-22
Reviewedby
评审人
鹏
Date
日期
Approvedby
批准
周伟
Date
日期
市软酷网络科技
所有不得复制
Copyright©RuankosoftTechnologies（WuHan）Co.,Ltd.
AllRightsReserved
RevisionRecord
修订记录
Date
日期
RevisionVersion
修订版本
CRID/DefectID
CR/Defect号
SecNo.
修改章节
ChangeDescription
修改描述
Author
作者
2015-07-08
1.0
初稿
黄蓉
2015-07-22
1.0
2、3、4、5
填充
黄蓉
2015-07-23
2.0
第二次迭代
黄蓉
Keywords关键词：
短租
Abstract摘要：
本文档是基于轻松短租网软件系统的概要设计及说明书，用于指导编码实现阶段工作，也是产品最终提交文档之一，描述的是轻松短租网系统的模块功能点分析，本文档主要针对轻松短租网系统各个业务功能模块进行外界环境、系统框架、业务流程、功能类上的分析。
Listofabbreviations缩略语清单：
Abbreviations缩略语
Fullspelling英文全名
Chineseexplanation中文解释
1Introduction简介
1.1Purpose目的
本系统设计文档是为设计人员和开发人员而编写的，它说明了本系统的各项功能和性能需求，明确标识各功能的实现过程，阐述使用围及背景，提供客户解决问题或达到目标所需的条件或权能，提供一个度量和遵循的标准。
本说明书的预期读者为中间用户（指软件的管理人员、设计人员、开发人员、测试人员、维护人员）。
1.2Scope围
1.2.1Name软件名称
轻松短租网
1.2.2Functions软件功能
请参考《轻松短租网系统需求规格说明书》2.2章节。
1.2.3Applications软件应用
轻松短租网，给用户提供了一个房屋短期出租和预订房屋的平台。
1.3Reference参考资料
无。
2HighLevelDesign概要设计
2.1Level0DesignDescription第0层设计描述
2.1.1软件系统上下文定义
2.1.2DesignConsiderations设计思路
1、系统的三层架构
包的结构图如下图所示：
系统分为action（视图层）、service（业务逻辑层）、dao（数据访问层），它们通过调用entity（业务模型）来完成数据的传递，其中有一部分类会被多处公用，就像工具一样，这时把它们统一放在util中。
2、程序的框架
系统使用StrutsMVC模式，Struts与三层架构的结合中，Struts主要是负责页面（表示层）与业务模型（业务逻辑层）之间的控制转向。
实际上是实现了表示层与业务模型层的松耦合，同时也增强了业务模型层的重用性。
将Struts引入三层结构，可以将Struts位于Web表示层，构成表示层（.ruanko.action）、业务逻辑层（.ruanko.service）和数据访问层（.ruanko.dao），每层之间传递业务类，即.ruanko.entity中类。
三层结构与Struts结合包层次结构如下表所示：
程序架构
文件与目录结构
表示层（Struts）
JSP页面
struts.xml
.ruanko.action
业务逻辑层
.ruanko.service
数据访问层
.ruanko.dao
模型类
.ruanko.entity
3、程序的目录结构
文件夹名
说明
img
存放图片
js
存放脚本文件
css
存放样式文件
mon
存放公共页面
admin
存放后台管理页面
user
存放用户模块页面
house
存放房屋模块页面
order
存放订单模块页面
2.2Level1DesignDescription第1层设计描述
2.2.1SystemArchitecture系统结构
2.2.1.1DescriptionoftheArchitecture系统结构描述
2.2.1.2RepresentationoftheBusinessFlow业务流程说明
用户模块：
房屋模块：
订单模块：
评论模块：
2.2.2DepositionDescription分解描述
2.2.2.1用户管理模块
1、简介
本模块负责用户的管理，包括前台的用户注册、登录、找回密码、注销、个人信息管理，以及后台的用户管理。
2、功能列表
功能名称
功能描述
用户注册
用户注册后成为的会员，可以使用的完整功能。
用户登录
用户注册后可以登录系统，使用的完整功能。
用户找回密码
用户在登录时若忘记密码，则可以通过找回密码来重置自己的密码。
用户注销
用户注销账户以后，不能再通过原来的用户名和密码来登录系统。
用户个人信息管理
用户登录后可以查看和修改个人信息。
用户管理
管理员登录后可以对用户进行管理，用户状态分为“正常”、“已冻结”、“注销待审核”和“已注销”四种，管理员可以冻结、解冻用户，对用户的注销申请进行审核。
2.2.2.1.1用户注册
1功能设计描述
（1）类
1）action.UserAction
用户模块的action类，负责用户模块相关的所有操作，是Struts的核心部分。
2）service.UserService
用户模块的业务逻辑类，负责对数据的真实操作，实例化dao中的对象并调用dao中的方法。
3）dao.BaseDao
通用的数据访问类，负责最基本的增删改查单个操作。
4）entity.User
用户的实体类，定义了用户类的各个属性，与数据库中的user表相互映射。
（2）类与类之间关系
（3）文件列表
如下表所示。
名称
类型
存放位置
说明
header.jsp
JSP
WebRoot/mon/header.jsp
公共的头部页面
2功能实现说明
2.2.2.1.2用户登录
1功能设计描述
同2.2.2.1.1用户注册。
2功能实现
2.2.2.1.3用户找回密码
1功能设计描述
同2.2.2.1.1用户注册。
2功能实现
2.2.2.1.4用户注销
1功能设计描述
（1）类
同2.2.2.1.1用户注册。
（2）类与类之间关系
同2.2.2.1.1用户注册。
（3）文件列表
如下表所示。
名称
类型
存放位置
说明
deregister.jsp
JSP
WebRoot/user/deregister.jsp
用户的注销页面
2功能实现
2.2.2.1.5用户个人信息管理
1功能设计描述
（1）类
同2.2.2.1.1用户注册。
（2）类与类之间关系
同2.2.2.1.1用户注册。
（3）文件列表
如下表所示。
名称
类型
存放位置
说明
admin.jsp
JSP
WebRoot/user/admin.jsp
用户的个人信息页面
edit.jsp
JSP
WebRoot/user/edit.jsp
用户的修改信息页面
editPass.jsp
JSP
WebRoot/user/editPass.jsp
用户的修密码页面
2功能实现
2.2.2.1.6用户管理
1功能设计描述
（1）类
1）action.AdminAction
管理员模块的action类，负责后台管理模块相关的所有操作，是Struts的核心部分。
2）service.AdminService
管理员模块的业务逻辑类，负责对数据的真实操作，实例化dao中的对象并调用dao中的方法。
3）dao.BaseDao
通用的数据访问类，负责最基本的增删改查单个操作。
4）entity.Admin
管理员的实体类，定义了管理员类的各个属性，与数据库中的admin表相互映射。
5）entity.User
用户的实体类，定义了用户类的各个属性，与数据库中的user表相互映射。
（2）类与类之间关系
（3）文件列表
如下表所示。
名称
类型
存放位置
说明
userNormal.jsp
JSP
WebRoot/admin/userNormal.jsp
正常用户页面
userFozen.jsp
JSP
WebRoot/admin/userFrozen.jsp
冻结用户页面
userChecking.jsp
JSP
WebRoot/admin/userChecking.jsp
注销待审核用户页面
userDeregister.jsp
JSP
WebRoot/admin/userDeregister.jsp
已注销用户页面
2功能实现说明
2.2.2.2房屋管理模块
1、简介
本模块负责房屋的管理，包括前台房东的创建、查看、修改、删除房屋，房客的搜索房屋、查看详情，以及后台的房屋管理。
2、功能列表
功能名称
功能描述
创建房屋
用户登录后可作为房东创建房屋，并提交管理员审核，审核通过后房屋上线，可供房客预订。
修改房屋
房东可对已创建的房屋进行信息修改。
删除房屋
房东可以删除已经创建的房屋。
查询房屋
房客可以指定关键词查询房东已经发布的房屋。
查看房屋详情
房客可以查看自己感兴趣的房屋详情。
审核房屋
管理员登录以后可对房东创建的房屋进行审核。
2.2.2.2.1创建房屋
1功能设计描述
（1）类
1）action.HouseAction
房屋模块的action类，负责房屋模块相关的所有操作，是Struts的核心部分。
2）service.HouseService
房屋模块的业务逻辑类，负责对数据的真实操作，实例化dao中的对象并调用dao中的方法。
3）dao.BaseDao
通用的数据访问类，负责最基本的增删改查单个操作。
4）entity.House
房屋的实体类，定义了房屋类的各个属性，与数据库中的house表相互映射。
5）entity.User
用户的实体类，定义了用户类的各个属性，与数据库中的user表相互映射。
（2）类与类之间关系
（3）文件列表
如下表所示。
名称
类型
存放位置
说明
create.jsp
JSP
WebRoot/house/create.jsp
创建房屋的页面
2功能实现说明
2.2.2.2.2修改房屋
1功能设计描述
（1）类
同2.2.2.2.1创建房屋。
（2）类与类之间关系
同2.2.2.2.1创建房屋。
（3）文件列表
如下表所示。
名称
类型
存放位置
说明
edit.jsp
JSP
WebRoot/house/edit.jsp
修改房屋的页面
2功能实现
2.2.2.2.3删除房屋
1功能设计描述
（1）类
同2.2.2.2.1创建房屋。
（2）类与类之间关系
同2.2.2.2.1创建房屋。
（3）文件列表
如下表所示。
名称
类型
存放位置
说明
checking.jsp
JSP
WebRoot/house/checking.jsp
待审核房屋的页面
fail.jsp
JSP
WebRoot/house/fail.jsp
审核未通过房屋的页面
offline.jsp
JSP
WebRoot/house/offline.jsp
下线房屋的页面
2功能实现
2.2.2.2.4查询房屋
1功能设计描述
（1）类
同2.2.2.2.1创建房屋。
（2）类与类之间关系
同2.2.2.2.1创建房屋。
（3）文件列表
如下表所示。
名称
类型
存放位置
说明
search.jsp
JSP
WebRoot/house/search.jsp
房屋搜索结果的页面
2功能实现
2.2.2.2.5查看房屋详情
1功能设计描述
（1）类
同2.2.2.2.1创建房屋。
（2）类与类之间关系
同2.2.2.2.1创建房屋。
（3）文件列表
如下表所示。
名称
类型
存放位置
说明
detail.jsp
JSP
WebRoot/house/detail.jsp
房客房屋详情的页面
details.jsp
JSP
WebRoot/house/details.jsp
房东房屋详情的页面
2功能实现
2.2.2.2.6审核房屋
1功能设计描述
（1）类
1）action.AdminAction
管理员模块的action类，负责后台管理模块相关的所有操作，是Struts的核心部分。
2）service.AdminService
管理员模块的业务逻辑类，负责对数据的真实操作，实例化dao中的对象并调用dao中的方法。
3）dao.BaseDao
通用的数据访问类，负责最基本的增删改查单个操作。
4）entity.House
房屋的实体类，定义了房屋类的各个属性，与数据库中的house表相互映射。
（2）类与类之间关系
（3）文件列表
如下表所示。
名称
类型
存放位置
说明
houseChecking.jsp
JSP
WebRoot/admin/houseChecking.jsp
待审核房屋的页面
2功能实现
2.2.2.3订单管理模块
1、简介
本模块负责订单的管理，包括前台的生成订单、取消订单、查询历史订单信息，以及后台的订单管理。
2、功能列表
功能名称
功能描述
生成订单
房客登录以后选择了自己心仪的房屋可以预订，生成订单交给房东审核。
取消订单
房客若临时改变行程，可在房东审核订单前取消订单，若房东已受理订单，则无法取消。
查询订单
管理员和用户可以查看订单。
审核订单
房东登录以后可对房客提交的订单进行审核。
2.2.2.3.1生成订单
1功能设计描述
（1）类
1）action.OrderAction
订单模块的action类，负责订单模块相关的所有操作，是Struts的核心部分。
2）service.OrderService
订单模块的业务逻辑类，负责对数据的真实操作，实例化dao中的对象并调用dao中的方法。
3）dao.BaseDao
通用的数据访问类，负责最基本的增删改查单个操作。
4）entity.House
房屋的实体类，定义了房屋类的各个属性，与数据库中的house表相互映射。
5）entity.User
用户的实体类，定义了用户类的各个属性，与数据库中的user表相互映射。
6）entity.Orders
订单的实体类，定义了订单类的各个属性，与数据库中的orders表相互映射。
（2）类与类之间关系
（3）文件列表
如下表所示。
名称
类型
存放位置
说明
detail.jsp
JSP
WebRoot/house/detail.jsp
房屋详情和预订房屋的页面
2功能实现说明
2.2.2.3.2取消订单
1功能设计描述
（1）类
同2.2.2.3.1生成订单。
（2）类与类之间关系
同2.2.2.3.1生成订单。
（3）文件列表
如下表所示。
名称
类型
存放位置
说明
guestChecking.jsp
JSP
WebRoot/order/guestChecking.jsp
房客待审核订单的页面
2功能实现
2.2.2.3.3查询订单
1功能设计描述
（1）类
同2.2.2.3.1生成订单。
（2）类与类之间关系
同2.2.2.3.1生成订单。
（3）文件列表
如下表所示。
名称
类型
存放位置
说明
guestChecking.jsp
JSP
WebRoot/order/guestChecking.jsp
房客待审核的订单页面
guestFail.jsp
JSP
WebRoot/order/guestFail.jsp
房客未通过审核的订单页面
guestSuccess.jsp
JSP
WebRoot/order/guestSuccess.jsp
房客审核通过的订单页面
guestCancel.jsp
JSP
WebRoot/order/guestCancel.jsp
房客已取消的订单页面
hostChecking.jsp
JSP
WebRoot/order/hostChecking.jsp
房东待审核的订单页面
hostFail.jsp
JSP
WebRoot/order/hostFail.jsp
房东未通过审核的订单页面
hostSuccess.jsp
JSP
WebRoot/order/hostSuccess.jsp
房东审核通过的订单页面
hostCancel.jsp
JSP
WebRoot/order/hostCancel.jsp
房东已被取消的订单页面
2功能实现
2.2.2.3.4审核订单
1功能设计描述
（1）类
同2.2.2.3.1生成订单。
（2）类与类之间关系
同2.2.2.3.1生成订单。
（3）文件列表
如下表所示。
名称
类型
存放位置
说明
hostChecking.jsp
JSP
WebRoot/order/hostChecking.jsp
房东待审核的订单页面
2功能实现
2.2.2.4评论管理模块
1、简介
本模块负责评论的管理，包括前台的添加评论、删除评论、评论显示，以及后台的评论管理。
2、功能列表
功能名称
功能描述
添加评论
房客登录以后可以对已经完成的订单进行评论，添加评论后交给管理员审核。
删除评论
房客对已经发表的评论可以进行删除。
查看评论
管理员和用户可以查看评论。
审核订单
管理员登录以后可对房客提交的评论进行审核。
修改评论
管理员登录以后可对房客提交的评论进行修改。
2.2.2.4.1添加评论
1功能设计描述
（1）类
1）action.mentAction
评论模块的action类，负责评论模块相关的所有操作，是Struts的核心部分。
2）service.mentService
评论模块的业务逻辑类，负责对数据的真实操作，实例化dao中的对象并调用dao中的方法。
3）dao.BaseDao
通用的数据访问类，负责最基本的增删改查单个操作。
4）entity.House
房屋的实体类，定义了房屋类的各个属性，与数据库中的house表相互映射。
5）entity.User
用户的实体类，定义了用户类的各个属性，与数据库中的user表相互映射。
6）entity.ment
评论的实体类，定义了评论类的各个属性，与数据库中的ment表相互映射。
（2）类与类之间关系
（3）文件列表
如下表所示。
名称
类型
存放位置
说明
guestSuccess.jsp
JSP
WebRoot/order/guestSuccess.jsp
用户已入住订单的页面
add.jsp
JSP
WebRoot/ment/add.jsp
用户添加评论的页面
2功能实现说明
2.2.2.4.2删除评论
1功能设计描述
（1）类
同2.2.2.4.1添加评论。
（2）类与类之间关系
同2.2.2.4.1添加评论。
（3）文件列表
如下表所示。
名称
类型
存放位置
说明
detail.jsp
JSP
WebRoot/ment/detail.jsp
用户评论详情的页面
2功能实现
2.2.2.4.3查看评论
1功能设计描述
（1）类
同2.2.2.4.1添加评论。
（2）类与类之间关系
同2.2.2.4.1添加评论。
（3）文件列表
如下表所示。
名称
类型
存放位置
说明
detail.jsp
JSP
WebRoot/house/detail.jsp
房屋详情页面
2功能实现
2.2.2.4.4审核评论
1功能设计描述
（1）类
1）action.AdminAction
管理员模块的action类，负责后台管理模块相关的所有操作，是Struts的核心部分。
2）service.AdminService
管理员模块的业务逻辑类，负责对数据的真实操作，实例化dao中的对象并调用dao中的方法。
3）dao.BaseDao
通用的数据访问类，负责最基本的增删改查单个操作。
4）entity.ment
评论的实体类，定义了评论类的各个属性，与数据库中的ment表相互映射。
（2）类与类之间关系
（3）文件列表
如下表所示。
名称
类型
存放位置
说明
checking.jsp
JSP
WebRoot/admin/checking.jsp
待审核评论页面
2功能实现
2.2.2.4.5修改评论
1功能设计描述
（1）类
同2.2.2.4.1添加评论。
（2）类与类之间关系
同2.2.2.4.1添加评论。
（3）文件列表
如下表所示。
名称
类型
存放位置
说明
edit.jsp
JSP
WebRoot/ment/edit.jsp
修改评论页面
2功能实现
2.2.3Inte
升级会员 