软件工程课程实验指导教材

软件工程课程实验指导教材前言本实验指导教材旨在配合软件工程课程的教学，引导学生将理论知识应用于实践，通过亲身体验软件项目开发的完整流程，加深对软件工程基本原理、方法和工具的理解与掌握。本教材强调规范性、实践性和团队协作，力求使学生在实验过程中不仅能够掌握具体的开发技能，更能培养工程化的思维方式和解决实际问题的能力。本指导适用于计算机科学、软件工程及相关专业的本科生或研究生。学生应具备一定的程序设计基础，并对软件开发有初步的认识。在进行实验前，建议学生复习课程中关于软件生命周期、需求分析、设计方法、编码规范、测试策略等相关章节的内容。实验过程中，应严格遵守操作规程，注意数据安全与备份。鼓励学生积极思考、勇于探索、大胆创新，并在团队中充分交流与协作。第一章实验概述与基本要求1.1实验目的1.理解并实践软件工程的基本流程和方法，包括项目策划、需求分析、软件设计、编码实现、测试验证及项目总结等阶段。2.掌握软件开发过程中常用工具的使用，如版本控制工具、项目管理工具、建模工具、测试工具等。3.培养规范化、工程化的软件开发习惯，提升文档撰写能力。4.体验团队协作开发模式，理解角色分工与沟通协调的重要性。5.培养发现问题、分析问题和解决问题的能力。1.2实验要求1.前置知识：学生应已掌握至少一门编程语言（如Java、Python、C#等），了解数据库基本概念，具备一定的面向对象编程思想。2.实验态度：认真对待每一个实验环节，严格按照实验步骤操作，独立思考，积极讨论。3.时间管理：合理安排实验时间，确保按时完成各阶段任务。4.文档规范：所有实验成果（包括需求文档、设计文档、代码、测试报告等）均需按照指定模板或行业规范撰写，力求内容完整、逻辑清晰、格式规范。5.团队协作：若为团队实验，需明确分工，各司其职，同时加强沟通，共同推进项目进展。6.成果提交：按时提交实验报告及相关成果物，并确保其真实性和原创性。1.3安全规范1.遵守实验室规章制度，爱护实验设备。3.重要实验数据应及时备份，防止丢失。4.合理使用网络资源，不进行未经授权的访问或操作。第二章实验准备与环境配置2.1实验团队组建与角色分配软件工程是一项团队活动。在开始实验项目前，学生需组成项目团队，建议每组3-5人。团队成立后，应进行明确的角色分工，典型的角色包括：*项目经理（PM）：负责项目整体规划、进度控制、资源协调、风险管理及团队沟通。*需求分析师：负责与用户（或模拟用户）沟通，获取和分析需求，编写需求规格说明书。*系统设计师：负责软件系统的架构设计、数据库设计、模块设计等。*开发工程师：根据设计文档进行代码实现。*测试工程师：负责制定测试计划，设计测试用例，执行测试，提交缺陷报告并跟踪。*注意：角色分工是为了明确责任，实际开发中团队成员应相互协作，必要时可交叉参与工作。*2.2版本控制工具的安装与使用版本控制是团队协作开发的基础，本实验推荐使用Git作为版本控制工具。2.2.1Git安装2.2.2基本Git操作*初始化仓库：`gitinit`*克隆仓库：`gitclone[仓库URL]`*查看状态：`gitstatus`*添加文件：`gitadd[文件名]`或`gitadd.`(添加所有修改)*拉取更新：`gitpull`*推送更新：`gitpush`*创建分支：`gitbranch[分支名]`*切换分支：`gitcheckout[分支名]`或`gitswitch[分支名]`(较新版本Git)*合并分支：`gitmerge[分支名]`*详细操作及团队协作流程参见实验指导教师讲解或相关教程。*2.3开发环境搭建根据选定的实验项目和技术栈，搭建相应的开发环境。以下为常见环境的搭建指引：2.3.1Java开发环境（以IntelliJIDEA为例）2.配置环境变量：设置`JAVA_HOME`指向JDK安装目录，并将其`bin`目录添加到`PATH`。4.首次启动时，配置JDK路径。2.3.2Python开发环境（以PyCharm为例）3.配置Python解释器：在PyCharm中创建项目时指定已安装的Python解释器。2.3.3数据库环境（以MySQL为例）2.安装完成后，启动MySQL服务。3.使用命令行客户端或图形化工具（如Navicat、DBeaver）连接数据库，进行创建数据库、表等操作。*注：具体的开发语言、IDE和数据库选择，由实验项目需求和团队技术偏好决定，以上仅为示例。*第三章实验项目案例与核心实验单元本教材以一个“小型图书管理系统”的开发为例，引导学生完成软件工程各核心阶段的实践。各实验单元可根据课程进度和学时安排灵活调整。实验一：需求分析实践1.1实验目标1.掌握需求获取的基本方法。2.学会编写用户故事或用例规约。3.能够撰写简明的需求规格说明书。1.2实验任务1.针对“小型图书管理系统”，通过与“用户”（可由教师或同学扮演）访谈、问卷调查或场景分析等方式，获取系统功能性需求和非功能性需求。2.对获取的需求进行整理和分析，识别用户角色（如管理员、普通用户）。3.为每个主要功能编写用户故事或用例规约。*用户故事模板：作为一个<角色>，我希望<功能>，以便于<价值>。*用例规约应包含：用例名称、参与者、前置条件、后置条件、基本流程、扩展流程等。4.绘制系统用例图。5.编写“小型图书管理系统需求规格说明书（草案）”。1.3实验原理与方法*需求获取方法：访谈法、问卷法、观察法、原型法、头脑风暴法等。*需求分析技术：结构化分析（数据流图、数据字典）、面向对象分析（用例图、类图）等。*需求文档：需求规格说明书是描述系统需求的正式文档，应清晰、准确、完整、一致、可验证。1.4实验步骤与内容1.准备阶段：小组讨论，制定需求获取计划，设计访谈提纲或问卷。2.需求获取阶段：执行访谈或发放问卷，记录原始需求信息。3.需求分析与建模阶段：*整理需求，去重、分类。*识别参与者和主要功能。*编写用户故事或用例规约。*使用建模工具（如StarUML、Draw.io、Visio）绘制用例图。4.文档编写阶段：根据模板撰写需求规格说明书。5.需求评审：小组内部进行需求评审，邀请其他小组或教师进行评审，根据评审意见修改完善。1.5实验成果与提交要求1.需求获取记录（访谈纪要、问卷及回收结果等）。2.用户故事列表或用例规约文档。3.系统用例图（电子版）。4.《小型图书管理系统需求规格说明书（草案）》。5.实验报告（含实验目的、任务、过程、遇到的问题及解决方法、心得体会等）。实验二：软件设计实践2.1实验目标1.掌握概要设计和详细设计的基本方法。2.学会使用流程图、类图、时序图等设计工具。3.能够根据需求规格说明书进行软件架构和模块设计。2.2实验任务1.基于“小型图书管理系统”的需求规格说明书，进行概要设计。*确定系统的整体架构（如分层架构：表现层、业务逻辑层、数据访问层）。*划分系统功能模块（如用户管理模块、图书信息管理模块、借阅归还模块、查询统计模块等）。*定义各模块间的接口。2.选取核心模块（如图书借阅归还模块）进行详细设计。*设计模块内部的数据结构和算法。*设计类的属性和方法，绘制类图。*绘制关键业务流程的流程图或时序图。3.进行数据库设计，绘制ER图，设计主要数据表结构（字段名、数据类型、约束等）。4.编写“小型图书管理系统设计说明书”。2.3实验原理与方法*概要设计：又称架构设计，关注系统的整体结构、模块划分、模块间接口和交互。常用方法有：模块化设计、层次化设计、面向对象设计。*详细设计：关注每个模块内部的具体实现，包括数据结构、算法、类的设计、接口的详细定义等。*设计原则：高内聚低耦合、单一职责、开闭原则等。*设计模式：在特定场景下解决常见设计问题的最佳实践（如单例模式、工厂模式等，可选学）。*数据库设计：遵循数据库设计范式，进行概念结构设计（ER图）、逻辑结构设计和物理结构设计。2.4实验步骤与内容1.概要设计阶段：*分析需求，确定系统架构风格。*进行模块划分，明确各模块的功能和职责。*定义模块间的接口和交互方式。*绘制系统架构图和模块图。2.详细设计阶段：*针对每个模块，设计其内部的数据结构和算法。*对面向对象系统，识别类、属性和方法，定义类之间的关系（继承、关联、聚合、组合），绘制类图。*针对关键业务流程（如图书借阅流程），绘制流程图或时序图。3.数据库设计阶段：*识别实体和实体间关系，绘制ER图。*将ER图转换为关系模式，设计数据表结构，包括字段名、数据类型、长度、主键、外键、约束等。*考虑数据完整性、一致性和性能。4.编写设计文档：根据模板撰写《小型图书管理系统设计说明书》。5.设计评审：组织设计评审会议，邀请教师和其他同学对设计方案进行评议，根据反馈进行修改。2.5实验成果与提交要求1.系统架构图、模块划分图。2.核心模块的类图、流程图或时序图。3.数据库ER图及数据表结构设计表。4.《小型图书管理系统设计说明书》。5.实验报告。实验三：编码与版本控制实践3.1实验目标1.掌握根据设计文档进行代码实现的基本技能。2.熟悉编码规范，培养良好的编码习惯。3.熟练运用Git进行版本控制和团队协作。3.2实验任务1.基于详细设计文档，选择合适的编程语言和开发工具，对“小型图书管理系统”的核心模块进行编码实现。2.遵循选定的编码规范（如Java编码规范、PythonPEP8规范）。3.使用Git进行代码的版本控制：*在Git仓库中创建开发分支。*每人在自己负责的模块或功能上进行开发，并定期提交代码。*适时将个人分支的代码合并到主分支或开发主分支，并解决可能的冲突。*提交信息应清晰、规范，描述本次修改的内容。3.3实验原理与方法*编码规范：包括命名规范、代码格式、注释规范、异常处理等，旨在提高代码的可读性、可维护性和可靠性。*版本控制工作流：如GitFlow、GitHubFlow等，规范团队的分支使用和代码合并流程。*代码复用：尽量使用成熟的库、框架和组件，避免重复造轮子。3.4实验步骤与内容1.编码准备：*团队成员共同约定编码规范和Git使用流程。*在Git服务器（如GitHub、GitLab或本地Git服务器）上创建项目仓库。*每个团队成员克隆仓库到本地。2.分支管理：*每个成员从develop分支创建个人功能分支（feature/xxx）进行开发。3.代码实现：*根据详细设计，分模块、分功能进行代码编写。*编写必要的单元测试。*频繁进行本地提交，确保代码安全。4.代码提交与合并：*功能完成或达到一个小的里程碑后，将个人功能分支推送到远程仓库。*通过PullRequest/MergeRequest请求将功能分支合并到develop分支。*团队成员（通常是项目负责人或模块负责人）进行代码审查，通过后合并。5.冲突解决：当合并代码出现冲突时，由相关开发人员协商解决。3.5实验成果与提交要求1.可运行的核心模块源代码。3.编码规范文档（若团队自行制定或细化）。4.实验报告（含编码过程、遇到的问题及解决方法、Git使用心得等）。实验四：软件测试实践4.1实验目标1.理解软件测试的基本概念、原则和流程。2.掌握至少两种常用的测试方法（如单元测试、集成测试）。3.学会设计测试用例，并使用测试工具进行测试。4.了解缺陷管理流程。4.2实验任务1.针对“小型图书管理系统”已实现的模块，制定简单的测试计划。2.设计测试用例：*为核心功能（如图书信息添加、查询、借阅、归还）设计至少5-8个测试用例，覆盖正常情况、边界条件和异常情况。*测试用例应包含：用例ID、模块、功能点、输入数据、预期输出、实际输出、测试结果等。3.执行测试：*对指定模块进行单元测试（可使用JUnit、pytest等单元测试框架）。*对相关联的模块进行简单的集成测试。4.记录测试过程中发现的缺陷，填写缺陷报告（包含缺陷标题、复现步骤、预期结果、实际结果、严重程度、优先级等）。5.（可选）使用缺陷管理工