# autothesis **Repository Path**: feng-kailong/autothesis ## Basic Information - **Project Name**: autothesis - **Description**: autoThesis自动论文生成工具 - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 1 - **Forks**: 0 - **Created**: 2026-04-14 - **Last Updated**: 2026-09-30 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # AutoThesis 面向毕业设计与课程项目的一站式工作台:按模板生成 Word 论文、按章节降重润色,并基于 Spring Boot + Vue 模板用 AI 辅助生成可预览的前后端项目。 仓库为多应用结构,包含用户前台、管理后台、Spring Boot 后端,以及首页介绍视频工程。 ## 功能概览 | 能力 | 说明 | |------|------| | 论文生成 | 模板 + 大纲驱动,AI 撰写正文;支持技术介绍、需求分析、流程/架构/ER/表设计、系统实现、功能测试、参考文献等专项章节;下单支付后经 Redis Stream 异步执行,WebSocket 推送进度 | | 论文降重 | 原文粘贴或 Word 上传,可按章节排除;对接 Bypass AIGC 服务,按字数计费 | | 项目生成 | 当前模板类型为 `springboot_vue`;远程 OpenCode 会话编码、多 Session 聊天、预览;创建/启动/删除按类型 Helper 拆分,可挂载中间件(如 MySQL) | | 模板广场 | 公开论文模板与项目模板,支持浏览详情并加入「我的模板」 | | 一键部署包 | 按 Windows / Linux / macOS 打包:初始化库、前后端构建、捆绑 JDK、生成启动脚本,SSE 推送进度 | | 订单与积分 | 论文生成、项目生成、论文降重、积分充值;支付宝(沙箱可模拟成功)、积分支付;微信收款接口未实现 | | 通知 | 站内、邮件、短信、电话、钉钉等渠道;业务覆盖论文/项目生成、降重、部署包、退款 | | 管理后台 | 全量订单、退款审核、价格、资源(如各 OS 的 JDK)、前台用户、公开模板审核 | 论文生成接口 `POST /paperGeneration/generate` 在控制器层已关闭,实际路径为:**下单 → 支付成功 → MQ 消费 → 生成**。项目会话的关闭/完成同样走订单支付后的 Service,而不是直接开放的 HTTP 入口。 ## 技术栈 | 层级 | 选型 | |------|------| | 前端 | Vue 3、TypeScript、Vite、Vue Router、Pinia、Element Plus、ECharts、docx-preview | | 后端 | Java 21、Spring Boot 3.2、Spring Validation / WebSocket / Mail / AOP | | 数据访问 | MyBatis-Plus、MySQL 8 | | 缓存 / 会话 / 队列 | Redis(Sa-Token 会话、Lettuce 连接池、Redis Stream 作为内部 MQ) | | 鉴权 | Sa-Token(Token 名 `autoThesis`) | | 对象存储 | MinIO | | 文档与图 | Apache POI(Word)、PlantUML、Batik、JFreeSVG | | AI | DeepSeek Chat、阿里云通义千问多模态 | | 项目生成执行 | SSH(或本机)调用 OpenCode;成果可推 Gitee | | 支付 | 支付宝开放平台 SDK;积分支付 | | 通知 | 邮件、阿里云短信、钉钉 | | 介绍视频 | Remotion 4 + React 19 | 仓库内**未发现** Docker / docker-compose / 完整建库脚本。`autoThesis-back/src/main/resources/sql/` 仅有部分增量表结构,完整库表需自行对齐现有实体或从已有环境导出。 ## 架构概览 ```mermaid flowchart LR subgraph clients [客户端] Front["autoThesis-front\n用户前台 / 管理后台"] Video["autoThesis-intro-video\n首页介绍片"] end subgraph backend [autoThesis-back] API["HTTP /api/v1"] WS["WebSocket"] SSE["SSE 进度"] MQ["Redis Stream MQ"] API --> SVC["Service / Helper / Factory"] WS --> SVC SSE --> SVC MQ --> SVC end Front -->|代理 /api/v1| API Front --> WS Front --> SSE SVC --> MySQL[(MySQL)] SVC --> Redis[(Redis)] SVC --> MinIO[(MinIO)] SVC --> AI["DeepSeek / 通义千问"] SVC --> OpenCode["OpenCode 执行机"] SVC --> Git["Gitee"] SVC --> Pay["支付宝"] SVC --> Bypass["Bypass AIGC 降重"] SVC --> Notice["邮件 / 短信 / 钉钉"] ``` 后端分层大致为:`controller` → `service` → `mapper` / 外部 SDK。项目模板按**类型大拆分、系统小拆分**,用 Factory 选择 Helper(创建、启动、删除、部署、中间件)。 鉴权要点(见 `SaTokenConfigure`): - `/auth/**`、部分 `/admin/auth/**`、参考文献回调无需前台登录 - `/admin/**` 要求管理员 loginId - 其余业务接口要求前台用户登录 - SSE(上传进度、部署包进度)因 `EventSource` 无法自定义 Header,用 query 参数 `autoThesis` 传 Token ## 仓库结构 | 路径 | 职责 | |------|------| | `autoThesis-front/` | 用户前台与管理后台,Vite + Vue 3 | | `autoThesis-back/` | 业务 API、异步生成、支付、通知、模板与部署 | | `autoThesis-intro-video/` | 首页介绍视频(Remotion),独立运行 | | `docs/` | 流程图、海报与部署设计说明 | | `TODO.md` | 历史待办与规划(部分条目可能已落后于当前代码) | | `下一步计划.txt` | 近期产品方向备忘 | ### 后端主要包 | 路径 | 职责 | |------|------| | `controller/`、`admin/controller/` | 前台 / 后台 HTTP 入口 | | `service/`、`service/impl/` | 业务实现;论文专项在 `paperSpecial/` | | `service/impl/project/template/` | 模板创建、删除、部署(按类型 / OS) | | `service/impl/project/generation/` | 项目生成会话、OpenCode、消息 | | `service/impl/project/middleware/` | 模板中间件(如 MySQL) | | `service/payment/` | 下单处理器与支付渠道 | | `service/websocket/` | 论文 / 项目生成实时通道 | | `mq/` | Redis Stream 生产与消费 | | `mapper/`、`admin/mapper/` | MyBatis-Plus Mapper | | `entity/`、`request/`、`response/`、`dto/` | 模型与传输对象 | | `config/` | 数据源、MinIO、Sa-Token、WebSocket、支付等配置绑定 | ### 前端主要目录 | 路径 | 职责 | |------|------| | `src/views/` | 页面:首页、论文/项目/降重、模板、订单、积分、通知 | | `src/views/admin/` | 管理后台 | | `src/api.ts`、`src/adminApi.ts` | 前台 / 后台 HTTP | | `src/api/uploadSse.ts`、`src/api/deployPackageSse.ts` | SSE | | `src/router/index.ts` | 路由与登录守卫 | | `src/components/` | 格式配置、通知列表、上传等 | ## 功能与代码位置 | 功能 | 前台路由 | 主要后端入口 | 说明 | |------|----------|--------------|------| | 首页 | `/` | `GET /common/priceConfig` 等 | `IndexView.vue` | | 登录注册 | `/login` | `/auth/login`、`/auth/register`、`/auth/captcha` | Token 写入 `localStorage` | | 论文生成 | `/generate-thesis` | `/paperGeneration`、`/paperTemplate` | 进度:`/websocket/paper/generate/{token}` | | 论文降重 | `/reduce-similarity` | `/paperWeightReduction` | 对接 `bypass-aigc` | | 项目生成 | `/generate-project` | `/projectGeneration`、`/projectTemplate` | 进度:`/websocket/project/generate/{token}` | | 论文模板 / 广场 | `/thesis-templates` | `/paperTemplate`、`/resourcePaperTemplate` | 广场详情带 `resourceId` | | 项目模板广场 | `/generate-project/square/:resourceId` | `/resourceProjectTemplate` | 加入我的模板 | | 一键部署包 | 项目生成页内 | `/projectTemplate/deployPackage` | SSE:`/projectTemplate/deployPackage/progress/{id}` | | 订单 / 退款 | `/orders` | `/orders`、`/ordersRefund` | 支付宝 / 积分 | | 积分 | `/my-points` | `/userPoints` | 含充值下单 | | 通知 | `/site-notices`、`/notice-config` | `/notice/message`、`/notice/userConfig` | 未读轮询约 3s | | 管理后台 | `/admin/*` | `/admin/**` | 独立 `adminToken` | 论文专项章节类型见 `PaperSpecialConfigTypeEnums`:技术介绍、需求/功能分析、流程分析、系统模块/架构设计、ER 图、数据表设计、系统实现、功能测试、参考文献。 ## 本地运行 ### 前置条件 - JDK 21、Maven - Node.js(建议 LTS)与 npm - MySQL 8、Redis、MinIO - 项目生成:可 SSH 的 Linux 执行机,并安装 [OpenCode](https://opencode.ai/)(`project-generation.call.type` 也可改为 `local`) - 可选:DeepSeek / 通义千问 Key、Gitee Token、支付宝沙箱、阿里云短信、Bypass AIGC、SMTP ### 1. 后端 编辑 `autoThesis-back/src/main/resources/application-dev.yml`(当前默认 `spring.profiles.active=dev`),至少配置: | 配置前缀 | 用途 | |----------|------| | `spring.datasource.*` | MySQL | | `spring.data.redis.*` | Redis | | `minio.*` | 对象存储 | | `ai.deepseek.*` / `ai.ali.*` | 论文与多模态 | | `project-generation.*` | OpenCode 调用方式与 SSH | | `gitee.*` | 模板仓库推送 | | `myserver.*` | 远程工作目录、Nginx、下载地址 | | `bypass-aigc.*` | 降重服务 | | `pay.alipay.*` | 支付宝 | | `spring.mail.*` | 邮件通知 | **不要把真实密钥提交到公开仓库。** 仓库内现有 yml 含环境凭据,本地请改为自己的值。 ```bash cd autoThesis-back mvn spring-boot:run ``` - 服务:`http://localhost:8000` - 上下文:`/api/v1` - 例:`http://localhost:8000/api/v1/auth/captcha` - 已引入 springdoc,具体 UI 路径以启动日志为准(仓库内未单独配置 path) ### 2. 前端 开发时代理已写在 `autoThesis-front/vite.config.ts`:`/api/v1` → `http://localhost:8000`(含 WebSocket)。 ```bash cd autoThesis-front npm install npm run dev ``` 浏览器打开 Vite 提示的本地地址(未指定 port 时一般为 `http://localhost:5173`)。 - 用户前台:`/`(首页无需登录;其余业务页需 Token) - 管理后台:`/admin/login` 生产构建可用 `VITE_HTTP_PREFIX` 指定 API 前缀;`BASE_PATH` 控制 Vite `base`。 ```bash npm run build ``` ### 3. 介绍视频(可选) 见 [autoThesis-intro-video/README.md](autoThesis-intro-video/README.md)。 ```bash cd autoThesis-intro-video npm install npm start # Remotion Studio npm run build # 输出 out/autothesis-intro.mp4 ``` ### 验证 1. 打开首页,未登录可浏览介绍;登录后可见价格表与模板广场预览。 2. `GET /api/v1/auth/captcha` 应返回图形验证码。 3. 注册 / 登录后进入「论文生成」「项目生成」等菜单。 4. 管理端使用另一套账号,Token 键为 `adminToken`。 ### 常见问题 - **跨域 / 接口 404**:确认前端走 `/api/v1` 代理,后端 `context-path` 为 `/api/v1`,端口 8000。 - **SSE 未登录**:进度 URL 需带 query `autoThesis=`。 - **项目生成连不上执行机**:检查 `project-generation.call.type`(`ssh` / `local`)及 SSH、OpenCode 路径。 - **微信支付**:`WeixinPaymentServiceImpl` 会直接提示「微信支付暂未实现」。 - **完整建库 SQL**:仓库仅有增量脚本,需自行准备 schema。 - **Windows 路径**:后端会 SSH 到 Linux 做 clone / 打包;本机 Windows 主要跑 API 与前端。 ## 主要 HTTP 前缀 实际 URL = `http://localhost:8000/api/v1` + 下表路径。 | 前缀 | 模块 | |------|------| | `/auth` | 登录注册、验证码 | | `/user`、`/userPoints` | 当前用户、积分 | | `/paperTemplate`、`/paperTemplateResource`、`/paperGeneration` | 论文模板与生成 | | `/paperWeightReduction` | 论文降重 | | `/projectTemplate`、`/projectTemplateResource`、`/projectTemplateDeploy` | 项目模板与部署 | | `/projectGeneration`、`/projectGenerationMessage`、`/projectGenerationConfig` | 项目生成会话 | | `/resourcePaperTemplate`、`/resourceProjectTemplate` | 模板广场 | | `/orders`、`/ordersRefund` | 订单与退款 | | `/notice/message`、`/notice/userConfig` | 通知 | | `/common` | 枚举、上传、价格配置 | | `/admin/*` | 管理后台 | WebSocket(同样带 context-path): - `/api/v1/websocket/paper/generate/{token}` - `/api/v1/websocket/project/generate/{token}` ## 延伸阅读 - [TODO.md](TODO.md) — 待办与能力对照(2026-05-25 梳理,请以代码为准) - [docs/1.1 一键部署包:Mac-Linux.md](docs/1.1%20一键部署包:Mac-Linux.md) — 部署包设计说明 - [docs/paper-generation-flow.png](docs/paper-generation-flow.png) — 论文生成流程 - [autoThesis-intro-video/README.md](autoThesis-intro-video/README.md) — 介绍视频 ## 许可 仓库内未发现 `LICENSE` 文件。对外分发前请补充许可证并确认第三方依赖条款。