网站设计说明书

1 / 22 网站设计说明书 1、引言 编写目的 为了单点登录系统的可行性，完整性，并能按照预期的设想实现该系统，特编写需求说明书。 同时，说明书也发挥与策划和设计人员更好地沟通的作用。 背景 a鉴于集团运营的多个独立网站，每个网站都具有自己的身份验证机制，这样势必造成：生活中的 一位用户，如果要以会员的身份访问网站，需要在每个网站上注册，并且通过身份验证后，才能以会员的身份访问网 站；即使用户以同样的用户名与密码在每个网站上注册时，虽然可以在避免用户名与密码的忘记和混淆方面有一定的 作用，但是用户在某一段时间访问多个成员站点或在成员站点间跳转时，还是需要用户登录后，才能以会员的身份访 问网站。这样不仅给用户带来了不便，而且成员网站为登录付出了性能的代价； b如果所有的成员网站，能够实现单点登录，不仅在用户体验方面有所提高，而且真正2 / 22 体现了集团多个网站的兄弟 性。通过这种有机结合，能更好地体现公司大平台，大渠道的理念。同时，这样做也利于成员网站的相互促进与相互 宣传。 正是出于上面的两点，单点登录系统的开发是必须的，是迫在眉睫的。 定义 单点登录系统提供所有成员网站的“单一登录”入口。本系统的实质是含有身份验证状态的变量， 在各个成员网站间共用。单点登录系统，包括认证服务器，成员网站服务器。 会员：用户通过 Passport 服务器注册成功后，就具有了会员身份。 单一登录：会员第一次访问某个成员网站时，需要提供用户名与密码，一旦通过 Passport 服务器的身份验证， 该会员在一定的时间内，访问任何成员网站 都不需要再次登录。 Cookie 验证票：含有身份验证状态的变量。由 Passport 服务器生成，票含有用户名，签发日期时间， 过期日期时间和用户其它数据。 2、任务概述 目标 3 / 22 SSO 系统，是集团统一的 Passport， SSO 系统分两个阶段实施。第一阶段对于新注册的用户提供单点登录的功能。 第二阶段，整合各个成员网站已有会员到单点登录系统中。 Passport 服务器作为各个成员网站的惟一身份验证入口，需要考虑其性能，扩展性，稳定性，安全性和维 护成本。尤其 要注意第二阶段的开发，做到统筹考虑。 最终用户的特点 最终用户是数以万计网民。这就确定了用户使用电脑的水平是参差不齐的，在开发单点登录系统时，力争做到界面友 好，措词简单明了。用户不用学习，就能使用该系统。 3、需求规定 需求概述 1)注册： a.成员网站重定向到 Passport 服务器的注册页面，并且带有返回 URL 和成员网站 ID。 b.通过 Passport 注册页面创建会员后，保存会员验证票到数据库和 passport 服务器所在域 cookie 中。同时，4 / 22 在成员网站 的数据库上创建与 Passport 服务器数据库中会员的映射关系。 c. 重定向到成员网站，填写会员个性信息。 d. 保存会员个性信息，并把重定向传入的验证票保存到本地 cookie 和创建 Session 状态变量。 2）登录： a、 SSO 系统要实现各个成员网站的无缝结合，只要会员经过了认证服务器的登录验证，该会员访 问其它任何的网站时，都不需要再次登录。 b、 会员在 第一次登录时， Passport 服务器验证身份之后，生成的 cookie 验证票，只需保存到 Passport 服务器所在域的 cookie 中，不能采用向每个成员网站所在的域中写cookie,防止响应时间太长，给会员带来不友好的浏览体验。同 时，把下发给会员的 cookie 票保存到 Passport 服务器的数据库中，方便验证方式和会员行为统计的扩展。 c、 会员一经通过身份验证，成功登录了某个成员网站 ,需要利用 Session 和 cookie 两种方式保存会员已经登 录的状态。 d、 同一个浏览器进程中，会员在网站 A 的页面间跳转时，只需要根据 Session 中的状态变量加载登录框。不5 / 22 需要再与 Passport 服务器通信验证会员的身份。 e、 会员通过验证登录了网站 A,若会员从网站 A 跳转或重新打开浏览器登录其它成员网站，都需要与 Passport 服务器通信验证会员的票。但是，这次验证不要Passport 服务器与数据库中保存的验证票进行比较验证，只需要验证 Passport 服务器域中的 cookie 验证票据有效即可。 f、对于验证 cookie 票，能够实现加密和数字签名保证 cookie 的机密性，完整性和不可抵赖性。 g、 若果 Passport 服务器 Down 掉后，仍可以直接登录成员网站。 说明：上面高亮显示的表示二期开发功能。 3)登出、修改密码、找回密码和成员网站间的跳转，请查看 IPO 图表中相应的模块描述。 对功能的规定 SSO 系统包括注册、登录、登出、密码修改、密码找回、成员网站间跳转与用户管理模块。本说明书使用 HIPO图描述 系统机构和模块内部处理 功能，它主要包括层次结构图和 IPO 图两个部分。层次结构图描述了整个系统的结构以及各个 6 / 22 模块之间的关系； IPO 图则描述了在某个特定模块内部的输入、处理过程、输出思想。 A、系统结构图 图 1 SSO 系统结构图 B、层次结构图 图 2 系统层次结构图 详细设计说明书 1.引言 编写目的 本详细设计说明书是针对网络信息体系结构的课程作业而编写。目的是对该项目进行详细设计，在概要设计的基础上进一步明确系统结构 ，详细地介绍系统的各个模块，为进行后面的实现和测试作准备。本详细设计说明书的预期读者为本项目小组的成员以及对该系统感兴趣，在以后想对系统进行扩展和维护的人员。 背景 a.待开发的系统的名称： Lyra Resource Platform; b.本项目的任务提出者 : 赵东，成富，陈良，窦文敏 开发者：赵东，成富，陈良，窦文敏 用户：所有对该项目感兴趣，并想通过该项目的产品提高资源检索速度和质量，方便的进行资源检索，预览，7 / 22 上传及下载的用户。 2. 系统的结构 ? ui：系统界面部分，负责接受用户输入，显示系统输出，负责其他模块功能的协调调用， 并含有站内搜索功能，即在用户指定的已打开的 ftp站点中搜索用户需要的资源。 ui 部分调用 common 部分的功能读取 xml 文件中保存的界面元素属性信息，用户最近访问过的 10 个 ftp 信息，用户选择的下载的 ftp 内容列表及其他需要通过 xml 文件保存的信息。 ? client：实现 ftp 客户端的功能， ftp 连接， ftp上传及下载：上传或下载用户指定的 资源，并返回相 应的信息。 ? search:资源实时检索部分，根据用户输入的资源名称关键字，资源类型和选择的检索 方式检索用户需要的资源，并验证资源的可用性，返回可用资源及其大小，速度等相关信息。 ? preview：资源预览部分，显示用户选择的资源的部分内容，以使用户决定是否需要该 资源。 preview 部分调用 common 部分读取属性文件的内容亦显示预览资源内容的显示格式。 3模块 1 设计说明 模块描述 8 / 22 实现用户界面的包，含有 11 个文件 51 个类，是本系统中最复杂的代码。 功能 负责接受用户输入，显示系统输出，其他模块功能的协调调用，并含有站内搜索功能，即在用户指定的已打开的 ftp 站点中搜索用户需要的资源。 交互的模块 client， search， preview， common。 模块设计 该模块中的主要文件，文件中包含的主要类及其功能和与其它包的交互如下： ? ： MainFrame 是含有主函数的类，也是 lyra 客户端开始执行的类，它先后进行资源的初始化，显 示主界面等工作，根据屏幕大小设置界面大小，设置界面的观感。 ? FtpFrame_:显示关于窗口的类，当用户点击帮助菜单中的关于菜单 项时会弹出关于对话框。 ? ： FileTools 是文件操作辅助类，可以实现文件的递归删除等。 ? : JDOMTes 是操作 xml 文件的类，用 JDOM 来操作xml 文件， 实现的功能有： 9 / 22 保存 ftp 服务器的文件列表，递归的从 ftp 服务器读取列表，并存入一个 xml 文件中 ;以目录树的形式保存。 根据文 件名在文件中查找文件，站内搜索时使用。 保存 ftp 服务器的信息： ip，端口，用户名，密码，最多存 10 个；存在 resourcesettings 文件中。 读取已存储的 ftp 服务器信息。 从读取搜索的类型。 ? :放置系统运行时使用的一些常量， initcontent函数对所有常量进行 初始化，这个函数在 MainFrame 中被调用一次。iconHashMap 是 hash 表，用于存放文件的系统图标。 ? ：包含自定义的控件类， java 中的控件 可能不能满足需求， 需要自己定义某些属性。这些控件会在创建界面时使用。其中含有的类有： CustomizedJTable 是表格类，设置表格的某些属性，如字体等。 CustomizedTableCellRenderer 是表格单元格绘制器类，主要用于显示文件的系统图标，和文件名。 LeftPanel 类的父类是 JTabbedPane，用户显示主窗口左边的面板。 RightPanel 类的父类是 JPanel，用户显示右边的主10 / 22 题部分，包括右上边的搜索及服务器选 项，和中间的显示服务器文件的 TabbedPane。 . BottomPanel 类是右下放显示下载和服务器信息的JTabbedPane。 CustomizedJButton 是定义按钮类，更改了按钮的字体， java 本身默认的字体不好看。 CustomizedTableModel 是表格类，实现单元格的不可编辑。 CustomizedTableCellRenderer_Remote 类是表格绘制器，在远程文件浏览器 RemoteFilesPanel 使用，用于显示文件名和文 件图标。 FontTableCellRenderer 类是表格单元格绘制器，主要功能是设置字体。 FontListCellRenderer 类是下拉列表框单元格绘制器，主要用于设置字体。 CustomizedJLabel 类是自定义标签类，重新设置了标签的字体。 CustomizedJTextField 类是自定义文本框类，主要用于设置文本框的显示属性。 CustomizedJMenu 类是自定义菜单类，重新设置了菜单的字体。 CustomizedJMenuItem 类是自定义菜单项类，重新设11 / 22 置了菜单的字体。 CustomizedListCellRenderer 类是 JComboBox 即组合框单元格绘制器，用于在本地路径选择的下拉列表中显示磁盘图标。 ? , SearchResultReceiver 是一个接口，主要用于返回搜索结果。 搜索完成后调用接口中的函数通知调用者。其中主要有两个函数： OnSearchFinished;result 是一个 10 维的数组表result10,resulti是由类型 为 i 的资源组成的数组。 i：0 9，和类型列表框中的顺序一致。 OnSearchFinished;不分类型，将所有资源放在一个数组表中。 ? :FtpFrame 是程序主窗口类，类型为 JFrame,是由三个分割窗口 JSplitPane 构成的。 jSplitPane_Left 是左边的分割窗口，水平分割条上边显示本地文件框，下边是预览框； jSplitPane_Right 是右边的分割窗口，水平分割条上边是服务器选项和 ftp 服务器文件显示的窗口，下边是下载和服务器信息 显示窗口； jSplitPane_Whole 是整体的分割窗口，垂直分割条，左边是 jSplitPane_Lef，右边是 jSplitPane_Right。 12 / 22 FtpFrame 把 LeftPanel， RightPanel， BottomPanel，PreviewWrapperPanel 这几部分安装在相应的分割窗格中；LeftPanel， RightPanel， BottomPanel 是在中定义的，PreviewWrapperPanel 是在 Preview 包中定义的。 ? : LocalFilesPanel 是本地文件面板，用表格来显示本地文件的信 息。上边是组合框，显示了磁盘分区通过这里可以改变根目录。表格中显示了文件的信息，包括文件名，文件的系统图标，大小，最近修改日期，属性等。选中一个文件后可以执行上载和删除操作。文件夹会递归的删除。GetCurrentPath 函数返回当前的路径。 DisplayPathFiles函数在列表中显示指定目录下的文件。 ? ：定义右上边的控件。含有的类有： FtpServerOptionPanel 类是服务器连接选项面板，包含服 务器地址，端口，用户名，密码等，还包括最上端的搜索选项。 openRemoteFilesPanel 函数在下面的 TabbedPane中打 开一个新的服务器面板，连接服务器。 RemoteFilesPanel 类的主要功能是连接 Ftp 服务器并显示文件。这里会进行文件的上载，下载及预览等操作。RemoteFilesPanel 的内部类 TransferController 负责调用FtpClient 类提供的功能与服务器进行交互，完成用户指定13 / 22 的文件操作。 TransferController 还有三个 内部类：ConnThread 类 是 负 责 连 接 服 务 器 的 线 程 ，DownloadFileThread 类 是 下 载 文 件 的 线 程 ，UploadFileThread 类是上载文件的线程。 SearchResultPanel 类是显示搜索结果的类，它有两个子类 SearchResultPanelWithinSearchEngine 类的功能是在搜索引擎中搜索， SearchResultPanelWithinServer 类的功能是站内搜索。搜索引擎的搜索会调用 search 包中的程序，搜索引擎搜索完成后 search 包通过 OnSearchFinished来通知 SearchResultPanelWithinSearchEngine 类，然后显示搜索结果。 RightTabbedPane 是显示 ftp 服务器文件表格的TabbedPane 类。 ? ：实现主窗口下部面板及控件，显示下载情况，服务器连接信息。 包含的主要类有： RemoteMessPanel 类是显示服务器连接信息的面板。需要显示 ftp 服务器传回的信息，并在显示前进行编码转换，还需要显示本地的相关信息。 DownloadingMessPanel 类是显示资源下载信息的面板，显示下载资源的大小，下载速度，已用时间，剩余时间等信息。 14 / 22 流程逻辑 总体流程： Lyra Resource Platform 简单类图 文档 详细设计说明书 4模块 2 设计说明 模块描述 实现 ftp 客户端 FtpClient，有两个文件和 ,前者具体实现了 ftp 协议，后者是为登录时可能抛出的异常而定义的类。 功能 实现 ftp 客户端 FtpClient，实现了 ftp 协议，用于和 ftp 服务器通讯和数据传输。 交互的模块 ui 模块设计 该模块中的主要文件，文件中包含的主要类及其功能和与其它包的交互如下： ? ：含有类 FtpClient,，该类会被 ui 包中的界面类调用，完成 ftp 功能。 其中要功能的实现有： 说明：此内容之前有封面，扉页，设计情况简介，目录。 15 / 22 正文部分的文字说明必须与所设计的网站实际内容严格对应，如果没有真正上传到 Internet，则“开发工具”中的“上 网方案”和“申请域名”部分可酌情写或省略不写。首页下的各二级页面必须进行说明并有抓图。凡是利用编程方法制作的内容，应在所描述内容之后给出程序代码，或在最后即“参考文献”之后，增加“附录”给出有关部分的程序代码。 以下正文中“蓝色字体”表示给出的注释。正文的排版要求另见“毕业设计说明书排版格式要求”文件。 XXX 网站设计说明书 一 绪 论 在 Internet 飞速发展的今天，互联网成为人们快速获取、发布和传递信息的重要渠道，它在人们政治、经济、生活等各个方面发挥着重要的作 用。 科技的发展、时代的进步传统的教育方式被大大的局限于一定的范围之内，教育的网络化发展是其自身发展的必然趋势，也是时代发展、社会进步的必然趋势。作为首选的 front page 有它自身的先决条件。通过我们不断的对其功能的诠释，同时我们也可以通过教育方式和教育水平的提高，我们将能更好的开发出我们所需的其自身更深层次的功能与作用。 Internet 上发布信息主要是通过网站来实现的，获取信息也是要在 Internet“海洋”中按照一定的检索方式将所需要的信息从网站上下载下来。因此网站建设在 Internet 应用上的地位 显而易见，16 / 22 它已成为政府、企事业单位信息化建设中的重要组成部分，从而倍受人们的重视。 网站的总体规划 我们在制作网页前首先要做的是要对网页内容进行一下具体的规划 ,确定一下制作的思路和目的 ,从而更方便我们的设计和制作。 创建新网页最佳方法是先建立原型系统，再进行详细设计，最后正式实施。 原型系统最主要的目标是学习、尝试采用不同的方法修改目标、更新形象。原型系统开发过程中要解决网页建设的一些基本问题。 例如： 网页的结构； 网页 整体风格的构思和素材的搜集； 主页的制作； 存储信息的物理方法； 结构的完整性和一致性的维护方法。 这些问题没有绝对的答案，只能在制作网页时根据实际情况进行选择。详细设计包括画面的布局、系统的内部结构、实现方法和维护方法等。 网站建设的需求和目的 房地产行业是中国国民经济的主导产业，这个行业17 / 22 正处于向规模化、品牌化、规范化运作的转型时期，在强劲市场需求的拉动下，天津市房地产市场迅速扩大，房地产业投资、施工、销售等各项指标呈全面增长 态势。房地产业正在成为促进天津市经济增长的重要产业。当然，这样一个在现代社会经济生活中有着举足轻重的地位的行业就应该有力度的宣传，每个房地产公司也就都应该有一个象征公司的网站，如此才能更好的让群众们了解公司，熟知公司，达到企业知名度。 我的建站目的：房地产行业是一个特殊的产业，与其它商品最大的区别是消费者一般一生只购买一次。所以，房地产行业的公司不会像其他类型公司一样热中于培养忠诚的消费客户，而是在不断地寻找新客户。所以房地产公司网站建设的目的和功能可以概括为四点：一是做个性，展示房地产公司；二 是做虚拟，展示开发楼盘；三是做网络化销售，拓宽销售渠道；四是做增值，树立企业形象，增加无形资产。 二 开发工具 网页制作使用的技术 整个公司网站的建设运用到网页三剑客制作技术。网页设计技术是随着互联网及电子商务的发展应运而生的，利用这种技术，可以设计制作出各种不同风格的网页，向人们展示互联网最生动的一面。著名的 Macromedia 公司的有18 / 22 着网页设计 三剑客 之称的 Dreamweaver、 Fireworks 和Flash 软件，能独立设计和开发出精美的网页。 Dreamweaver在多媒体方面颇有建树的 Macromedia 公司推出的可视化网页制作工具，它与 Flash、 Fireworks 合在一起被称为网页制作三剑客，这三个软件相辅相承，是制作网页的最佳选择。其中， Dreamweaver 主要用来制作网页文件，制作出来的网页兼容性比较好，制作效率也很高， Flash 用来制作精美的网页动画，而 Fireworks 不仅仅是一个图象处理工具，它还是一个全功能的 web 设计工具。此外，在整个网页制作中我还加入了 Javascript 脚本语言，通过这个技术的使用让网站又增加了很多亮点，显得更加生动。 网站中的公司 LOGO 是我自己用 Fireworks 制作的，整个 LOGO 的制作，融入了我个人的一些想法和创意。 上网方案 企业上网有很多方式，有自己组建网络、主机托管和虚拟主机等方式。虚拟主机是用于存放网站，一般个人制作的网站出于流量费用等因素考虑 不会为网站存放选用整个服务器，服务商把一台服务器划分成若干个目录提供给他们使用，每一个目录都是一个虚拟主机。因资金有限和网站的规模较小，今后企业网站发布，我预选的方案是中国频道的虚拟主机服务， 798 元 /每年，提供以下服务： 900MB WEB 空间 19 / 22 100MB LOG 空间 WINDOWSXX 操作系统 全面支持 流量可自由升级 免费赠送 LM 流量分析系统，及时准确地流量统计报告 不定期数据备份 功能强大的控制面板管理 最快捷的 WEB 文件管理功能 免费赠送企业名片 申请域名 域名的选择，我初步决定还是在“中国频道”注册，它毕竟是大中华区首家通过 ICANN 认 证的顶级注册商 ,目前域名注册量亚洲第一。中国频道现在推出 .CN 类英文域名促销价： 98 元 /个 /年，域名我决定用 http:/ 三 内容规划 栏目板块和结构 1、网站主体布局图参见下图： 2、网站首页布局图参见下图： 应绘制首页各部分内容的布局图略 3、连锁体系：主要介绍宇轩不动产的所有连锁店的地理位置、联系方式等，采用表