shanxia/.cursorrules

# 杭州第一技师学院智慧校园管理系统 - AI 代码生成规范

## 🎯 项目概述

本项目是基于 RuoYi-Vue-Plus 框架开发的智慧校园管理系统，主要用于学校的学工管理、宿舍管理、班级管理等业务场景。

- **项目名称**: 杭州第一技师学院智慧校园管理系统
- **基础框架**: RuoYi-Vue-Plus 5.4.0
- **前端**: Vue 3 + TypeScript + Element Plus + Vite
- **后端**: Spring Boot 3.4.6 + MyBatis-Plus + Sa-Token

---

## ⚠️ AI代码生成核心规则

### 文档生成规范
- **禁止主动生成MD文档**：在代码生成过程中，除非用户明确要求，否则不要生成任何Markdown文档（.md文件）
- **简洁优先原则**：如果必须生成说明文档，内容要极度简洁，只包含关键信息
- **聚焦代码实现**：将精力集中在代码生成和功能实现上，而非文档编写
- **例外情况**：仅在以下情况生成文档
  - 用户明确要求生成文档
  - 项目README或API文档等必要文件缺失
  - 复杂功能需要关键说明（限制在50行以内）

---

## 📦 前端技术栈总结

### 核心框架与版本
- **Vue**: 3.5.13 (使用 Composition API)
- **TypeScript**: 5.8.3
- **Vite**: 6.3.2
- **Element Plus**: 2.9.8
- **Pinia**: 3.0.2 (状态管理)
- **Vue Router**: 4.5.0 (路由管理)
- **Axios**: 1.8.4 (HTTP请求)

### 关键工具库
- **vxe-table**: 4.13.7 (高级表格组件)
- **UnoCSS**: 66.0.0 (原子化CSS框架)
- **echarts**: 5.6.0 (数据可视化)
- **@vueuse/core**: 13.1.0 (Vue组合式工具集)
- **vue-i18n**: 11.1.3 (国际化)
- **screenfull**: 6.0.2 (全屏)
- **nprogress**: 0.2.0 (进度条)

### 项目结构
```
web/
├── src/
│   ├── api/           # API接口定义
│   ├── assets/        # 静态资源
│   ├── components/    # 公共组件
│   ├── directive/     # 自定义指令
│   ├── hooks/         # 组合式函数
│   ├── lang/          # 国际化语言包
│   ├── layout/        # 布局组件
│   ├── plugins/       # 插件配置
│   ├── router/        # 路由配置
│   ├── store/         # Pinia状态管理
│   ├── utils/         # 工具函数
│   ├── views/         # 页面视图
│   └── main.ts        # 入口文件
├── vite/              # Vite插件配置
├── index.html
├── vite.config.ts
└── package.json
```

---

## 📦 后端技术栈总结

### 核心框架与版本
- **Spring Boot**: 3.4.6
- **JDK**: 17+
- **MyBatis**: 3.5.16
- **MyBatis-Plus**: 3.5.12
- **Sa-Token**: 1.42.0 (权限认证)
- **Hutool**: 5.8.35 (工具库)

### 关键技术组件
- **Redisson**: 3.45.1 (Redis客户端，分布式锁)
- **Lock4j**: 2.2.7 (分布式锁)
- **dynamic-datasource**: 4.3.1 (动态多数据源)
- **p6spy**: 3.9.1 (SQL性能分析)
- **FastExcel**: 1.2.0 (Excel导入导出)
- **SpringDoc**: 2.8.8 (API文档生成)
- **Warm-Flow**: 1.7.3 (国产工作流引擎)
- **SnailJob**: 1.5.0 (分布式任务调度)
- **AWS S3**: 2.28.22 (对象存储)
- **SMS4J**: 3.3.4 (短信发送)
- **ip2region**: 2.7.0 (IP地址定位)
- **MapStruct-Plus**: 1.5.0 (对象转换)

### 项目结构
```
backend/
├── ruoyi-admin/              # 启动模块
├── ruoyi-common/             # 通用模块
│   ├── ruoyi-common-core/    # 核心工具
│   ├── ruoyi-common-mybatis/ # 数据库配置
│   ├── ruoyi-common-redis/   # Redis配置
│   ├── ruoyi-common-satoken/ # 权限配置
│   ├── ruoyi-common-web/     # Web配置
│   ├── ruoyi-common-excel/   # Excel工具
│   └── ...                   # 其他通用模块
├── ruoyi-modules/            # 业务模块
│   ├── ruoyi-system/         # 系统管理
│   ├── ruoyi-job/            # 定时任务
│   ├── ruoyi-workflow/       # 工作流
│   └── ruoyi-xg/             # 学工管理 ⭐
└── ruoyi-extend/             # 扩展模块
    ├── ruoyi-monitor-admin/  # 监控中心
    └── ruoyi-snailjob-server/# 任务调度服务
```

---

## 🎓 学工模块（ruoyi-xg）架构规范

### 后端模块结构
```
ruoyi-xg/
└── src/main/java/org/dromara/xg/
    ├── controller/    # 控制器层 - RESTful API
    ├── service/       # 服务层 - 业务逻辑
    │   └── impl/      # 服务实现
    ├── mapper/        # 数据访问层 - MyBatis接口
    ├── domain/        # 数据模型
    │   ├── bo/        # Business Object - 业务对象(接收参数)
    │   └── vo/        # View Object - 视图对象(返回数据)
    ├── convert/       # 对象转换器 - MapStruct
    ├── config/        # 配置类
    ├── utils/         # 工具类
    └── listener/      # 事件监听器
```

### 前端模块结构
```
web/src/
├── api/xg/                  # 学工API接口定义
│   ├── student/             # 学生管理API
│   ├── xsjcxx/              # 学生基础信息API
│   ├── xgss/                # 学工宿舍API
│   ├── studentStatistics.ts # 学生统计API
│   └── README.md
└── views/xg/                # 学工页面视图
    ├── xsjcxx/              # 学生基础信息模块
    ├── xgss/                # 学工宿舍模块
    ├── studentStatistics/   # 学生统计模块
    └── README.md
```

---

## 🚀 后端开发规范（学工模块）

### 1. Controller 层规范

```java
package org.dromara.xg.controller;

import cn.dev33.satoken.annotation.SaCheckPermission;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.validation.constraints.*;
import lombok.RequiredArgsConstructor;
import org.dromara.common.core.domain.R;
import org.dromara.common.core.validate.AddGroup;
import org.dromara.common.core.validate.EditGroup;
import org.dromara.common.excel.utils.ExcelUtil;
import org.dromara.common.idempotent.annotation.RepeatSubmit;
import org.dromara.common.log.annotation.Log;
import org.dromara.common.log.enums.BusinessType;
import org.dromara.common.mybatis.core.page.*;
import org.dromara.common.web.core.BaseController;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

/**
 * XXX管理控制器
 *
 * @author Your Name
 * @date 2025-01-XX
 */
@Validated
@RequiredArgsConstructor
@RestController
@RequestMapping("/xg/模块名")
public class XgXxxController extends BaseController {

    private final IXgXxxService xxxService;

    /**
     * 查询列表（分页）
     */
    @SaCheckPermission("xg:xxx:list")
    @GetMapping("/list")
    public TableDataInfo<XgXxxVo> list(XgXxxBo bo, PageQuery pageQuery) {
        return xxxService.queryPageList(bo, pageQuery);
    }

    /**
     * 获取详细信息
     */
    @SaCheckPermission("xg:xxx:query")
    @GetMapping("/{id}")
    public R<XgXxxVo> getInfo(@NotNull(message = "主键不能为空") @PathVariable Long id) {
        return R.ok(xxxService.queryById(id));
    }

    /**
     * 新增
     */
    @SaCheckPermission("xg:xxx:add")
    @Log(title = "XXX管理", businessType = BusinessType.INSERT)
    @RepeatSubmit()
    @PostMapping()
    public R<Void> add(@Validated(AddGroup.class) @RequestBody XgXxxBo bo) {
        return toAjax(xxxService.insertByBo(bo));
    }

    /**
     * 修改
     */
    @SaCheckPermission("xg:xxx:edit")
    @Log(title = "XXX管理", businessType = BusinessType.UPDATE)
    @RepeatSubmit()
    @PutMapping()
    public R<Void> edit(@Validated(EditGroup.class) @RequestBody XgXxxBo bo) {
        return toAjax(xxxService.updateByBo(bo));
    }

    /**
     * 删除
     */
    @SaCheckPermission("xg:xxx:remove")
    @Log(title = "XXX管理", businessType = BusinessType.DELETE)
    @DeleteMapping("/{ids}")
    public R<Void> remove(@NotEmpty(message = "主键不能为空") @PathVariable Long[] ids) {
        return toAjax(xxxService.deleteWithValidByIds(List.of(ids), true));
    }

    /**
     * 导出
     */
    @SaCheckPermission("xg:xxx:export")
    @Log(title = "XXX管理", businessType = BusinessType.EXPORT)
    @PostMapping("/export")
    public void export(XgXxxBo bo, HttpServletResponse response) {
        List<XgXxxVo> list = xxxService.queryList(bo);
        ExcelUtil.exportExcel(list, "XXX数据", XgXxxVo.class, response);
    }
}
```

**关键点：**
- 继承 `BaseController` 提供基础工具方法
- 使用 `@RequiredArgsConstructor` 实现构造器注入
- 使用 `@SaCheckPermission` 进行权限控制，格式：`xg:模块:操作`
- 使用 `@Log` 记录操作日志
- 使用 `@RepeatSubmit` 防止重复提交
- 使用 `@Validated` 进行参数校验，分组校验使用 AddGroup/EditGroup
- 分页查询返回 `TableDataInfo<T>`，其他接口返回 `R<T>`

### 2. Service 层规范

```java
package org.dromara.xg.service;

import org.dromara.common.mybatis.core.page.*;
import org.dromara.xg.domain.bo.XgXxxBo;
import org.dromara.xg.domain.vo.XgXxxVo;

import java.util.Collection;
import java.util.List;

/**
 * XXX管理Service接口
 *
 * @author Your Name
 * @date 2025-01-XX
 */
public interface IXgXxxService {

    /**
     * 查询分页列表
     */
    TableDataInfo<XgXxxVo> queryPageList(XgXxxBo bo, PageQuery pageQuery);

    /**
     * 查询列表
     */
    List<XgXxxVo> queryList(XgXxxBo bo);

    /**
     * 根据主键查询
     */
    XgXxxVo queryById(Long id);

    /**
     * 新增
     */
    Boolean insertByBo(XgXxxBo bo);

    /**
     * 修改
     */
    Boolean updateByBo(XgXxxBo bo);

    /**
     * 校验并批量删除
     */
    Boolean deleteWithValidByIds(Collection<Long> ids, Boolean isValid);
}
```

**实现类规范：**
```java
package org.dromara.xg.service.impl;

import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.toolkit.Wrappers;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import lombok.RequiredArgsConstructor;
import org.dromara.common.core.utils.MapstructUtils;
import org.dromara.common.core.utils.StringUtils;
import org.dromara.common.mybatis.core.page.*;
import org.dromara.xg.domain.XgXxx;
import org.dromara.xg.domain.bo.XgXxxBo;
import org.dromara.xg.domain.vo.XgXxxVo;
import org.dromara.xg.mapper.XgXxxMapper;
import org.dromara.xg.service.IXgXxxService;
import org.springframework.stereotype.Service;

import java.util.Collection;
import java.util.List;

/**
 * XXX管理Service实现
 *
 * @author Your Name
 * @date 2025-01-XX
 */
@RequiredArgsConstructor
@Service
public class XgXxxServiceImpl implements IXgXxxService {

    private final XgXxxMapper baseMapper;

    /**
     * 构建查询条件
     */
    private LambdaQueryWrapper<XgXxx> buildQueryWrapper(XgXxxBo bo) {
        LambdaQueryWrapper<XgXxx> lqw = Wrappers.lambdaQueryWrapper();
        lqw.like(StringUtils.isNotBlank(bo.getName()), XgXxx::getName, bo.getName());
        lqw.eq(bo.getStatus() != null, XgXxx::getStatus, bo.getStatus());
        lqw.between(bo.getBeginTime() != null && bo.getEndTime() != null,
            XgXxx::getCreateTime, bo.getBeginTime(), bo.getEndTime());
        lqw.orderByDesc(XgXxx::getCreateTime);
        return lqw;
    }

    @Override
    public TableDataInfo<XgXxxVo> queryPageList(XgXxxBo bo, PageQuery pageQuery) {
        LambdaQueryWrapper<XgXxx> lqw = buildQueryWrapper(bo);
        Page<XgXxxVo> result = baseMapper.selectVoPage(pageQuery.build(), lqw);
        return TableDataInfo.build(result);
    }

    @Override
    public List<XgXxxVo> queryList(XgXxxBo bo) {
        LambdaQueryWrapper<XgXxx> lqw = buildQueryWrapper(bo);
        return baseMapper.selectVoList(lqw);
    }

    @Override
    public XgXxxVo queryById(Long id) {
        return baseMapper.selectVoById(id);
    }

    @Override
    public Boolean insertByBo(XgXxxBo bo) {
        XgXxx entity = MapstructUtils.convert(bo, XgXxx.class);
        boolean flag = baseMapper.insert(entity) > 0;
        if (flag) {
            bo.setId(entity.getId());
        }
        return flag;
    }

    @Override
    public Boolean updateByBo(XgXxxBo bo) {
        XgXxx entity = MapstructUtils.convert(bo, XgXxx.class);
        return baseMapper.updateById(entity) > 0;
    }

    @Override
    public Boolean deleteWithValidByIds(Collection<Long> ids, Boolean isValid) {
        if (isValid) {
            // 做删除前的业务校验
        }
        return baseMapper.deleteByIds(ids) > 0;
    }
}
```

**关键点：**
- 使用 `@RequiredArgsConstructor` 注入 Mapper
- 使用 MyBatis-Plus 的 LambdaQueryWrapper 构建查询条件
- 使用 `MapstructUtils.convert` 进行对象转换
- 使用 `selectVoPage` 和 `selectVoList` 直接查询VO对象

### 3. Domain 层规范

**Entity（实体类）：**
```java
package org.dromara.xg.domain;

import com.baomidou.mybatisplus.annotation.*;
import lombok.Data;
import lombok.EqualsAndHashCode;
import org.dromara.common.tenant.core.TenantEntity;

import java.io.Serial;
import java.time.LocalDateTime;

/**
 * XXX实体对象 xg_xxx
 *
 * @author Your Name
 * @date 2025-01-XX
 */
@Data
@EqualsAndHashCode(callSuper = true)
@TableName("xg_xxx")
public class XgXxx extends TenantEntity {

    @Serial
    private static final long serialVersionUID = 1L;

    /**
     * 主键ID
     */
    @TableId(value = "id", type = IdType.ASSIGN_ID)
    private Long id;

    /**
     * 名称
     */
    private String name;

    /**
     * 状态
     */
    private String status;

    /**
     * 备注
     */
    private String remark;

    /**
     * 逻辑删除标志（0存在 1删除）
     */
    @TableLogic
    private Integer delFlag;
}
```

**BO（业务对象 - 接收前端参数）：**
```java
package org.dromara.xg.domain.bo;

import io.github.linpeilie.annotations.AutoMapper;
import jakarta.validation.constraints.*;
import lombok.Data;
import lombok.EqualsAndHashCode;
import org.dromara.common.core.validate.AddGroup;
import org.dromara.common.core.validate.EditGroup;
import org.dromara.common.mybatis.core.domain.BaseEntity;
import org.dromara.xg.domain.XgXxx;

/**
 * XXX业务对象 xg_xxx
 *
 * @author Your Name
 * @date 2025-01-XX
 */
@Data
@EqualsAndHashCode(callSuper = true)
@AutoMapper(target = XgXxx.class, reverseConvertGenerate = false)
public class XgXxxBo extends BaseEntity {

    /**
     * 主键ID
     */
    @NotNull(message = "主键不能为空", groups = { EditGroup.class })
    private Long id;

    /**
     * 名称
     */
    @NotBlank(message = "名称不能为空", groups = { AddGroup.class, EditGroup.class })
    private String name;

    /**
     * 状态
     */
    private String status;

    /**
     * 备注
     */
    private String remark;
}
```

**VO（视图对象 - 返回给前端）：**
```java
package org.dromara.xg.domain.vo;

import com.alibaba.excel.annotation.ExcelProperty;
import io.github.linpeilie.annotations.AutoMapper;
import lombok.Data;
import org.dromara.common.excel.annotation.ExcelDictFormat;
import org.dromara.common.excel.convert.ExcelDictConvert;
import org.dromara.xg.domain.XgXxx;

import java.io.Serial;
import java.io.Serializable;
import java.time.LocalDateTime;

/**
 * XXX视图对象 xg_xxx
 *
 * @author Your Name
 * @date 2025-01-XX
 */
@Data
@AutoMapper(target = XgXxx.class)
public class XgXxxVo implements Serializable {

    @Serial
    private static final long serialVersionUID = 1L;

    /**
     * 主键ID
     */
    @ExcelProperty(value = "ID")
    private Long id;

    /**
     * 名称
     */
    @ExcelProperty(value = "名称")
    private String name;

    /**
     * 状态
     */
    @ExcelProperty(value = "状态", converter = ExcelDictConvert.class)
    @ExcelDictFormat(dictType = "sys_normal_disable")
    private String status;

    /**
     * 备注
     */
    @ExcelProperty(value = "备注")
    private String remark;

    /**
     * 创建时间
     */
    @ExcelProperty(value = "创建时间")
    private LocalDateTime createTime;
}
```

### 4. Mapper 层规范

```java
package org.dromara.xg.mapper;

import org.dromara.common.mybatis.core.mapper.BaseMapperPlus;
import org.dromara.xg.domain.XgXxx;
import org.dromara.xg.domain.vo.XgXxxVo;

/**
 * XXX管理Mapper接口
 *
 * @author Your Name
 * @date 2025-01-XX
 */
public interface XgXxxMapper extends BaseMapperPlus<XgXxx, XgXxxVo> {
    // 自定义SQL方法在这里定义
}
```

**对应的 XML（如需自定义SQL）：**
```xml
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="org.dromara.xg.mapper.XgXxxMapper">

    <resultMap type="org.dromara.xg.domain.vo.XgXxxVo" id="XgXxxResult">
        <result property="id" column="id"/>
        <result property="name" column="name"/>
        <result property="status" column="status"/>
        <result property="remark" column="remark"/>
        <result property="createTime" column="create_time"/>
    </resultMap>

</mapper>
```

---

## 🎨 前端开发规范（学工模块）

### 1. API 接口定义规范

```typescript
// web/src/api/xg/xxx.ts
import request from '@/utils/request'

/**
 * 查询参数接口
 */
export interface XxxQuery {
  pageNum?: number
  pageSize?: number
  name?: string
  status?: string
  beginTime?: string
  endTime?: string
}

/**
 * 表单数据接口
 */
export interface XxxForm {
  id?: number
  name: string
  status: string
  remark?: string
}

/**
 * 视图对象接口
 */
export interface XxxVO {
  id: number
  name: string
  status: string
  remark?: string
  createTime: string
  updateTime: string
}

/**
 * 查询列表
 */
export function listXxx(query: XxxQuery) {
  return request({
    url: '/xg/xxx/list',
    method: 'get',
    params: query
  })
}

/**
 * 查询详细
 */
export function getXxx(id: number) {
  return request({
    url: `/xg/xxx/${id}`,
    method: 'get'
  })
}

/**
 * 新增
 */
export function addXxx(data: XxxForm) {
  return request({
    url: '/xg/xxx',
    method: 'post',
    data: data
  })
}

/**
 * 修改
 */
export function updateXxx(data: XxxForm) {
  return request({
    url: '/xg/xxx',
    method: 'put',
    data: data
  })
}

/**
 * 删除
 */
export function delXxx(ids: number | number[]) {
  return request({
    url: `/xg/xxx/${ids}`,
    method: 'delete'
  })
}

/**
 * 导出
 */
export function exportXxx(query: XxxQuery) {
  return request({
    url: '/xg/xxx/export',
    method: 'post',
    data: query,
    responseType: 'blob'
  })
}
```

**关键点：**
- 接口定义使用 TypeScript interface
- Query 参数用于列表查询（GET请求的params）
- Form 用于新增/修改（POST/PUT请求的data）
- VO 用于展示数据
- 导出接口需要设置 `responseType: 'blob'`

### 2. 列表页面规范

```vue
<!-- web/src/views/xg/xxx/index.vue -->
<template>
  <div class="app-container">
    <!-- 查询表单 -->
    <el-form :model="queryParams" ref="queryFormRef" :inline="true" label-width="80px">
      <el-form-item label="名称" prop="name">
        <el-input
          v-model="queryParams.name"
          placeholder="请输入名称"
          clearable
          @keyup.enter="handleQuery"
        />
      </el-form-item>
      <el-form-item label="状态" prop="status">
        <el-select v-model="queryParams.status" placeholder="请选择状态" clearable>
          <el-option
            v-for="dict in sys_normal_disable"
            :key="dict.value"
            :label="dict.label"
            :value="dict.value"
          />
        </el-select>
      </el-form-item>
      <el-form-item>
        <el-button type="primary" icon="Search" @click="handleQuery">搜索</el-button>
        <el-button icon="Refresh" @click="resetQuery">重置</el-button>
      </el-form-item>
    </el-form>

    <!-- 工具栏 -->
    <el-row :gutter="10" class="mb8">
      <el-col :span="1.5">
        <el-button
          type="primary"
          plain
          icon="Plus"
          @click="handleAdd"
          v-hasPermi="['xg:xxx:add']"
        >新增</el-button>
      </el-col>
      <el-col :span="1.5">
        <el-button
          type="success"
          plain
          icon="Edit"
          :disabled="single"
          @click="handleUpdate()"
          v-hasPermi="['xg:xxx:edit']"
        >修改</el-button>
      </el-col>
      <el-col :span="1.5">
        <el-button
          type="danger"
          plain
          icon="Delete"
          :disabled="multiple"
          @click="handleDelete()"
          v-hasPermi="['xg:xxx:remove']"
        >删除</el-button>
      </el-col>
      <el-col :span="1.5">
        <el-button
          type="warning"
          plain
          icon="Download"
          @click="handleExport"
          v-hasPermi="['xg:xxx:export']"
        >导出</el-button>
      </el-col>
      <right-toolbar v-model:showSearch="showSearch" @queryTable="getList" />
    </el-row>

    <!-- 数据表格 -->
    <el-table
      v-loading="loading"
      :data="xxxList"
      @selection-change="handleSelectionChange"
    >
      <el-table-column type="selection" width="55" align="center" />
      <el-table-column label="ID" align="center" prop="id" />
      <el-table-column label="名称" align="center" prop="name" :show-overflow-tooltip="true" />
      <el-table-column label="状态" align="center" prop="status">
        <template #default="scope">
          <dict-tag :options="sys_normal_disable" :value="scope.row.status" />
        </template>
      </el-table-column>
      <el-table-column label="创建时间" align="center" prop="createTime" width="180">
        <template #default="scope">
          <span>{{ parseTime(scope.row.createTime) }}</span>
        </template>
      </el-table-column>
      <el-table-column label="操作" align="center" class-name="small-padding fixed-width">
        <template #default="scope">
          <el-tooltip content="修改" placement="top">
            <el-button
              link
              type="primary"
              icon="Edit"
              @click="handleUpdate(scope.row)"
              v-hasPermi="['xg:xxx:edit']"
            />
          </el-tooltip>
          <el-tooltip content="删除" placement="top">
            <el-button
              link
              type="danger"
              icon="Delete"
              @click="handleDelete(scope.row)"
              v-hasPermi="['xg:xxx:remove']"
            />
          </el-tooltip>
        </template>
      </el-table-column>
    </el-table>

    <!-- 分页 -->
    <pagination
      v-show="total > 0"
      :total="total"
      v-model:page="queryParams.pageNum"
      v-model:limit="queryParams.pageSize"
      @pagination="getList"
    />

    <!-- 添加或修改对话框 -->
    <el-dialog :title="dialog.title" v-model="dialog.visible" width="600px" append-to-body>
      <el-form ref="formRef" :model="form" :rules="rules" label-width="100px">
        <el-form-item label="名称" prop="name">
          <el-input v-model="form.name" placeholder="请输入名称" />
        </el-form-item>
        <el-form-item label="状态" prop="status">
          <el-radio-group v-model="form.status">
            <el-radio
              v-for="dict in sys_normal_disable"
              :key="dict.value"
              :value="dict.value"
            >{{ dict.label }}</el-radio>
          </el-radio-group>
        </el-form-item>
        <el-form-item label="备注" prop="remark">
          <el-input v-model="form.remark" type="textarea" placeholder="请输入备注" />
        </el-form-item>
      </el-form>
      <template #footer>
        <div class="dialog-footer">
          <el-button @click="cancel">取 消</el-button>
          <el-button type="primary" @click="submitForm">确 定</el-button>
        </div>
      </template>
    </el-dialog>
  </div>
</template>

<script setup lang="ts" name="Xxx">
import { listXxx, getXxx, addXxx, updateXxx, delXxx, exportXxx } from '@/api/xg/xxx'
import type { XxxQuery, XxxForm, XxxVO } from '@/api/xg/xxx'

// 查询参数
const queryParams = ref<XxxQuery>({
  pageNum: 1,
  pageSize: 10,
  name: undefined,
  status: undefined
})

// 表单数据
const form = ref<XxxForm>({
  id: undefined,
  name: '',
  status: '0',
  remark: ''
})

// 表单校验规则
const rules = ref({
  name: [{ required: true, message: '名称不能为空', trigger: 'blur' }],
  status: [{ required: true, message: '状态不能为空', trigger: 'change' }]
})

// 数据列表
const xxxList = ref<XxxVO[]>([])
const loading = ref(true)
const total = ref(0)
const showSearch = ref(true)
const single = ref(true)
const multiple = ref(true)
const ids = ref<number[]>([])

// 字典数据
const { sys_normal_disable } = useDict('sys_normal_disable')

// 对话框
const dialog = reactive<DialogOption>({
  visible: false,
  title: ''
})

const queryFormRef = ref<ElFormInstance>()
const formRef = ref<ElFormInstance>()

/** 查询列表 */
const getList = async () => {
  loading.value = true
  try {
    const res = await listXxx(queryParams.value)
    xxxList.value = res.rows
    total.value = res.total
  } finally {
    loading.value = false
  }
}

/** 搜索按钮操作 */
const handleQuery = () => {
  queryParams.value.pageNum = 1
  getList()
}

/** 重置按钮操作 */
const resetQuery = () => {
  queryFormRef.value?.resetFields()
  handleQuery()
}

/** 多选框选中数据 */
const handleSelectionChange = (selection: XxxVO[]) => {
  ids.value = selection.map(item => item.id)
  single.value = selection.length !== 1
  multiple.value = !selection.length
}

/** 新增按钮操作 */
const handleAdd = () => {
  reset()
  dialog.visible = true
  dialog.title = '添加XXX'
}

/** 修改按钮操作 */
const handleUpdate = async (row?: XxxVO) => {
  reset()
  const id = row?.id || ids.value[0]
  const res = await getXxx(id)
  Object.assign(form.value, res.data)
  dialog.visible = true
  dialog.title = '修改XXX'
}

/** 提交表单 */
const submitForm = () => {
  formRef.value?.validate(async (valid) => {
    if (valid) {
      try {
        if (form.value.id) {
          await updateXxx(form.value)
          proxy?.$modal.msgSuccess('修改成功')
        } else {
          await addXxx(form.value)
          proxy?.$modal.msgSuccess('新增成功')
        }
        dialog.visible = false
        await getList()
      } catch (error) {
        console.error(error)
      }
    }
  })
}

/** 删除按钮操作 */
const handleDelete = async (row?: XxxVO) => {
  const idList = row?.id ? [row.id] : ids.value
  await proxy?.$modal.confirm('是否确认删除选中的数据？')
  await delXxx(idList)
  proxy?.$modal.msgSuccess('删除成功')
  await getList()
}

/** 导出按钮操作 */
const handleExport = () => {
  proxy?.$download(
    'xg/xxx/export',
    { ...queryParams.value },
    `xxx_${new Date().getTime()}.xlsx`
  )
}

/** 取消按钮 */
const cancel = () => {
  dialog.visible = false
  reset()
}

/** 表单重置 */
const reset = () => {
  form.value = {
    id: undefined,
    name: '',
    status: '0',
    remark: ''
  }
  formRef.value?.resetFields()
}

onMounted(() => {
  getList()
})
</script>
```

**关键点：**
- 使用 `<script setup lang="ts">` 语法
- 使用 `ref` 和 `reactive` 管理状态
- 使用 `v-hasPermi` 指令控制按钮权限
- 使用 `useDict` 获取字典数据
- 使用 `$modal` 显示消息和确认框
- 使用 `$download` 下载导出文件

### 3. 权限控制

**权限编码规范：** `xg:模块:操作`

示例：
- `xg:student:list` - 学生列表查询
- `xg:student:query` - 学生详情查询
- `xg:student:add` - 学生新增
- `xg:student:edit` - 学生修改
- `xg:student:remove` - 学生删除
- `xg:student:export` - 学生导出
- `xg:student:import` - 学生导入

**使用方式：**
```vue
<!-- 按钮权限控制 -->
<el-button v-hasPermi="['xg:student:add']">新增</el-button>

<!-- JS中判断权限 -->
<script setup>
import { hasPermi } from '@/utils/permission'

const canEdit = hasPermi(['xg:student:edit'])
</script>
```

---

## 📝 开发流程指南

### 1. 新建学工功能模块完整流程

#### 后端开发步骤：
1. **创建数据库表**（表名格式：`xg_模块名`）
2. **创建 Entity 实体类**（`domain/XgXxx.java`）
3. **创建 VO 视图对象**（`domain/vo/XgXxxVo.java`）
4. **创建 BO 业务对象**（`domain/bo/XgXxxBo.java`）
5. **创建 Mapper 接口**（`mapper/XgXxxMapper.java`）
6. **创建 Mapper XML**（`resources/mapper/xg/XgXxxMapper.xml`，如需自定义SQL）
7. **创建 Service 接口**（`service/IXgXxxService.java`）
8. **创建 Service 实现**（`service/impl/XgXxxServiceImpl.java`）
9. **创建 Controller 控制器**（`controller/XgXxxController.java`）
10. **在菜单管理中配置菜单和权限**

#### 前端开发步骤：
1. **创建 API 接口文件**（`api/xg/xxx.ts`）
2. **创建页面文件**（`views/xg/xxx/index.vue`）
3. **配置路由**（通过后端菜单管理配置，前端动态加载）
4. **测试功能**

### 2. 使用代码生成器（推荐）

框架提供了强大的代码生成器，可以一键生成所有代码：

1. 登录系统，进入 **系统工具 -> 代码生成**
2. 点击 **导入表**，选择要生成的数据库表
3. 点击 **编辑**，配置生成信息：
   - 基本信息：包名、模块名、作者等
   - 字段信息：字段类型、显示类型、是否必填等
   - 生成信息：生成模板、前端路径等
4. 点击 **生成代码**，下载代码包
5. 将生成的代码解压到对应目录
6. 重启后端服务，刷新前端页面

---

## 🎯 学工模块常见业务场景

### 1. 学生信息管理
- **表命名**: `xg_student`, `xg_student_msg`
- **权限前缀**: `xg:student`
- **API路径**: `/xg/student`
- **页面路径**: `views/xg/xsjcxx`（学生基础信息）

### 2. 宿舍管理
- **表命名**: `xg_dorm_*`（校区、楼栋、房间、床位等）
- **权限前缀**: `xg:dorm`
- **API路径**: `/xg/dorm`
- **页面路径**: `views/xg/xgss`（学工宿舍）

### 3. 班级管理
- **表命名**: `xg_class_*`
- **权限前缀**: `xg:class`
- **API路径**: `/xg/class`
- **页面路径**: `views/xg/class`

### 4. 统计分析
- **表命名**: 可直接查询其他表统计
- **权限前缀**: `xg:statistics`
- **API路径**: `/xg/statistics` 或 `/xg/studentStatistics`
- **页面路径**: `views/xg/studentStatistics`

---

## 🔧 常用工具类和方法

### 后端常用工具

**字符串工具 - StringUtils**
```java
import org.dromara.common.core.utils.StringUtils;

StringUtils.isNotBlank(str)     // 判断字符串不为空
StringUtils.isBlank(str)        // 判断字符串为空
StringUtils.isEmpty(str)        // 判断字符串是否为null或空串
```

**对象转换 - MapstructUtils**
```java
import org.dromara.common.core.utils.MapstructUtils;

// BO 转 Entity
XgStudent entity = MapstructUtils.convert(bo, XgStudent.class);

// Entity 转 VO
XgStudentVo vo = MapstructUtils.convert(entity, XgStudentVo.class);

// List 转换
List<XgStudentVo> voList = MapstructUtils.convert(entityList, XgStudentVo.class);
```

**日期工具 - DateUtils**
```java
import org.dromara.common.core.utils.DateUtils;

DateUtils.parseDate(str)        // 解析日期字符串
DateUtils.parseDateToStr(date)  // 日期转字符串
DateUtils.getNowDate()          // 获取当前日期
```

**Excel导出 - ExcelUtil**
```java
import org.dromara.common.excel.utils.ExcelUtil;

ExcelUtil.exportExcel(list, "标题", XgXxxVo.class, response);
```

### 前端常用工具

**日期格式化**
```typescript
import { parseTime } from '@/utils/ruoyi'

parseTime(new Date())           // 格式化日期时间
parseTime(date, '{y}-{m}-{d}')  // 自定义格式
```

**权限判断**
```typescript
import { hasPermi, hasRole } from '@/utils/permission'

hasPermi(['xg:student:edit'])   // 判断是否有权限
hasRole(['admin'])              // 判断是否有角色
```

**字典标签**
```vue
<dict-tag :options="sys_normal_disable" :value="status" />
```

**文件下载**
```typescript
proxy?.$download('api/url', params, 'filename.xlsx')
```

---

## 🚨 注意事项

### 后端开发注意事项

1. **权限注解必须添加**：所有 Controller 方法都必须添加 `@SaCheckPermission` 注解
2. **操作日志记录**：重要操作（增删改）必须添加 `@Log` 注解
3. **防重复提交**：新增/修改操作建议添加 `@RepeatSubmit` 注解
4. **参数校验**：使用 `@Validated` 和校验注解（@NotNull、@NotBlank等）
5. **事务管理**：涉及多表操作的 Service 方法要添加 `@Transactional` 注解
6. **逻辑删除**：删除操作优先使用逻辑删除（delFlag字段）
7. **租户隔离**：继承 `TenantEntity` 实现多租户数据隔离
8. **SQL注入防护**：使用 MyBatis-Plus 的 Wrapper 构建查询条件，避免字符串拼接

### 前端开发注意事项

1. **权限控制**：所有操作按钮必须添加 `v-hasPermi` 指令
2. **表单校验**：表单提交前必须进行前端校验
3. **加载状态**：异步操作要显示 loading 状态
4. **错误处理**：API 调用要用 try-catch 捕获异常
5. **代码规范**：使用 TypeScript，定义好接口类型
6. **组件复用**：相同功能的组件要抽取为公共组件
7. **国际化**：涉及到文本的地方考虑国际化支持
8. **响应式布局**：页面要考虑不同屏幕尺寸的适配

### 学工模块特殊注意

1. **学生隐私保护**：身份证号、手机号等敏感信息需要脱敏处理
2. **数据权限控制**：根据用户角色（辅导员、班主任等）限制数据访问范围
3. **批量操作优化**：大量学生数据的批量导入/导出要考虑性能优化
4. **工作流集成**：涉及审批流程的功能需要集成工作流引擎
5. **数据统计性能**：统计分析功能要注意查询性能，必要时使用缓存

---

## 📚 参考资源

### 官方文档
- **RuoYi-Vue-Plus 文档**: https://plus-doc.dromara.org
- **Vue 3 文档**: https://cn.vuejs.org
- **Element Plus 文档**: https://element-plus.org/zh-CN
- **MyBatis-Plus 文档**: https://baomidou.com
- **Sa-Token 文档**: https://sa-token.cc

### 框架特色功能文档
- **多租户**: https://plus-doc.dromara.org/#/ruoyi-vue-plus/framework/tenant
- **数据权限**: https://plus-doc.dromara.org/#/ruoyi-vue-plus/framework/data_permission
- **数据脱敏**: https://plus-doc.dromara.org/#/ruoyi-vue-plus/framework/sensitive
- **工作流**: https://plus-doc.dromara.org/#/ruoyi-vue-plus/framework/workflow
- **代码生成器**: https://plus-doc.dromara.org/#/ruoyi-vue-plus/other/generator

---

## 🎓 总结

遵循本规范文件，AI可以：
1. **理解项目整体架构**：前后端分离、模块化设计
2. **快速生成标准代码**：Controller、Service、Mapper、Vue页面等
3. **保持代码风格统一**：命名规范、注解使用、权限控制等
4. **处理学工业务场景**：学生管理、宿舍管理、统计分析等
5. **避免常见错误**：权限遗漏、参数校验缺失、SQL注入等

**开发原则**：
- ✅ 代码规范统一
- ✅ 安全性优先
- ✅ 性能优化考虑
- ✅ 用户体验良好
- ✅ 可维护性强

**生成代码时的核心要求**：
1. 严格遵循本文档的命名规范和代码结构
2. 必须包含完整的权限控制和参数校验
3. 前后端接口定义要保持一致
4. 注释要清晰完整
5. 考虑学工业务的特殊性（隐私保护、数据权限等）