短租网系统设计文档

1、项目名称Project Name密级Confidentiality Level轻松短租网仅供收件方查阅项目编号Project ID版本Version文档编号Document Codev9.4348.2761.322.0v9.4348.2761.32_SD_001Shortrent Software System High Level Design Specification 轻松短租网 软件系统概要设计说明书 Prepared by 拟制黄蓉Date日期2015-07-22Reviewed by 评审人李鹏Date日期Approved by批准周伟Date日期 武汉市软酷网络科技有限公司版权所

2、有 不得复制Copyright Ruankosoft Technologies(WuHan) Co., Ltd. All Rights ReservedRevision Record修订记录Date日期Revision Version修订版本CR ID /Defect IDCR/ Defect号Sec No.修改章节Change Description修改描述Author作者2015-07-081.0初稿黄蓉2015-07-221.02、3、4、5填充黄蓉2015-07-232.0第二次迭代黄蓉目 录1 Introduction 简介61.1 Purpose 目的61.2 Scope 范围61

3、.2.1 Name 软件名称61.2.2 Functions 软件功能61.2.3 Applications软件应用61.3 Reference 参考资料62 High Level Design 概要设计72.1 Level 0 Design Description 第0层设计描述72.1.1 软件系统上下文定义72.1.2 Design Considerations设计思路72.2 Level 1 Design Description 第1层设计描述102.2.1 System Architecture系统结构 Description of the Architecture

4、系统结构描述 Representation of the Business Flow业务流程说明102.2.2 Decomposition Description分解描述 用户管理模块.1 用户注册.2 用户登录.3 用户找回密码.4 用户注销.5 用户个人信息管理.6 用户管理 房屋管理模块.1 创建房屋.2 修改房屋.3 删除房屋.4 查询房屋242.2.2.

5、2.5 查看房屋详情.6 审核房屋2 订单管理模块2.1 生成订单2.2 取消订单30.3 查询订单30.4 审核订单3 评论管理模块3.1 添加评论3.2 删除评论3.3 查看评论3.4 审核评论3.5 修改评论382.2.3 Interface Description接口描述383 Data Structure 数据结构/Database Design 数据库设计393.1 概念模型393.2 数据库表

6、设计393.3 基础数据配置414 UI Design 界面设计424.1 主页424.2 注册界面434.3 登录界面434.4 找回密码界面444.5 个人信息界面444.6 注销界面464.7 创建房屋界面464.8 删除房屋界面474.9 查询房屋界面484.10 房屋详情界面494.11 后台管理界面504.12 审核房屋界面505 Error Design 出错处理设计52Keywords 关键词：短租Abstract 摘 要： 本文档是基于轻松短租网软件系统的概要设计及说明书，用于指导编码实现阶段工作，也是产品最终提交文档之一，描述的是轻松短租网系统的模块功能点分析，本文档主要针

7、对轻松短租网系统各个业务功能模块进行外界环境、系统框架、业务流程、功能类上的分析。List of abbreviations 缩略语清单：Abbreviations缩略语Full spelling 英文全名Chinese explanation 中文解释1 Introduction 简介1.1 Purpose 目的本系统设计文档是为设计人员和开发人员而编写的，它说明了本系统的各项功能和性能需求，明确标识各功能的实现过程，阐述使用范围及背景，提供客户解决问题或达到目标所需的条件或权能，提供一个度量和遵循的标准。本说明书的预期读者为中间用户（指软件的管理人员、设计人员、开发人员、测试人员、维护人员

8、）。1.2 Scope 范围1.2.1 Name 软件名称轻松短租网1.2.2 Functions 软件功能请参考轻松短租网系统需求规格说明书2.2 章节。1.2.3 Applications软件应用轻松短租网，给用户提供了一个房屋短期出租和预订房屋的平台。1.3 Reference 参考资料无。2 High Level Design 概要设计 2.1 Level 0 Design Description 第0层设计描述2.1.1 软件系统上下文定义2.1.2 Design Considerations设计思路1、系统的三层架构包的结构图如下图所示：系统分为action（视图层）、servic

9、e(业务逻辑层)、dao(数据访问层)，它们通过调用entity（业务模型）来完成数据的传递，其中有一部分类会被多处公用，就像工具一样，这时把它们统一放在util中。2、程序的框架系统使用Struts MVC模式，Struts与三层架构的结合中，Struts主要是负责页面（表示层）与业务模型（业务逻辑层）之间的控制转向。实际上是实现了表示层与业务模型层的松耦合，同时也增强了业务模型层的重用性。将Struts引入三层结构，可以将Struts位于Web表示层，构成表示层（com.ruanko.action）、业务逻辑层（com.ruanko.service）和数据访问层（com.ruanko.da

10、o），每层之间传递业务类，即com.ruanko.entity中类。三层结构与Struts结合包层次结构如下表所示：程序架构文件与目录结构表示层(Struts)JSP页面struts.xmlcom.ruanko.action业务逻辑层com.ruanko.service数据访问层com.ruanko.dao模型类com.ruanko.entity3、程序的目录结构文件夹名说明img存放图片js存放脚本文件css存放样式文件common存放公共页面admin存放后台管理页面user存放用户模块页面house存放房屋模块页面order存放订单模块页面2.2 Level 1 Design Descr

11、iption 第1层设计描述2.2.1 System Architecture系统结构 Description of the Architecture系统结构描述 Representation of the Business Flow业务流程说明用户模块：房屋模块：订单模块：评论模块：2.2.2 Decomposition Description分解描述 用户管理模块1、简介本模块负责用户的管理，包括前台的用户注册、登录、找回密码、注销、个人信息管理，以及后台的用户管理。2、功能列表功能名称功能描述用户注册用户注册后成为网站的会员，可以使用网站的完整功

12、能。用户登录用户注册后可以登录系统，使用网站的完整功能。用户找回密码用户在登录时若忘记密码，则可以通过找回密码来重置自己的密码。用户注销用户注销账户以后，不能再通过原来的用户名和密码来登录系统。用户个人信息管理用户登录后可以查看和修改个人信息。用户管理管理员登录后可以对用户进行管理，用户状态分为“正常”、“已冻结”、“注销待审核”和“已注销”四种，管理员可以冻结、解冻用户，对用户的注销申请进行审核。.1 用户注册1 功能设计描述（1）类1）action.UserAction用户模块的action类，负责用户模块相关的所有操作，是Struts的核心部分。2）service.User

13、Service用户模块的业务逻辑类，负责对数据的真实操作，实例化dao中的对象并调用dao中的方法。3）dao.BaseDao通用的数据访问类，负责最基本的增删改查单个操作。4）entity.User用户的实体类，定义了用户类的各个属性，与数据库中的user表相互映射。（2）类与类之间关系（3）文件列表如下表所示。名称类型存放位置说明header.jspJSPWebRoot/common/header.jsp公共的头部页面2 功能实现说明.2 用户登录1 功能设计描述同.1 用户注册。2 功能实现.3 用户找回密码1 功能设计描述同.1

14、用户注册。2 功能实现.4 用户注销1 功能设计描述（1）类同.1 用户注册。（2）类与类之间关系同.1 用户注册。（3）文件列表如下表所示。名称类型存放位置说明deregister.jspJSPWebRoot/user/deregister.jsp用户的注销页面2 功能实现.5 用户个人信息管理1 功能设计描述（1）类同.1 用户注册。（2）类与类之间关系同.1 用户注册。（3）文件列表如下表所示。名称类型存放位置说明admin.jspJSPWebRoot/user/admin.jsp用户的个人信息页面edi

15、t.jspJSPWebRoot/user/edit.jsp用户的修改信息页面editPass.jspJSPWebRoot/user/editPass.jsp用户的修密码页面2 功能实现.6 用户管理1 功能设计描述（1）类1）action.AdminAction管理员模块的action类，负责后台管理模块相关的所有操作，是Struts的核心部分。2）service.AdminService管理员模块的业务逻辑类，负责对数据的真实操作，实例化dao中的对象并调用dao中的方法。3）dao.BaseDao通用的数据访问类，负责最基本的增删改查单个操作。4）entity.Admin管理

16、员的实体类，定义了管理员类的各个属性，与数据库中的admin表相互映射。5）entity.User用户的实体类，定义了用户类的各个属性，与数据库中的user表相互映射。（2）类与类之间关系（3）文件列表如下表所示。名称类型存放位置说明userNormal.jspJSPWebRoot/admin/userNormal.jsp正常用户页面userFozen.jspJSPWebRoot/admin/userFrozen.jsp冻结用户页面userChecking.jspJSPWebRoot/admin/userChecking.jsp注销待审核用户页面userDeregister.jspJSPWeb

17、Root/admin/userDeregister.jsp已注销用户页面2 功能实现说明 房屋管理模块1、简介本模块负责房屋的管理，包括前台房东的创建、查看、修改、删除房屋，房客的搜索房屋、查看详情，以及后台的房屋管理。2、功能列表功能名称功能描述创建房屋用户登录后可作为房东创建房屋，并提交管理员审核，审核通过后房屋上线，可供房客预订。修改房屋房东可对已创建的房屋进行信息修改。删除房屋房东可以删除已经创建的房屋。查询房屋房客可以指定关键词查询房东已经发布的房屋。查看房屋详情房客可以查看自己感兴趣的房屋详情。审核房屋管理员登录以后可对房东创建的房屋进行审核。.1 创建

18、房屋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）文件列表如下表所示。名称类

19、型存放位置说明create.jspJSPWebRoot/house/create.jsp创建房屋的页面2 功能实现说明.2 修改房屋1 功能设计描述（1）类同.1 创建房屋。（2）类与类之间关系同.1 创建房屋。（3）文件列表如下表所示。名称类型存放位置说明edit.jspJSPWebRoot/house/edit.jsp修改房屋的页面2 功能实现.3 删除房屋1 功能设计描述（1）类同.1 创建房屋。（2）类与类之间关系同.1 创建房屋。（3）文件列表如下表所示。名称类型存放位置说明checking.jspJ

20、SPWebRoot/house/checking.jsp待审核房屋的页面fail.jspJSPWebRoot/house/fail.jsp审核未通过房屋的页面offline.jspJSPWebRoot/house/offline.jsp下线房屋的页面2 功能实现.4 查询房屋1 功能设计描述（1）类同.1 创建房屋。（2）类与类之间关系同.1 创建房屋。（3）文件列表如下表所示。名称类型存放位置说明search.jspJSPWebRoot/house/search.jsp房屋搜索结果的页面2 功能实现.5 查看房屋详情1 功能设计描述（1

21、）类同.1 创建房屋。（2）类与类之间关系同.1 创建房屋。（3）文件列表如下表所示。名称类型存放位置说明detail.jspJSPWebRoot/house/detail.jsp房客房屋详情的页面details.jspJSPWebRoot/house/details.jsp房东房屋详情的页面2 功能实现.6 审核房屋1 功能设计描述（1）类1）action.AdminAction管理员模块的action类，负责后台管理模块相关的所有操作，是Struts的核心部分。2）service.AdminService管理员模块的业务逻辑类，负责对数据的真实操作

22、，实例化dao中的对象并调用dao中的方法。3）dao.BaseDao通用的数据访问类，负责最基本的增删改查单个操作。4）entity.House房屋的实体类，定义了房屋类的各个属性，与数据库中的house表相互映射。（2）类与类之间关系（3）文件列表如下表所示。名称类型存放位置说明houseChecking.jspJSPWebRoot/admin/houseChecking.jsp待审核房屋的页面2 功能实现 订单管理模块1、简介本模块负责订单的管理，包括前台的生成订单、取消订单、查询历史订单信息，以及后台的订单管理。2、功能列表功能名称功能描述生成订单房客登录以后选择了自己心

23、仪的房屋可以预订，生成订单交给房东审核。取消订单房客若临时改变行程，可在房东审核订单前取消订单，若房东已受理订单，则无法取消。查询订单管理员和用户可以查看订单。审核订单房东登录以后可对房客提交的订单进行审核。.1 生成订单1 功能设计描述（1）类1）action.OrderAction订单模块的action类，负责订单模块相关的所有操作，是Struts的核心部分。2）service.OrderService订单模块的业务逻辑类，负责对数据的真实操作，实例化dao中的对象并调用dao中的方法。3）dao.BaseDao通用的数据访问类，负责最基本的增删改查单个操作。4）entity

24、.House房屋的实体类，定义了房屋类的各个属性，与数据库中的house表相互映射。5）entity.User用户的实体类，定义了用户类的各个属性，与数据库中的user表相互映射。6）entity.Orders订单的实体类，定义了订单类的各个属性，与数据库中的orders表相互映射。（2）类与类之间关系（3）文件列表如下表所示。名称类型存放位置说明detail.jspJSPWebRoot/house/detail.jsp房屋详情和预订房屋的页面2 功能实现说明.2 取消订单1 功能设计描述（1）类同.1 生成订单。（2）类与类之间关系同.1 生成订单。

25、（3）文件列表如下表所示。名称类型存放位置说明guestChecking.jspJSPWebRoot/order/guestChecking.jsp房客待审核订单的页面2 功能实现.3 查询订单1 功能设计描述（1）类同.1 生成订单。（2）类与类之间关系同.1 生成订单。（3）文件列表如下表所示。名称类型存放位置说明guestChecking.jspJSPWebRoot/order/guestChecking.jsp房客待审核的订单页面guestFail.jspJSPWebRoot/order/guestFail.jsp房客未通过审核的订单页面gue

26、stSuccess.jspJSPWebRoot/order/guestSuccess.jsp房客审核通过的订单页面guestCancel.jspJSPWebRoot/order/guestCancel.jsp房客已取消的订单页面hostChecking.jspJSPWebRoot/order/hostChecking.jsp房东待审核的订单页面hostFail.jspJSPWebRoot/order/hostFail.jsp房东未通过审核的订单页面hostSuccess.jspJSPWebRoot/order/hostSuccess.jsp房东审核通过的订单页面hostCancel.jspJS

27、PWebRoot/order/hostCancel.jsp房东已被取消的订单页面2 功能实现.4 审核订单1 功能设计描述（1）类同.1 生成订单。（2）类与类之间关系同.1 生成订单。（3）文件列表如下表所示。名称类型存放位置说明hostChecking.jspJSPWebRoot/order/hostChecking.jsp房东待审核的订单页面2 功能实现 评论管理模块1、简介本模块负责评论的管理，包括前台的添加评论、删除评论、评论显示，以及后台的评论管理。2、功能列表功能名称功能描述添加评论房客登录以后可以对已经完成的订单进行评论，

28、添加评论后交给管理员审核。删除评论房客对已经发表的评论可以进行删除。查看评论管理员和用户可以查看评论。审核订单管理员登录以后可对房客提交的评论进行审核。修改评论管理员登录以后可对房客提交的评论进行修改。.1 添加评论1 功能设计描述（1）类1）action.CommentAction评论模块的action类，负责评论模块相关的所有操作，是Struts的核心部分。2）service.CommentService评论模块的业务逻辑类，负责对数据的真实操作，实例化dao中的对象并调用dao中的方法。3）dao.BaseDao通用的数据访问类，负责最基本的增删改查单个操作。4）entit

29、y.House房屋的实体类，定义了房屋类的各个属性，与数据库中的house表相互映射。5）entity.User用户的实体类，定义了用户类的各个属性，与数据库中的user表相互映射。6）entity.Comment评论的实体类，定义了评论类的各个属性，与数据库中的comment表相互映射。（2）类与类之间关系（3）文件列表如下表所示。名称类型存放位置说明guestSuccess.jspJSPWebRoot/order/guestSuccess.jsp用户已入住订单的页面add.jspJSPWebRoot/comment/add.jsp用户添加评论的页面2 功能实现说明.2 删除评

30、论1 功能设计描述（1）类同.1 添加评论。（2）类与类之间关系同.1 添加评论。（3）文件列表如下表所示。名称类型存放位置说明detail.jspJSPWebRoot/comment/detail.jsp用户评论详情的页面2 功能实现.3 查看评论1 功能设计描述（1）类同.1 添加评论。（2）类与类之间关系同.1 添加评论。（3）文件列表如下表所示。名称类型存放位置说明detail.jspJSPWebRoot/house/detail.jsp房屋详情页面2 功能实现.4 审核评论1 功能设计描述（1）类1）

31、action.AdminAction管理员模块的action类，负责后台管理模块相关的所有操作，是Struts的核心部分。2）service.AdminService管理员模块的业务逻辑类，负责对数据的真实操作，实例化dao中的对象并调用dao中的方法。3）dao.BaseDao通用的数据访问类，负责最基本的增删改查单个操作。4）entity.Comment评论的实体类，定义了评论类的各个属性，与数据库中的comment表相互映射。（2）类与类之间关系（3）文件列表如下表所示。名称类型存放位置说明checking.jspJSPWebRoot/admin/checking.jsp待审核评论页面2

32、 功能实现.5 修改评论1 功能设计描述（1）类同.1 添加评论。（2）类与类之间关系同.1 添加评论。（3）文件列表如下表所示。名称类型存放位置说明edit.jspJSPWebRoot/comment/edit.jsp修改评论页面2 功能实现2.2.3 Interface Description接口描述无。3 Data Structure 数据结构/Database Design 数据库设计3.1 概念模型3.2 数据库表设计管理员表（Admin）字段类型可为空描述admin_idInteger否管理员编号admin_nameString否管理员名称

33、admin_passwordString否管理员密码admin_emailString否管理员邮箱用户表（User）字段类型可为空描述user_idInteger否用户编号user_nameString是用户名user_passwordString否用户密码user_emailString否用户电子邮箱user_phoneString是用户手机号user_stateString否用户状态（正常、冻结、注销、注销待审核）deregister_reasonString是用户注销原因user_register_timeDate否用户注册时间房屋表（House）字段类型可为空描述house_idInt

34、eger否房屋编号user_idInteger否房屋所属的用户编号house_titleString否房屋标题house_typeString否房屋类型（别墅、公寓）rent_typeString否出租类型（整租、单间、床位）house_areaInteger否房屋面积house_addressString否房屋地址guest_numInteger否可住人数bedroom_numInteger否卧室数量bed_numInteger否床数量bathroom_numInteger否卫生间数量house_photoString否房屋照片house_describeString是房屋描述house_p

35、riceDouble否房屋价格house_facilityString是房屋设施min_dayInteger是最少入住天数max_dayInteger是最多入住天数checkin_timeDate是入住时间checkout_timeDate是退房时间house_ruleString是房屋使用规则house_stateString否房屋状态house_create_timeDate否房屋创建时间订单表（orders）字段类型可为空描述order_idInteger否订单编号user_idInteger否房客编号house_idInteger否房屋编号checkin_dateDate否入住时间ch

36、eckout_dateDate否退房时间living_daysInteger否入住天数total_priceInteger否总价order_stateString否订单状态comment_stateString否评论状态order_create_timeDate否订单生成时间评论表（comment）字段类型可为空描述comment_idInteger否评论编号order_idInteger否订单编号host_rangeInteger否房东评级1-5house_rangeInteger否房屋评级1-5comment_contentString否评论内容comment_create_timeDate否评论添加时间3.3 基础数据配置管理员（admin）表中默认配置管理员用户名为admin，密码为shortrent。4 UI Design 界面设计4.1 主页1 界面原图 2 界面说明左上角为网站logo，点击可回到主页；中上部为房屋搜索框，用户可输入地点来搜索对应的房屋；右上角为注册、登录和发布房屋按钮，点击后跳转到