code-adjust-record-2025-01-17-stuColBatch-scope-api-integration.md 5.1 KB

学生信息收集批次收集范围功能完善记录

日期: 2025-01-17
开发者: Cursor AI
变更类型: 功能完善
影响范围: 前端页面、后端API接口

📋 变更概述

完善了学生信息收集批次管理页面中的收集范围功能,实现了前后端完整的API调用,包括设置收集范围和获取收集范围。

🔧 具体变更

1. 后端API接口完善

新增获取收集范围接口

文件: backend/ruoyi-modules/ruoyi-xg/src/main/java/org/dromara/xg/controller/XgStuColBatchClassController.java

  • 添加了 getScope API接口
  • 接口路径: GET /stuColBatchClass/stuColBatchClass/getScope/{batchId}
  • 返回指定批次的班级ID列表
  • 权限标识: stuColBatchClass:stuColBatchClass:query

Mapper层完善

文件: backend/ruoyi-modules/ruoyi-xg/src/main/java/org/dromara/xg/mapper/XgStuColBatchClassMapper.java

  • 新增 selectClassIdsByBatchId 方法
  • 根据批次ID查询班级ID列表

XML映射文件完善

文件: backend/ruoyi-modules/ruoyi-xg/src/main/resources/mapper/stuColBatchClass/XgStuColBatchClassMapper.xml

  • 添加了 selectClassIdsByBatchId 的SQL实现
  • 查询条件: batch_id = #{batchId} AND deleted = 0

2. 前端API接口完善

新增API方法

文件: web/src/api/stuColBatchClass/stuColBatchClass/index.ts

  • 添加了 setScope API方法(设置收集范围)
  • 添加了 getScope API方法(获取收集范围)
  • 使用标准的request请求格式

3. 前端页面功能完善

导入API方法

文件: web/src/views/XgStuColBatch/stuColBatch/index.vue

  • 导入了 setScope 和 getScope API方法
  • 完善了API调用逻辑

完善submitScope方法

  • 移除了临时的console.log代码
  • 实现了完整的API调用逻辑
  • 添加了成功和失败的消息提示
  • 根据API响应显示相应的消息

完善loadCurrentScope方法

  • 实现了获取当前批次收集范围的API调用
  • 将获取到的班级ID列表设置为已选中状态
  • 添加了错误处理机制

🎯 技术特性

数据一致性保证

  • ✅ 使用事务确保设置收集范围的数据一致性
  • ✅ 先清理历史数据,再插入新数据
  • ✅ 异常时自动回滚

用户体验优化

  • ✅ 打开弹窗时自动加载已设置的收集范围
  • ✅ 设置成功后显示详细的操作结果信息
  • ✅ 完整的错误处理和用户提示

权限控制

  • ✅ 使用 @SaCheckPermission 进行权限验证
  • ✅ 查询权限: stuColBatchClass:stuColBatchClass:query
  • ✅ 设置权限: stuColBatchClass:stuColBatchClass:setScope

操作日志

  • ✅ 使用 @Log 记录设置操作日志
  • ✅ 业务类型: BusinessType.UPDATE

防重复提交

  • ✅ 使用 @RepeatSubmit 防止重复提交

📊 API接口详情

获取收集范围接口

  • 方法: GET
  • 路径: /stuColBatchClass/stuColBatchClass/getScope/{batchId}
  • 响应格式:

    {
    "code": 200,
    "msg": "操作成功",
    "data": [1, 2, 3]  // 班级ID列表
    }
    

    设置收集范围接口

    • 方法: POST
    • 路径: /stuColBatchClass/stuColBatchClass/setScope
    • 请求参数:
    • batchId: 批次ID
    • deptIds: 班级ID列表
    • 响应格式: json { "code": 200, "msg": "权限设置成功,共设置 X 个班级权限", "data": null }

🔍 业务逻辑

获取收集范围流程

  1. 前端调用 getScope API
  2. 后端查询 xg_stu_col_batch_class 表
  3. 返回该批次下的所有班级ID列表
  4. 前端将班级ID设置为树形控件的选中状态

设置收集范围流程

  1. 前端获取树形控件选中的节点
  2. 调用 setScope API传递批次ID和班级ID列表
  3. 后端清理历史权限数据
  4. 插入新的权限数据
  5. 返回操作结果

✅ 质量保证

代码规范

  • ✅ 遵循项目开发规范
  • ✅ 使用统一的响应格式
  • ✅ 完整的异常处理机制
  • ✅ 详细的注释说明

数据库规范

  • ✅ 使用逻辑删除,不物理删除数据
  • ✅ 包含完整的基础字段
  • ✅ 正确的索引设计

前端规范

  • ✅ 使用标准的API调用方式
  • ✅ 完整的错误处理
  • ✅ 良好的用户体验

🚀 功能验证

测试场景

  1. 获取收集范围: 打开收集范围弹窗时,正确显示已设置的班级
  2. 设置收集范围: 选择班级后提交,成功保存并显示结果
  3. 错误处理: 网络异常或服务器错误时的用户提示
  4. 权限验证: 无权限用户无法访问相关功能

预期结果

  • ✅ 收集范围功能完整可用
  • ✅ 前后端数据交互正常
  • ✅ 用户体验良好
  • ✅ 错误处理完善

📝 后续优化建议

  1. 性能优化: 考虑对大量班级数据的加载进行分页处理
  2. 缓存机制: 对部门树数据进行缓存,提高加载速度
  3. 批量操作: 支持批量设置多个批次的收集范围
  4. 权限细化: 根据用户角色显示不同的班级选项

🎯 目标: 通过完善前后端API调用,实现了学生信息收集批次收集范围功能的完整可用性,提供了良好的用户体验和稳定的数据操作。