Files
hzdyjs/backend/ruoyi-modules/ruoyi-bzrkh/班主任考核计划管理部署说明.md
T
2025-08-19 15:27:06 +08:00

6.2 KiB
Raw Blame History

班主任考核计划管理模块部署说明

模块概述

班主任考核计划管理模块是班主任考核管理系统的重要组成部分,用于管理考核计划的生命周期,包括计划的创建、修改、删除、查询以及状态管理等功能。

技术架构

后端技术栈

  • 框架: Spring Boot 3.4.6
  • ORM: MyBatis-Plus
  • 数据库: MySQL 8.0+
  • 权限管理: Sa-Token
  • 数据验证: Bean Validation

前端技术栈

  • 框架: Vue 3.5.13
  • UI组件: Element Plus
  • 类型检查: TypeScript 5.8.3
  • 构建工具: Vite

文件结构

后端文件

backend/ruoyi-modules/ruoyi-bzrkh/
├── src/main/java/org/dromara/bzrkh/
│   ├── domain/
│   │   ├── BmzrAssessmentPlan.java                    # 实体类
│   │   ├── bo/BmzrAssessmentPlanBo.java              # 业务对象
│   │   └── vo/BmzrAssessmentPlanVo.java              # 视图对象
│   ├── mapper/
│   │   └── BmzrAssessmentPlanMapper.java             # 数据访问层
│   ├── service/
│   │   ├── IBmzrAssessmentPlanService.java           # 服务接口
│   │   └── impl/BmzrAssessmentPlanServiceImpl.java   # 服务实现
│   └── controller/
│       └── BmzrAssessmentPlanController.java         # 控制器
├── 班主任考核计划管理权限配置.sql                        # 权限配置SQL
└── 班主任考核计划管理部署说明.md                         # 部署说明

前端文件

web/src/
├── api/bzrkh/assessmentPlan/
│   ├── types.ts                                      # 类型定义
│   └── index.ts                                      # API接口
└── views/bzrkh/assessmentPlan/
    └── index.vue                                     # Vue组件

文档文件

docs/开发文档/API/
└── 班主任考核计划管理API.md                            # API文档

部署步骤

1. 数据库初始化

创建数据表: 执行 docs/设计文档/database/班主任考核管理/bmzr_assessment_tables.sql 中的 bmzr_assessment_plan 表创建语句。

配置字典数据: 执行 docs/设计文档/database/班主任考核管理/bmzr_dict_data_mysql.sql 中的相关字典配置。

2. 权限配置

执行 backend/ruoyi-modules/ruoyi-bzrkh/班主任考核计划管理权限配置.sql 文件,创建菜单和权限配置。

3. 后端代码部署

  1. 确保 ruoyi-bzrkh 模块已在主工程的 pom.xml 中引入
  2. 确保所有Java文件已正确放置在对应目录
  3. 重启后端服务

4. 前端代码部署

  1. 将前端Vue组件文件放置在正确目录
  2. 确保API类型定义和接口文件正确配置
  3. 重新构建前端项目

5. 功能验证

  1. 登录系统,验证菜单显示正常
  2. 测试各项功能:新增、修改、删除、查询、导出
  3. 验证权限控制正常工作

权限配置详情

菜单权限

  • 主菜单: 班主任考核计划管理
  • 路径: /bzrkh/assessmentPlan
  • 组件: bzrkh/assessmentPlan/index
  • 图标: fa fa-calendar-check-o

功能权限

权限字符 权限名称 说明
bzrkh:assessmentPlan:list 考核计划列表 查询考核计划列表的权限
bzrkh:assessmentPlan:query 考核计划查询 查询单个考核计划详情的权限
bzrkh:assessmentPlan:add 考核计划新增 新增考核计划的权限
bzrkh:assessmentPlan:edit 考核计划修改 修改考核计划信息的权限
bzrkh:assessmentPlan:remove 考核计划删除 删除考核计划的权限
bzrkh:assessmentPlan:export 考核计划导出 导出考核计划数据的权限

API接口列表

RESTful接口

方法 路径 说明 权限
GET /bzrkh/assessmentPlan/list 查询计划列表 bzrkh:assessmentPlan:list
GET /bzrkh/assessmentPlan/{id} 获取计划详情 bzrkh:assessmentPlan:query
POST /bzrkh/assessmentPlan 新增计划 bzrkh:assessmentPlan:add
PUT /bzrkh/assessmentPlan 修改计划 bzrkh:assessmentPlan:edit
DELETE /bzrkh/assessmentPlan/{ids} 删除计划 bzrkh:assessmentPlan:remove
POST /bzrkh/assessmentPlan/export 导出计划 bzrkh:assessmentPlan:export
PUT /bzrkh/assessmentPlan/changeStatus 修改状态 bzrkh:assessmentPlan:edit
GET /bzrkh/assessmentPlan/schemes/options 获取方案选项 bzrkh:assessmentPlan:list

核心功能特性

1. 计划管理

  • 支持考核计划的完整生命周期管理
  • 计划编码唯一性校验
  • 时间范围合理性验证

2. 状态控制

  • 支持计划启用/禁用状态切换
  • 状态变更权限控制

3. 数据导出

  • 支持Excel格式数据导出
  • 可根据查询条件导出指定数据

4. 权限控制

  • 完整的菜单和功能权限控制
  • 基于Sa-Token的细粒度权限管理

注意事项

开发要求

  1. 所有API接口必须包含权限注解
  2. 参数验证使用Bean Validation
  3. 错误处理要规范统一
  4. 代码注释要完整清晰

业务规则

  1. 计划编码在租户内必须唯一
  2. 计划的开始时间不能大于结束时间
  3. 数据提取时间不能超出计划时间范围
  4. 删除计划前需要检查关联数据

性能优化

  1. 查询接口支持分页
  2. 列表查询支持多条件组合查询
  3. 大数据量导出采用流式处理

故障排查

常见问题

  1. 权限问题: 检查菜单权限配置是否正确
  2. 接口404: 检查后端路由配置
  3. 前端报错: 检查API接口定义是否匹配
  4. 数据库错误: 检查表结构和字段是否正确

日志查看

  • 后端日志位置: logs/ruoyi-admin.log
  • 前端控制台: 浏览器开发者工具

联系方式

如有问题,请联系开发团队或查看相关文档:

  • API文档: docs/开发文档/API/班主任考核计划管理API.md
  • 数据库文档: docs/设计文档/database/班主任考核管理/

版本信息

  • 版本: v1.0.0
  • 创建时间: 2025-01-08
  • 最后更新: 2025-01-08
  • 开发者: 系统开发团队