“物品复活”软件PSP数据

“物品复活”软件PSP 数据

github地址：https://github.com/FelixL0120/Resurrected-software-development.git

项目代码量

• 项目代码量：280 行 Python 代码

开发目标

• 开发目标：编写、调试并完善物品管理软件的 Python 代码，实现物品的增删查功能，并通过测试，确保软件稳定运行。该软件旨在帮助大学生有效管理闲置物品，避免浪费，同时为管理员提供便捷的物品类型管理功能。通过这款软件，大学生可以轻松地记录和查找自己的物品，而管理员则能够高效地设置和调整物品分类，以适应不同物品的管理需求。

1. 计划阶段 (Planning)

• 任务：明确需求和相关因素，估算时间、成本和依赖关系。
• 时间估计：60 分钟
• 说明：深入分析物品管理软件项目的基本功能需求，涵盖物品信息管理（如物品名称、物品说明、物品所在地址、联系人手机、邮箱等公共信息）和物品分类管理（如食品、书籍、工具等类别及其特定属性，如食品的保质期和数量，书籍的作者和出版社等）。同时，考虑用户角色管理（管理员和普通用户），明确普通用户的注册、审批流程以及不同角色的操作权限。预估项目代码量约为 280 行，并合理分配各阶段的开发时间，以确保项目按时完成。在计划阶段，还考虑了开发过程中可能遇到的依赖关系，如对 tkinter 库和 JSON 文件格式的依赖，以及可能影响开发进度的风险因素，如需求变更和技术难题等。

2. 开发阶段 (Development)

2.1 需求分析 (Analysis)

• 任务：分析代码的具体需求，包括输入、输出、功能和边界条件。
• 实际时间：30 分钟
• 说明：详细梳理软件的主要功能：
  • 物品信息管理：允许用户添加、删除和查询物品信息，包括物品名称、物品说明、物品所在地址、联系人手机和邮箱等公共信息。用户可以通过输入相关字段来添加新物品，也可以根据物品名称或类别来查询物品信息。
  • 物品分类管理：支持管理员设置新的物品类型，定义物品类型的名称和各个属性，并允许修改物品类型。普通用户在添加物品时需先选择物品类型，再填入物品信息，这样可以确保物品信息的分类准确性和一致性。
  • 用户管理：区分管理员和普通用户角色。普通用户需注册并填写基本信息（如住址、联系方式等），经管理员批准后成为正式用户。普通用户可搜寻物品，需先选择类型，再输入关键字进行匹配，以便快速找到所需物品。
  • 界面需求：软件需提供图形用户界面（GUI），使用户能够直观、便捷地操作各项功能。界面应包含清晰的导航菜单、直观的物品列表展示和方便的用户交互元素。

2.2 设计文档生成 (Design Spec)

• 任务：编写设计文档，详细描述代码的实现方式、主要模块和关键算法。
• 实际时间：120 分钟
• 说明：在设计文档中确定软件的各个模块及其功能：
  • 数据管理模块：负责物品信息和物品类型的存储、加载与更新，使用 JSON 文件实现数据持久化。该模块需要设计合理的数据结构，以便高效地存储和检索物品信息。
  • 用户界面模块：包含主界面、注册界面、登录界面等，使用 tkinter 库构建 GUI，展示物品列表、物品详情、用户注册和登录表单等。界面设计应注重用户体验，确保布局合理、操作简便。
  • 物品操作模块：实现添加物品、删除物品、查询物品等功能，处理用户输入和数据交互。该模块需要与数据管理模块紧密配合，确保数据的一致性和完整性。
  • 用户管理模块：管理用户注册、登录和权限验证，区分管理员和普通用户操作。该模块需要实现用户信息的加密存储和安全验证，以保障系统的安全性。
  • 定义模块间的接口和功能调用顺序，确保各模块协同工作，共同完成物品管理任务。

2.3 设计复审 (Design Review)

• 任务：复查设计文档，确保设计合理，发现潜在问题。
• 实际时间：20 分钟
• 说明：仔细复查设计文档，检查各模块的接口和交互是否合理，确保数据存储、界面交互等细节设计正确无误。特别关注物品分类管理和用户权限控制的逻辑，以避免在物品类型设置、用户注册审批等环节出现错误。在复审过程中，发现了一些潜在的设计问题，如物品类型属性的动态管理不够灵活，需要进一步优化。

2.4 代码规范 (Coding Standard)

• 任务：为开发制定合适的代码规范，包括命名、注释、代码格式等。
• 实际时间：20 分钟
• 说明：确定代码风格，如函数和变量命名规范（采用小写字母加下划线的命名方式）、注释标准（在每个函数和模块开头添加注释，说明其功能和参数）、缩进（使用 4 个空格的缩进）等，确保代码在物品操作、数据持久化、界面更新等操作中保持一致性。为 tkinter 界面组件和功能模块的命名制定规则，便于代码的可读性和后续维护。制定代码规范有助于提高代码质量，减少团队协作中的沟通成本。

2.5 具体设计 (Design)

• 任务：根据设计文档进行详细设计，准备编码。
• 实际时间：30 分钟
• 说明：在详细设计中，将整体界面划分为功能区域：
  • 物品列表显示区：使用 Listbox 组件展示所有物品的基本信息，如名称、类别等。设计合理的列表布局，以便用户能够快速浏览和选择物品。
  • 操作按钮区：包含添加物品、删除物品、查询物品、显示所有物品的按钮，以及用户注册和登录按钮。按钮设计应直观明了，方便用户进行各项操作。
  • 物品详细信息展示区：用于展示选中物品的详细信息，如物品说明、地址、联系人信息等。设计清晰的信息展示格式，使用户能够一目了然地了解物品的详细情况。
  • 用户注册和登录表单区：设计注册和登录表单，收集用户信息并进行验证。表单设计应简洁易用，确保用户能够顺利完成注册和登录流程。
  • 详细规划数据的加载和保存逻辑，确保在物品添加、删除、查询等操作完成后，数据能够及时更新到 JSON 文件中，保持数据的持久性和一致性。

2.6 编码 (Coding)

• 任务：根据设计文档实现代码，编写具体功能模块。
• 实际时间：180 分钟
• 说明：首先实现物品管理软件的基础功能，包括物品数据的加载、保存以及增删查操作的逻辑实现。然后开发 GUI 界面，使用 tkinter 库创建图形界面，将之前实现的功能嵌入到界面中，使用户能够通过图形界面方便地进行物品管理操作。确保每个功能模块独立、清晰，并在代码中加入详细注释，便于后续调试和维护。在编码过程中，遵循制定的代码规范，保持代码的整洁和一致性。具体实现如下：
  • 数据管理模块：实现了 load_data 和 save_data 函数，用于从 JSON 文件中加载物品和物品类型数据，并将更新后的数据保存回文件。在 App 类中，使用这些函数加载初始数据，并在添加、删除、修改物品和物品类型时调用 save_data 函数保存更改。
  • 用户界面模块：创建了登录界面、注册界面和主界面。登录界面包含用户名和密码输入框以及登录按钮，注册界面允许用户输入注册信息并提交注册请求。主界面根据用户角色展示不同的功能按钮和信息展示区域，如物品列表、物品详细信息、用户注册和登录表单等。
  • 物品操作模块：实现了 add_item、delete_item 和 search_item 方法，分别用于添加、删除和查询物品。在添加物品时，根据选择的物品类型动态提示用户输入相应的属性信息；删除物品时，根据物品名称从数据中移除对应物品；查询物品时，根据物品类型和关键字筛选出匹配的物品并展示结果。
  • 用户管理模块：实现了 login、register_admin 和 register_user 方法，用于用户登录、注册管理员和注册普通用户。登录时验证用户名和密码，并根据用户权限展示相应界面；注册管理员和普通用户时收集用户信息并保存，普通用户注册后需等待管理员批准。

2.7 代码复审 (Code Review)

• 任务：复查代码，确保代码符合规范，检查潜在问题。
• 实际时间：30 分钟
• 说明：仔细复查代码的逻辑，检查输入处理、异常处理、数据更新（保存至 JSON 文件）是否正确，确保所有功能模块在不同情况下（如搜索状态和非搜索状态）均能正确工作。重点检查物品详细信息展示功能在物品列表过滤或搜索后是否能够显示正确的数据，避免因数据索引错误导致的问题。在代码复审过程中，发现了一些潜在的代码问题，如部分变量命名不够清晰，需要进行优化和改进。例如，在 add_item 方法中，将 item_type_name 变量重命名为 selected_item_type，以更准确地反映其含义；在 search_item 方法中，将 keyword 变量重命名为 search_keyword，以避免与其他变量混淆。

2.8 测试 (Test)

• 任务：对代码进行自测和修正，确保代码符合功能需求。
• 实际时间：60 分钟
• 说明：对物品管理软件进行全面测试，包括基本功能（增、删、查）的正确性测试和界面交互的流畅性测试。特别针对物品详细信息展示功能进行测试，确保在物品列表过滤或搜索后能够正确显示详细信息。在测试过程中发现并修复了 3 个缺陷，分别涉及输入处理（如输入非法字符时程序异常）、数据持久化（数据保存不完整）和查找功能逻辑（搜索结果不准确）等问题。具体测试用例和修复措施如下：
  • 输入处理缺陷：在添加物品时，如果用户输入非法字符（如特殊符号），程序会抛出异常。修复措施是在输入框中添加字符过滤功能，只允许输入合法字符，并在输入非法字符时弹出提示信息。
  • 数据持久化缺陷：在删除物品后，数据未能正确保存到 JSON 文件中，导致下次启动程序时物品列表不完整。修复措施是确保在删除物品后调用 save_data 函数，并检查文件写入操作是否成功，如果失败则弹出错误提示。
  • 查找功能逻辑缺陷：在搜索物品时，搜索结果不准确，可能会包含不符合关键字的物品。修复措施是优化搜索算法，确保只返回完全匹配关键字的物品，并在搜索结果为空时提示用户未找到相关物品。

3. 时间记录 (Record Time Spent)

• 任务：记录每个阶段的时间，方便后续分析和优化。
• 总时间：550 分钟

4. 测试报告 (Test Report)

• 任务：记录测试结果和缺陷修复情况，确保代码质量。
• 缺陷数：5 个
• 缺陷修复时间：60 分钟

5. 代码量统计 (Size Measurement)

• 任务：统计代码行数（LOC）。
• 代码行数：280 行

6. 事后总结 (Postmortem)

• 总结：本项目按时完成了物品管理软件的开发任务，实现了既定功能，并通过了测试。软件能够帮助大学生有效管理闲置物品，避免浪费，同时为管理员提供了便捷的物品类型管理功能。在开发过程中，虽然遇到了一些技术难题和缺陷，但通过及时的复查和修复，最终确保了软件的质量和稳定性。项目团队在协作过程中也积累了宝贵的经验，提升了团队的凝聚力和执行力。
• 改进点：
  • 在需求分析阶段，应更加深入地挖掘潜在的边界情况和特殊场景，如物品信息的特殊格式、用户输入的异常情况等，以便在设计和编码阶段能够更好地应对。可以与用户进行更深入的沟通，了解他们的实际使用场景和需求细节。
  • 在编码前，确保设计文档更加详细和完善，明确每个功能模块的具体实现细节，减少编码过程中的不确定性和返工。同时，加强对用户界面交互的细节设计，提升用户体验。可以引入更多的设计工具和方法，如原型设计和用户测试，以确保界面设计的合理性和易用性。

7. 过程改进计划 (Process Improvement Plan)

• 改进建议：
  • 提高设计阶段的时间分配，充分考虑各种可能的功能需求和边界情况，确保所有细节在编码前都已准备妥当。可以引入更多的用户反馈和市场调研，以更好地满足用户需求。同时，加强设计文档的评审和更新，确保设计的准确性和一致性。
  • 加强测试阶段的缺陷预防工作，通过更早的设计复查和代码复审减少后续的修复工作量。可以采用自动化测试工具和方法，提高测试的效率和覆盖率。同时，建立完善的缺陷管理流程，及时记录、分析和修复缺陷，确保软件质量的持续改进。