基于web聊天系统的设计与实现概要设计说明书

计计 算算 机机 学学 院院 基于基于 WebWeb 聊天系统的设计与实现聊天系统的设计与实现 概要设计说明书概要设计说明书 学学 生生 姓姓 名名： 组组 号号： 4141 年年级级班班级级：2 20 01 13 3级级应应用用 3 3、4 4班班 指指导导教教师师：刘刘魁魁 ( (教教师师 ) ) 所所在在学学院院：计计算算机机学学院院 提提交交日日期期：2 20 01 15 5年年 1 12 2月月 9 9日日 目目 录录 论文总页数：页 1. . 引言引言1 1.1. 编写目的1 1.2. 背景概述1 1.3. 术语3 1.4. 参考资料3 2. . 总体设计总体设计4 2.1. 系统功能结构4 2.2. 运行环境4 2.2.1. 硬件环境.4 2.2.2. 软件环境.4 2.3. 系统的关键技术5 3. . 构件设计构件设计5 3.1. 构件列表5 3.2. 构件集成说明5 3.3. 构件 01.6 3.3.1. 功能模块列表.6 3.3.2. 功能模块 016 3.3.3. 功能模块 28 3.4. 构件 02.9 3.4.1. 功能模块列表.9 3.4.2. 功能模块 0110 3.4.3. 功能模块 0211 3.4.4. 功能模块 0312 3.5. 构件 03.13 3.5.1. 功能模块列表.13 3.5.2. 功能模块 0113 3.5.3. 功能模块 0214 4. . 接口设计接口设计15 4.1. 外部接口 .16 4.1.1. 数据库接口.16 4.2. 内部接口 .16 4.2.1. 构件内部模块接口.16 4.2.2. 传输文件接口.16 4.3. 用户接口 .17 4.3.1. 键盘、鼠标输入接口.17 5. . 数据库设计数据库设计17 5.1. 数据库逻辑设计 .17 客户培训确认表 1 5.2. 数据库物理设计 .17 6. . 系统出错处理系统出错处理18 6.1. 出错信息 .18 6.2. 补救措施 .18 6.3. 系统维护设计 .19 客户培训确认表 2 1.1. 引言引言 .编写目的编写目的 本文档的编写是为了说明系统模块的划分、选择的技术路线等，整体 说明软件的实现思路，并且需要指出关键技术难点等。使系统开发人员能 够在了解了系统的设计需求之后能够对软件的基础结构和数据结构有一定 的认识，建立一定的开发框架、明确数据库的设计基准。 .背景背景概述概述 1) 待开发软件名称： 网页聊天系统 2) 软件背景： 21 世纪将是网络化、信息化的世纪，信息的融合已经成为社会发 展的主流方向。即时消息系统将不断与信息交流领域的系统相互集成和 渗透，扩展其自己的功能和应用范围，满足未来话音，数据和视频的多 媒体应用需要，使即时消息以更丰富的接入方法，更高的服务质量，更 友好的面貌呈现在世人的面前。 从功能角度来看，即时消息系统向支持全媒体方向发展，随着多媒 体技术在网络应用中的发展，即时消息系统承载的媒体，不再局限于原 来的文字、语音和文件的信息交换，信息载体扩展到图形、图像和流媒 体等多媒体业务上。目前 ICQ 和 QQ 预设了部分简单的表情图像， 通过 传输图像代码来传递表情图像，可以被视为即时消息开发商开发支持图 形、图像为载体的即时消息软件的开端。 从应用范围角度来看，即时消息系统集中在 Internet 个人用户之间 的信息交流应用，随着网络技术应用的发展，即时消息系统应用范围向 园区化、集团化拓展，应用领域突破个人，而用于远程教学、远程医疗、 远程演示、网络会议等领域。 3) 软件功能描述： 用户通过网页登陆账号，利用服务器转发实现一对一和一对多聊天。 用户成功登陆之后可以添加好友、删除好友、查找好友，能够查看好友 的登陆状态和好友资料以及聊天记录，并且可以选择是否保存用户的账 号，便于下一次登陆；新消息来到时会将消息会话自动置顶并且有红点 显示和声音提示，查看消息后红点消失，用户可以通过设置界面改变消 息的提醒方式；在聊天窗口可以向对方发送文字、图片和表情这些信息， 并且在每一条聊天记录之前会显示发送时间；用户可以申请新的账号、 可以创建多人聊天的群组，创建者默认为管理员，管理员管理所有申请 客户培训确认表 3 加入群组的请求，最后可以解散群组，所有成员自动退出。聊天室的特 点就是要求能够实时显示出聊天者所谈的内容。即在同一个聊天室的使 用者，可以在短时间内立刻看到其他聊天者的发言。作为用户喜欢的 Web 应用程序，除了具有能够实时显示出聊天者所谈论的内容外，还 应具有以多种方式发布信息的功能。JSP 正好可以满足聊天室的这种要 求，它可以快速地创建和显示 Web 页面的动态内容。总的来说，本聊 天室主要实现了以下的功能： 用户输入帐号,密码登录聊天室 可以创建群组，多人聊天 可以添加、删除好友 更改个人资料及系统设置 把用户的聊天信息写入数据库 多人共同聊天 语言过滤功能，避免一些敏感词汇 显示当前聊天客户列表 显示聊天室人员变动信息（进入聊天室、离开聊天室等） 聊天系统接收实时消息 退出下线 3) 软件应用描述：系统具有系统管理以及事务处理功能，能对用户的 聊天记录和输出进行有效管理；系统有一定的数据安全策略，能够有效的 管理用户数据以及用户的账号安全。在整个系统的框架下，结合网页与服 务器端的实际情况，实现对用户数据进行实时更新、查询、统计以及分析； 软件提供用户友好的接口，满足用户日常使用需求。 .术语术语 术语、缩略语术语、缩略语解解 释释 MVC 模式视图控制器模式 迭代器一种方法顺序访问一个聚合堆箱的各个元素 桩模块软件测试技术的一种，主要用在单元测试阶段 Session Session 是服务器端实用的一种记录客户端状态的机制 URL 统一资源定位符 HTTP 超文本传输协议 TCP/IP 传输控制协议/网间协议 UDP 数据包协议 客户培训确认表 4 表 1-3 术语和缩略语 .参考资料参考资料 1王红梅,胡明,王涛.数据结构.清华大学出版社,2005.7 2Y.Daniel Liang.Java 语言程序设计.机械工业出版社,2009.11 3张海藩.软件工程导论(第五版).清华大学出版社,2008.2 4王珊,萨师煊.数据库系统概论(第四版).高等教育出版社,2006.5 5弗里曼.OReilly：Head First 设计模式(中文版).中国电力出版社, 2.2. 总体设计总体设计 .系统功能结构系统功能结构 网页聊天系统 登陆注册 好 友 聊 天 好友列表 查 看 好 友 资 料 发 起 聊 天 传 输 文 件 系统设置 添 加 好 友 好 友 聊 天 共 享 文 件 查 看 群 资 料 发 起 群 聊 天 群组列表 群 组 聊 天 退 出 群 组 创 建 群 组 图 2-1 系统运行流程图 .运行环境运行环境 .2.1. 硬件环境硬件环境 1）本软件运行对服务器、客户端的硬件要求： 服务器：软件运行需要 Tomcat 服务器的支持。 运行环境：各种主流浏览器例如火狐、谷歌、IE 浏览器等。 客户终端：最低要求 2G 内存的电脑、处理器 1Ghz 以上、 能够运行主流浏览器的操作系统例如：Windows、Mac os、Linux。 2）本软件运行所使用的外围设备，主要包括： 使用者需要用鼠标、键盘等输入设备操作软件，已到达相关的使用 客户培训确认表 5 目的和便利性。 .2.2. 软件环境软件环境 1) 操作系统 Windows、Mac os、Linux 2) 数据库系统 Oracle 数据库 2) 开发平台及工具 Myeclipse、Java jdk1.6、tomcat 服务器、windows 10 操作系统 4) 通信协议 Tcp/Ip 协议 5) 接口 本软件应用 windows Api 实现对数据库的操作，基于 ODBC 数据库 访问技术 6) 其他软件 网页编辑器：dreamweaver cs6 测试浏览器：IE 内核的 QQ 浏览器 .系统的关键技术系统的关键技术 1）html/css 网页的界面设计 2）jQuery/Ajax/javascript 网页的交互设计 2）Servlet/Jsp 服务器的部署，web 程序的执行 3.3. 构件设计构件设计 .构件列表构件列表 序号序号构件分类构件分类构件名称构件名称依赖关系说明依赖关系说明 01 被封装的功能模块系统用户入口与 02 构件形成约束依赖关系 02 被封装的功能模块点对点聊天与 01 构件形成约束依赖关系 与 03 构件形成共享依赖关系 03 被封装的功能模块多人聊天与 01 构件形成约束依赖关系， 与 02 构件形成共享依赖关系 表 3-1 构件列表 .构件集成说明构件集成说明 1）集成顺序： 客户培训确认表 6 01 系统用户入口构件先被集成，04 系统自定义设置在 01 之后被集 成，03、04 聊天构件在最后被集成 2）集成的策略： 采用自底向上的集成策略。划分各个模块的优先秩序，确定模块间 的依赖关系，由各个功能模块组成系统的四大构件，联合构件组成一个 完整的系统，最后进行测试与维护。 3）集成就绪准则： 根据划分的软件构件之间的关系，以及构件内部的模块依赖关系， 确定数据流，划分类别和优先级。 4）集成结束准则： 进行集成测试，看各个功能模块是否正常工作符合软件的功能需求， 系统数据流向是否正确，是否村子数据泄露和符合安全性需求。 .构件构件 0101 系统用户入口构件，类别为：被封装的软件功能模块，构件包括：用户登 录模块、用户注册模块。 .3.1. 功能模块列表功能模块列表 构件构件 名称名称 模块模块 编号编号 模块模块 名称名称 对应需求对应需求 功能编号功能编号 所对应所对应 需求功能需求功能 实现实现 优先级优先级 XTYHRK_YHDL_01 用户登录 01 登录高系统用户 入口 XTYHRK_YHZC_02 用户注册 02 注册高 表 3-3-1 模块列表 .3.2. 功能模块功能模块 0101 【模块编号】 XTYHRK_YHDL_01 【功能描述】 用户登录模块用于指定页面为用户提供进入系统的 account 和 password 输入接口，是系统运作的高优先级模块，由系统模块间的约束依赖决定。当用 户按规则输入以后，模块会接入数据库验证账号和密码，并且提供一定的安全 保证策略，包括：登录验证码、防止用户直接输入地址访问相应页面、对登录 密码进行 cookie 存储加密。只有在用户登录之后才能进行进一步的操作。 【前置条件】 数据库中已经存在用户账号数据，否则需要用户手动调用用户注册模块进 行相关数据的录入和存储。 客户培训确认表 7 【操作者】 已经注册用户。 【界面】 图 3-3-2 登录界面 【输入】 1）账号，数据类型：字符型，作用：用户 ID，格式：1-10 位的数字或字 母组合。 2）密码，数据类型：字符型，作用：用户密码，格式：1-10 位的数字或字 母组合。 3）验证码，数据类型：字符型，作用：验证登录，格式：1-10 位的数字或 字母组合。 【处理流程及说明】 流程图： 开始 验证用户名密码是否正确 点击登陆 结束 是 否 输入用户名和 密码 登陆成功 客户培训确认表 8 图 3-3-2 登录流程 【输出】 1）账号，正常输出数据类型：字符型，异常输出：null，格式：1-10 位 的数字或字母组合如 rzet317。 2）密码：正常输出数据类型：字符型，异常输出：null，格式：1-10 位 的数字或字母组合如 RZet317。 3）验证码：正常的输出数据类型：字符型，异常输出：null，格式 4 位的 字母和数字组合如 RZET317。 .3.3. 功能模块功能模块 2 2 【模块编号】 XTYHRK_YHZE_02 【功能描述】 用户注册模块用于为新用户建立账号数据存储，是系统运作的高优先级模 块，由系统模块间的约束依赖决定。当用户按规则输入注册信息以后，模块会 接入数据库验证账号是否已经存在，如果不存在则创建账号成功，并跳转到登 录界面，否则要求用户更改要注册的账号信息，并重新进行验证。 【前置条件】 数据库中已经不存在用户账号数据，否则不能创建注册信息。 【操作者】 未注册用户。 【界面】 图 3-3-3 注册界面 【输入】 客户培训确认表 9 1）账号，数据类型：字符型，作用：用户 ID，格式：1-10 位的数字或字 母组合。 2）密码，数据类型：字符型，作用：用户密码，格式：1-10 位的数字或 字母组合。 【处理流程及说明】 流程图： 开始 验证用户名密码是否正确 点击注册 结束 是 否 输入用户名和 密码 注册成功 图 3-3-3 注册流程 【输出】 1）账号，正常输出数据类型：字符型，异常输出：null，格式：1-10 位 的数字或字母组合如 rzet317。 2）密码：正常输出数据类型：字符型，异常输出：null，格式：1-10 位 的数字或字母组合如 RZet317。 .构件构件 0202 点对点聊天构件，类型为多个模块的封装，包括好友聊天模块、点对点传 输模块、添加好友模块。 .4.1. 功能模块列表功能模块列表 构件构件 名称名称 模块模块 编号编号 模块模块 名称名称 对应需求对应需求 功能编号功能编号 所对应所对应 需求功能需求功能 实现实现 优先级优先级 点对点聊天 DDDLT_HYLT_01 好友聊天 01 消息传送中 点对点聊天 DDDLT_DDDCS_02 点对点传输 02 文件传输低 客户培训确认表 10 点对点聊天 DDDLT_TJHY_03 添加好友 03 添加好友中 表 3-4-1 模块列表 .4.2. 功能模块功能模块 0101 【模块编号】 DDDLT_HYLT_01 【功能描述】 好友聊天模块可以向指定的好友发起聊天，是系统运作的中优先级模块， 优先级由系统模块间的约束依赖决定。当用户选择要单独聊天的好友之后，模 块会接入数据库，并与好友建立消息通道，同时通过数据库彼此可以查看对方 的资料。 【前置条件】 聊天双方已经建立好友关系，数据库中有资料记录。 【操作者】 已经登录用户。 【输入】 1）聊天信息，数据类型：字符型/jpeg 图片，作用：聊天沟通，格式：数 字或字母或是图片组合。 【处理流程及说明】 流程图： 客户培训确认表 11 开始 发起或接受好友聊天 发送或接收好友消息是否成功 结束 否 是 结束好友聊天 发送或接收好 友消息 发送、接收好 友消息失败 待发送或待接 收好友消息 图 3-4-2 好友聊天 【输出】 1）好友资料，数据类型：字符型/jpeg，作用：确定好友信息，格式：字 母和数字的组合。 2）消息回复，数据类型：字符型/jpeg，作用：好友消息，格式：字母， 数字，图片的组合。 .4.3. 功能模块功能模块 0202 【模块编号】 DDDLT_DDDCS_02 【功能描述】 点对点传输模块可以向指定的好友发送文件，是系统运作的低优先级模块， 优先级由系统模块间的约束依赖决定。当用户选择要发送文件的好友之后，模 块会与好友建立通信通道，对方接受后即可接收好友的文件。 【前置条件】 传送双方已经建立好友关系，数据库中有资料记录。 【操作者】 已经建立好友关系的用户。 【输入】 客户培训确认表 12 1）文件，数据类型：二进制字节流，作用：信息载体，格式：text/doc 等 【处理流程及说明】 开始 在好友聊天窗口中 点击传输文件 选择需要传 输的文件 确认传输 好友是否接受传输请求 传输完成 正在传输传输失败 结束 否是 图 3-4-3 好友传输文件 【输出】 1）文件，数据类型：二进制字节流，作用：信息载体，格式： text/pdf/doc 等类型文件。 .4.4. 功能模块功能模块 0303 【模块编号】 DDDLT_TJHY_03 【功能描述】 添加好友模块可以允许用户添加好友，当用户搜索要添加的好友之后，可 以查看资料并与其建立好友关系，同时数据库存入好友数据。 【前置条件】 双方均已经在系统中注册。 【操作者】 已经登录用户。 【输入】 1）好友账号，数据类型：字符型，作用：查找依据，格式：1-10 为的数 客户培训确认表 13 字或字母组合。 【处理流程及说明】 开始 输入用户信息 查找用户 是否成功 提示查找失败显示用户数据 添加好友 是否通过请求 结束 否 是 否 是 添加好友失败添加好友失败 图 3-4-3 好友传输文件流程 【输出】 1）好友资料，数据类型：字符型，作用：确定好友信息，格式：字母和数 字的组合。 .构件构件 0303 多人聊天构件，类型为多个模块的封装，包括群组聊天模块和创建群组模 块。 .5.1. 功能模块列表功能模块列表 构件构件 名称名称 模块模块 编号编号 模块模块 名称名称 对应需求对应需求 功能编号功能编号 所对应所对应 需求功能需求功能 实现实现 优先级优先级 多人聊天 DRLT_QZLT_01 群组聊天 01 消息传送中 多人聊天 DRLT_CJQZ_02 创建群组 02 群创建中 表 3-3-1 模块列表 客户培训确认表 14 .5.2. 功能模块功能模块 0101 【模块编号】 DDDLT_HYLT_01 【功能描述】 群组聊天模块可以在群聊天室中发起多人聊天，是系统运作的中优先级模 块，优先级由系统模块间的约束依赖决定。当用户进入群组轴，模块会接入数 据库，个人发送的消息会发布在群聊天界面，每个成员进入群组聊天界面后都 可以接受消息，同时通过数据库彼此可以查看群组的资料。 【前置条件】 向群组发起聊天的人必须先加入群组，数据库中有资料记录。 【操作者】 已经加入群组的用户。 【输入】 1）聊天信息，数据类型：字符型/jpeg 图片，作用：聊天沟通消息，格式： 数字或字母或是图片组合。 【处理流程及说明】 流程图： 开始 发起或接受群聊天 发送或接收群消息是否成功 结束 否 是 结束群聊天 发送或接收群 消息 发送、接收群 消息失败 待发送或待接 收群消息 客户培训确认表 15 图 3-5-2 群聊天流程 【输出】 1）群组消息，数据类型：字符型/jepg 图片，作用：聊天沟通信息，格式： 字母或数字或图片的组合。 .5.3. 功能模块功能模块 0202 【模块编号】 DRLT_CJQZ_02 【功能描述】 创建群组模块可以允许使用者创建群组，是系统运作的中优先级模块，优 先级由系统模块间的约束依赖决定。当用户输入群的基本信息，模块会接入数 据库，群组信息会被存入数据库，创建者默认为管理员，管理员可以邀请用户 加入群组。 【前置条件】 用户必须先登录。 【操作者】 已经登录的用户。 【输入】 1）群资料，数据类型：字符型，作用：描述群的信息，格式：数字或字母 的组合。 【处理流程及说明】 客户培训确认表 16 开始 输入群资料 核对资料格式 是否正确 群创建成功 添加群成员 是否通过请求 结束 否 是 否 是 添加群成员失败添加群成员成功 图 3-5-3 创建群组流程 【输出】 1）群资料，数据类型：字符型，作用：描述群的信息，格式：数字或字母 的组合。 2）创建者账户，数据类型：字符型，作用：添加群管理员信息，格式：数 字或子母的组合。 4.4. 接口设计接口设计 构件名称构件名称 接口编接口编 号号 接口名称接口名称接口类型接口类型说明说明 01 注册账号数据库接口外部注册账户时需要与数据库连接 02 登录账号数据库接口外部登录账户时需要与数据库连接 03 鼠标、键盘输入接口用户用户向系统输入控制信息 系统用户入口 04 构件内部模块间接口内部模块之间的连接 05 添加好友数据库接口外部添加好友时需要与数据库连接 点对点聊天 06 查看好友资料数据库接口外部查看好友时需要与数据库连接 客户培训确认表 17 07 传输文件接口内部传输文件时与好友建立连接 08 鼠标、键盘输入接口用户用户向系统输入控制信息 09 构件内部模块之间的接口内部模块之间的连接 10 创建群组数据库接口外部创建群组时需要与数据库连接 11 构件内部模块之间的接口内部模块之间的连接 12 群组资料数据库接口外部查看群资料时需要与数据库连接 多人聊天 13 鼠标、键盘输入接口用户用户向系统输入控制信息 表 4-1 构件接口列表 4.1.外部接口外部接口 .1.1. 数据库接口数据库接口 接口名称接口名称数据库接口 接口说明接口说明与数据库建立连接，向数据库读取或写入数据 数据来源数据来源内部模块 调用者调用者内部模块 输入输入数据库语句 输出输出数据库中表的数据项 调用方式说明调用方式说明执行数据库语句 表 4-2 数据库接口说明 4.2.内部接口内部接口 .2.1. 构件内部模块接口构件内部模块接口 接口名称接口名称构件内部模块接口 接口说明接口说明模块之间的衔接 数据来源数据来源各个内部模块 调用者调用者各个内部模块 输入输入连接时传输的参数 输出输出连接时传输的参数 处理流程处理流程用户执行功能模块，模块之间通过接口协同工作 表 4-2-1 构件内部模块接口说明 .2.2. 传输文件接口传输文件接口 接口名称接口名称传输文件接口 接口说明接口说明用与用户之间文件的传输 数据来源数据来源用户的本地磁盘 调用者调用者用户 输入输入文件 输出输出文件 处理流程处理流程用户通过接口建立数据传输通道传输文件 客户培训确认表 18 表 4-2-2 传输文件接口说明 4.3.用户接口用户接口 .3.1. 键盘、鼠标输入接口键盘、鼠标输入接口 接口名称接口名称键盘、鼠标输入接口 接口说明接口说明用户向系统传递控制信息 数据来源数据来源键盘、鼠标 调用者调用者用户 输入输入键盘、鼠标的控制信号 输出输出字符和控制信息 处理流程处理流程用户通过键盘、鼠标向系统输入数据和控制信息来调用系统功能模块 表 4-3-1 键盘、鼠标输入接口说明 5.5. 数据库设计数据库设计 5.1.数据库逻辑设计数据库逻辑设计 用户1用户2 用户群 消息 群消息 好友MN 属于 M N 发送1 N 收发N1 账号用户昵称 账号 用户信息在线状态 密码 好友账号 编号发送人账号 接收人账号内容 发送时间 群账号 群用户账号 创建时间 群信息创建人账号 群账号 群名称 群账号发送人账号 发送时间内容 已接收群消息 群成员账号 表 5-1 数据库实体关系 ER 图 5.2.数据库物理设计数据库物理设计 序号属性含义类型长度 1Account 账号 Varchar10 2Password 密码 Varchar10 3Name 用户昵称 Varchar10 4Information 用户信息 Varchar50 5Status 在线状态 Int2 表 5-2-1 用户信息表 客户培训确认表 19 序号属性含义类型长度 1Account 账号 varchar10 2User-friend 好友账号 Varchar10 表 5-2-2 好友关系表 序号属性含义类型长度 1Group-number 群账号 Int 2Group-admin 创建人账号 Varchar10 3Group-name 群名称 Varchar10 4Group-Information 群信息 Varchar50 表 5-2-3 群组表 序号属性含义类型长度 1Group-account 群成员账号 Varchar10 2Group-number 群账号 Int 表 5-2-4 群成员表 6.6. 系统出错处理系统出错处理 6.1.出错信息出错信息 错误分类错误分类子项及其编码子项及其编码错误名称错误名称错误代码错误代码备注备注 连接超时 100001001 数据库连接出错 连接断开 100001002 数据库错 误数据库本身错误代 码 数据库本身错误 代码 100002+数据库错误 代码 连接超时 101001001 TCP 连接出错 连接断开 101001002 TCP 连接错 误socket 自身错误代 码 Socket 自身错误 101002+ socket 错误 代码 表 6-1 可能故障一览表 6.2.补救措施补救措施 1）后备技术 数据库错误：以一个月为周期为数据库文件建立本地文件副本。 TCP 连接错误：重新建立 TCP 连接。 2）降效技术 数据库错误：手动记录数据库中的数据，以备数据的恢复。 TCP 来连接错误：本地文件保存 TCP 连接错误时的状态。 3）恢复及再启动技术 数据库错误：软件终止运行，本地保存未存入数据库的数据，开启线程等 待数据库连接后重新启动系统或是由用户直接结束软件运行。 客户培训确认表 20 TCP 来连接错误：软件终止运行，开启线程等待 TCP 的连接，待 TCP 连接建 立好后软件从故障处继续运行或是由用户直接结束软件运行。 6.3.系统维护设计系统维护设计 为了最后能维护项目，设置了专门对系统运行强度进行测试的单独模块， 只需要系统的单个模块接口，就能自动生成数据进行压力测试；设置了对数据 库操作的模块，随着用户量的增加，周期性对数据库的运行效率进行统计，画 出折线图，分析效率的变化情况，方便后期进行数据库结构的优化。 客户培训确认表 14 大学本科生毕业设计（论文）撰写规范 本科生毕业设计（论文）是学生在毕业前提交的一份具有一定研究价值和实用 价值的学术资料。它既是本科学生开始从事工程设计、科学实验和科学研究的初步 尝试，也是学生在教师的指导下，对所进行研究的适当表述，还是学生毕业及学位 资格认定的重要依据。毕业论文撰写是本科生培养过程中的基本训练环节之一，应 符合国家及各专业部门制定的有关标准，符合汉语语法规范。指导教师应加强指导， 严格把关。 1、论文结构及要求 论文包括题目、中文摘要、外文摘要、目录、正文、参考文献、致谢和附录等 几部分。 1.1 题目 论文题目应恰当、准确地反映论文的主要研究内容。不应超过 25 字，原则上 不得使用标点符号，不设副标题。 1.2 摘要与关键词 1.2.1 摘要 本科生毕业设计（论文）的摘要均要求用中、英两种文字给出，中文在前。 摘要应扼要叙述论文的研究目的、研究方法、研究内容和主要结果或结论，文 字要精炼，具有一定的独立性和完整性，摘要一般应在 300 字左右。摘要中不宜使 用公式、图表，不标注引用文献编号，避免将摘要写成目录式的内容介绍。 1.2.2 关键词 关键词是供检索用的主题词条，应采用能覆盖论文主要内容的通用技术词条 （参照相应的技术术语标准），一般列 35 个，按词条的外延层次从大到小排列， 应在摘要中出现。 1.3 目录 目录应独立成页，包括论文中全部章、节的标题及页码。 客户培训确认表 15 1.4 论文正文 论文正文包括绪论、论文主体及结论等部分。 1.4.1 绪论 绪论一般作为论文的首篇。绪论应说明选题的背景、目的和意义，国内外文献 综述以及论文所要研究的主要内容。 文管类论文的绪论是毕业论文的开头部分，一般包括说明论文写作的目的与意 义，对所研究问题的认识以及提出问题。绪论只是文章的开头，不必写章号。 毕业设计（论文）绪论部分字数不多于全部论文字数的 1/4。 1.4.2 论文主体 论文主体是论文的主要部分，要求结构合理，层次清楚，重点突出，文字简练、通顺。 论文主体的内容要求参照大学本科生毕业设计（论文）的规定第五章。 论文主体各章后应有一节“本章小结”。 1.4.3 结论 结论作为单独一章排列，但不加章号。 结论是对整个论文主要成果的归纳，要突出设计（论文）的创新点，以简练的 文字对论文的主要工作进行评价，一般为 4001 000 字。 1.5 参考文献 参考文献是论文不可缺少的组成部分，它反映了论文的取材来源和广博程度。 论文中要注重引用近期发表的与论文工作直接有关的学术期刊类文献。对理工类论 文，参考文献数量一般应在 15 篇以上，其中学术期刊类文献不少于 8 篇，外文文 献不少于 3 篇；对文科类、管理类论文，参考文献数量一般为 1020 篇，其中学 术期刊类文献不少于 8 篇，外文文献不少于 3 篇。 在论文正文中必须有参考文献的编号，参考文献的序号应按在正文中 出现的顺序排列。 产品说明书、各类标准、各种报纸上刊登的文章及未公开发表的研究报告（著 名的内部报告如 PB、AD 报告及著名大公司的企业技术报告等除外）不宜做为参考 文献引用。但对于工程设计类论文，各种标准、规范和手册可作为参考文献。 引用网上参考文献时，应注明该文献的准确网页地址，网上参考文献不包含在 上述规定的文献数量之内。 客户培训确认表 16 1.6 致谢 对导师和给予指导或协助完成论文工作的组织和个人表示感谢。内容应简洁明 了、实事求是，避免俗套。 1.7 附录 如开题报告、文献综述、外文译文及外文文献复印件、公式的推导、程序流程图、图 纸、数据表格等有些不宜放在正文中，但有参考价值的内容可编入论文的附录中。 2、论文书写规定 2.1 论文正文字数 理工类 论文正文字数不少于 20 000 字。 文管类 论文正文字数 12 00020 000 字。其中汉语言文学专业不少于 7 000 字。 外语类 论文正文字数 8 00010 000 个外文单词。 艺术类 论文正文字数 3 0005 000 字。 2.2 论文书写 本科生毕业论文用 B5 纸计算机排版、编辑与双面打印输出。 论文版面设置为：毕业论文 B5 纸、纵向、为横排、不分栏，上下页边距 分别为 2.5cm 和 2cm，左右页边距分别为 2.4cm 和 2cm，对称页边距、左侧装 订并装订线为 0cm、奇偶页不同、无网格。论文正文满页为 29 行，每行 33 个 字，字号为小四号宋体，每页版面字数为 957 个，行间距为固定值 20 磅。 页眉。页眉应居中置于页面上部。单数页眉的文字为“章及标题”；双数页眉的文字 为“大学本科生毕业设计（论文）”。页眉的文字用五号宋体，页眉文字下面为 2 条横线 （两条横线的长度与版芯尺寸相同，线粗 0.5 磅）。页眉、页脚边距分别为 1.8cm 和 1.7cm。 页码。页码用小五号字，居中标于页面底部。摘要、目录等文前部分的页码用罗马数 字单独编排，正文以后的页码用阿拉伯数字编排。 2.3 摘要 中文摘要一般为 300 字左右，外文摘要应与中文摘要内容相同，在语法、用词和书写 上应正确无误，摘要页勿需写出论文题目。中、外文摘要应各占一页，编排装订时放置正 文前，并且中文在前，外文在后。 2.4 目录 目录应包括论文中全部章节的标题及页码，含中、外文摘要；正文章、节题目； 参考文献；致谢；附录。 正文章、节题目（理工类要求编写到第 3 级标题，即.。文科、管理类可视论 文需要进行，编写到 23 级标题。） 2.5 论文正文 2.5.1 章节及各章标题 论文正文分章、节撰写，每章应另起一页。 各章标题要突出重点、简明扼要。字数一般在 15 字以内，不得使用标点符号。标题中 尽量不用英文缩写词，对必须采用者，应使用本行业的通用缩写词。 概要设计说明书 第 1 页 共 48 页 2.5.2 层次 层次以少为宜，根据实际需要选择。层次代号格式见表 1 和表 2。 表 1 理工类论文层次代号及说明 层次名称示 例说 明 章第 1 章 章序及章名居中排，章 序用阿拉伯数字 节1.1 条 1.1.1 题序顶格书写，与标 题间空 1 字，下面阐 述内容另起一段 款 题序顶格书写，与标题 间空 1 字，下面阐述内 容在标题后空 1 字接排 项 (1) 题序空2 字书写，以下 内容接排，有标题者， 阐述内容在标题后空1 字 版心左边线 版心右边线 表 2 文管类论文层次代号及说明 章 节 条 款 项 一、 （一） 1. （1） 居中书写 空 2 字书写 空 2 字书写 空 2 字书写 空 2 字书写 版心左边线 版心右边线 各层次题序及标题不得置于页面的最后一行（孤行）。 2.6 参考文献 正文中引用文献标示应置于所引内容最末句的右上角，用小五号字体。所引文献编号 用阿拉伯数字置于方括号“ ”中，如“二次铣削1”。当提及的参考文献为文中直接说 明时，其序号应该与正文排齐，如“由文献8，1014可知”。 经济、管理类论文引用文献，若引用的是原话，要加引号，一般写在段中；若引的不 是原文只是原意，文前只需用冒号或逗号，而不用引号。在参考文献之外，若有注释的话， 建议采用夹注，即紧接文句，用圆括号标明。 不得将引用文献标示置于各级标题处。 概要设计说明书 第 2 页 共 48 页 参考文献书写格式应符合 GB77141987文后参考文献著录规则。常用参考文献编 写项目和顺序应按文中引用先后次序规定如下： 著作图书文献 序号作者书名（版次）出版地：出版者，出版年:引用部分起止页 第一版应省略 翻译图书文献 序号作者书名（版次）译者出版地: 出版者，出版年:引用部分起止页 第一版应省略 学术刊物文献 序号作者文章名学术刊物名年，卷（期）：引用部分起止页 学术会议文献 序号作者文章名编者名会议名称，会议地址，年份出版地，出版者， 出版年:引用部分起止页 学位论文类参考文献 序号研究生名学位论文题目出版地学校（或研究单位）及学位论文级别答 辩年份:引用部分起止页 西文文献中第一个词和每个实词的第一个字母大写，余者小写；俄文文献名第一个词 和专有名词的第一个字母大写，余者小写；日文文献中的汉字须用日文汉字，不得用中文 汉字、简化汉字代替。文献中的外文字母一律用正体。 作者为多人时，一般只列出前 3 名作者，不同作者姓名间用逗号相隔。外文姓名按国 际惯例，将作者名的缩写置前，作者姓置后。 学术会议若出版论文集者，可在会议名称后加上“论文集”字样。未出版论文集者省 去“出版者”、“出版年”两项。会议地址与出版地相同者省略“出版地”。会议年份与 出版年相同者省略“出版年”。 学术刊物文献无卷号的可略去此项，直接写“年，（期）”。 参考文献序号顶格书写，不加括号与标点，其后空一格写作者名。序号应按文献 在论文中的被引用顺序编排。换行时与作者名第一个字对齐。若同一文献中有多处被引用， 则要写出相应引用页码，各起止页码间空一格，排列按引用顺序，不按页码顺序。 参考文献书写格式示例见附录 1。 2.7 名词术语 科技名词术语及设备、元件的名称，应采用国家标准或部颁标准中规定的术语或名称。 标准中未规定的术语要采用行业通用术语或名称。全文名词术语必须统一。一些特殊名词 或新名词应在适当位置加以说明或注解。 文管类专业技术术语应为常见、常用的名词。 采用英语缩写词时，除本行业广泛应用的通用缩写词外，文中第一次出现的缩写词应 该用括号注明英文全文。 2.8 计量单位 概要设计说明书 第 3 页 共 48 页 物理量计量单位及符号一律采用中华人民共和国法定计量单位（GB31003102 1993，见附录 2），不得使用非法定计量单位及符号。计量单位符号，除用人名命名的单 位第一个字母用大写之外，一律用小写字母。 非物理单位（如件、台、人、元、次等）可以采用汉字与单位符号混写的方式，如 “万 tkm”，“t/（人a）”等。 文稿叙述中不定数字之后允许用中文计量单位符号，如“几千克至 1 000kg”。 表达时刻时应采用中文计量单位，如“上午 8 点 45 分”，不能写成“8h45min”。 计量单位符号一律用正体。 2.9 外文字母的正、斜体用法 按照 GB310031021986 及 GB71591987 的规定使用，即物理量符号、物理常量、 变量符号用斜体，计量单位等符号均用正体。 2.10 数字 按国家语言文字工作委员会等七单位 1987 年发布的关于出版物上数字用法的规定， 除习惯用中文数字表示的以外，一般均采用阿拉伯数字（参照附录 3）。 2.11 公式 原则上居中书写。若公式前有文字（如“解”、“假定”等），文字顶格书写，公式 仍居中写。公式末不加标点。 公式序号按章编排，如第 1 章第一个公式序号为“（1-1）”，附录 2 中的第一个公式 为（-1）等。 文中引用公式时，一般用“见式（1-1）”或“由公式（1-1）”。 公式中用斜线表示“除”的关系时，若分母部分为乘积应采用括号，以免含糊不清， 如a/(bcosx)。通常“乘”的关系在前，如acosx/b而不写（a/b）cosx。 2.12 插表 表格不加左、右边线。 表序一般按章编排，如第 1 章第一个插表的序号为“表 11”等。表序与表名之间空 一格，表名中不允许使用标点符号，表名后不加标点。表序与表名置于表上，居中排写 （见附录 4）。 表头设计应简单明了，尽量不用斜线。表头中可采用化学符号或物理量符号。 全表如用同一单位，将单位符号移到表头右上角，加圆括号（见附录 4 中的例 2）。 表中数据应正确无误，书写清楚。数字空缺的格内加“”字线（占 2 个数字宽度）。 表内文字和数字上、下或左、右相同时，不允许用“”、“同上”之类的写法，可采用 通栏处理方式（见附录 4 中的例 2）。 表内文字说明不加标点。 文管类的插表在表下一般根据需要可增列补充材料、注解、附记、资料来源、某些指 标的计算方法等。 概要设计说明书 第 4 页 共 48 页 表内文字说明，起行空一格，转行顶格，句末不加标点。表题用五号字，表内文字及 表的说明文字均用五号字，中文用宋体。 表格容量较大，必要时表格也可分为两段或多段（这只能发生在转页时），转页分段 后的每一续表的表头都应重新排字，重排表头的续表上方右侧应注明（续表）字样。 2.13 插图 插图应与文字紧密配合，文图相符，技术内容正确。 2.13.1 制图标准 插图应符合技术制图及相应专业制图的规定。 机械工程图：采用第一角投影法，应符合附录 5 所列有关标准的规定。 电气图：图形符号、文字符号等应符合附录 6 所列有关标准的规定。 流程图：符合国家标准。 对无规定符号的图形应采用该行业的常用画法。 2.13.2 图题及图中说明 每个图均应有图题（由图号和图名组成）。图号按章编排，如第 1 章第一图的图号为 “图 1-1”等。图题置于图下。有图注或其他说明时应置于图题之上。图名在图号之后空 一格排写。引用图应说明出处，在图题右上角加引用文献编号。图中若有分图时，分图号 用 a)、b)等置于分图之下。 图中各部分说明应采用中文（引用的外文图除外）或数字项号，各项文字说明置于图 题之上（有分图题者，置于分图题之上）。 图题用五号字，图内文字及说明均用五号字，中文用宋体。 2.13.3 插图编排 插图与其图题为一个整体，不得拆开排写于两页。插图应编排在正文提及之后，插图 处的该页空白不够排写该图整体时，则可将其后文字部分提前排写，将图移到次页最前面。 2.13.4 坐标单位 有数字标注的坐标图，除无单位者（如标示值）之外，必须注明坐标单位。 2.13.5 论文中照片图及插图 毕业论文中的照片图均应是原版照片粘贴（或数码像机图片），照片可为黑白或彩色， 应主题突出、层次分明、清晰整洁、反差适中。照片采用光面相纸，不宜用布纹相纸。对 金相显微组织照片必须注明放大倍数。 毕业论文中的插图不得采用复印件。对于复杂的引用图，可采用数字化仪表输入计算 机打印出来的图稿。 2.14 附录 概要设计说明书 第 5 页 共 48 页 理工类论文附录的序号采用“附录 1”、“附录 2”等，附录顺序为开题报告、文献综 述、外文文献的中文译文及外文复印件等。 文管类论文附录序号相应采用“附录一”、“附录二”等。 3、论文排版要求 3.1 纸张要求及页面设置 名称格式要求 纸张B5（182257），幅面白色 页面 设置 上下页边距 2.5cm 和 2cm，左右页边距 2.4 cm 和 2cm，页眉、页脚分别为 1.8cm 和 1.7cm，对称页边距、左侧装订并装订线为 0cm、奇偶页不同、无网格 页眉宋体字五号居中 页码宋体字小五号居中 3.2 封面(详见模版、B5 纸单面打印) 名称格式要求 本科毕业设计 /论文宋体字小二号，行距固定值 25磅 ，间距段前、段后分别为 0.5行，要求字体居中 论文题目 黑体字二号,行距固定值 25 磅,间距段前、段后分别为 0.5 行。论文题目中 文字数不得超过 25 字,要求字体居中 填写姓名宋体字小三号 , 行距固定值20磅 , 间距段前、段后分别为 0.5行,要求字体居中 大学 楷体字小二号，行距固定值 20 磅, 间距段前、段后分别为 0.5 行。每字间 空 1 格,要求字体居中 年 月 宋体字小三号，行距固定值 20 磅, 间距段前、段后分别为 0.5 行。数字用 阿拉伯数字，日期为论文提交日期,要求字体居中 3.3 封面 2(详见模版、B5 纸单面打印) 名称格式要求 本科毕业设计/论文 宋体字小二号，行距固定值 25 磅,间距段前、段后分别为 0.5 行，要求 字体居中 论文题目 黑体字二号，行距固定值 25 磅,间距段前、段后分别为 0.5 行。论文题 目中文字数不得超过 25 字，要求字体居中 学院（系）宋体字四号，行距固定值20磅,间距段前、段后分别为0.5 行，字体左对齐 专业同上 学生姓名同上 学号同上 指导教师同上 答辩日期同上 3.4 本科毕业设计/论文 任务书(单面打印) 本科毕业设计/论文B5 纸，单面打印，不编页码 概要设计说明书 第 6 页 共 48 页 3.5 中、英文摘要 名称中文摘要英文摘要 标题 摘要：黑体字小二居中，行距固定值 20 磅，间距段前、段后分别为 1 行 Abstract： Times New Roman 体小二号居中， 行距固定值 20 磅，间距段前、段后分别为 1 行 段落 文字 宋体字小四号，行距固定值 20 磅Times New Roman体小四号，行距固定值 20磅 关键词同上，“关键词”三字加粗同上，“Key Words”