|
|
3 weeks ago | |
|---|---|---|
| backend-infra | 2 months ago | |
| changes | 1 month ago | |
| docs | 3 weeks ago | |
| mydreamjob-server | 3 weeks ago | |
| product-docs | 2 months ago | |
| scripts | 1 month ago | |
| specs | 1 month ago | |
| xlsx-analysis | 2 months ago | |
| .gitignore | 2 months ago | |
| README.md | 1 month ago | |
README.md
职来(mydreamjob)
职来是一个面向求职者、企业和平台运营方的 AI 求职招聘平台。本仓库是职来项目的后端与工程协作仓库,不包含“青核校园”React Native 项目。
当前交付基线
| 项目 | 当前状态 |
|---|---|
| Git 检查点 | N07 消息撤回,277b3c0(已合并到本地 master) |
| 数据库迁移 | Flyway V1–V41;N02/V43 未新增迁移 |
| API 契约 | 173 paths / 211 operations |
| 自动化测试 | 1601 个通过,0 失败,0 错误,0 跳过(以 mvn clean verify 为准) |
| 已交付范围 | V39 岗位推荐、V40 企业评价回复、V41 企业人才发现、V42 企业人才邀约、V43 公平性监测、N02/V44 评分规则解释、N07 消息撤回 |
| 账号注销冷静期 | 30 天 |
| 本地服务端口 | 8080 |
各版本的真实 MySQL/Docker 验收状态以 docs/ 下对应验收报告为准;未完成独立验收的功能不得视为生产冻结。
仓库结构
zhilai/
├─ mydreamjob-server/ Spring Boot 后端源码、测试、Flyway 迁移
├─ backend-infra/ Docker Compose 基础设施(MySQL、Redis、RabbitMQ)
├─ docs/ 正式接口、OpenAPI、路线图和验收文档
├─ product-docs/ 产品方案、功能设计、UI 规范和架构资料
├─ scripts/ 通用验收、调试和文档处理脚本
├─ xlsx-analysis/ 产品功能表分析工具及其输出
└─ docx_qa/ 文档质量检查输出目录
docs/ 是项目唯一正式的接口与验收文档目录。mydreamjob-server/docs/ 仅保留后端内部说明或迁移说明,不作为对外接口文档入口。
技术栈
- Java 17
- Spring Boot 3.5.16
- Spring MVC、Spring Security、Spring Data JPA/Hibernate
- MySQL 8.4、Flyway 11、Redis 7.4、RabbitMQ 3.13
- Maven
- JUnit、Mockito、MockMvc、H2(
MODE=MySQL集成测试) - SpringDoc OpenAPI 3
环境准备
开发机需要安装并可在终端使用:
java -version
mvn -version
docker --version
docker compose version
python --version
后端启动需要数据库、Redis、RabbitMQ 和 JWT 等配置。请使用团队已有的安全配置或 IntelliJ IDEA Run Configuration 注入环境变量,例如 DB_PASSWORD、RABBITMQ_USERNAME、RABBITMQ_PASSWORD、JWT_SECRET。不要把真实凭据写入 README、脚本、日志或 Git。
启动基础设施
在 PowerShell 中执行:
cd C:\Users\15642\Desktop\zhilai\backend-infra
docker compose --env-file .env up -d
docker compose ps
确认 mydreamjob-mysql、mydreamjob-redis 和 mydreamjob-rabbitmq 均处于 healthy 或可用状态后,再启动后端。.env 只用于本机,不应提交到仓库。
启动后端
构建并验证
cd C:\Users\15642\Desktop\zhilai\mydreamjob-server
mvn clean verify
使用最新 JAR 启动
请先在 IntelliJ IDEA 或当前 PowerShell 会话中注入安全环境变量,然后执行:
cd C:\Users\15642\Desktop\zhilai\mydreamjob-server
java -jar .\target\mydreamjob-server-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev
成功启动后,使用另一个终端检查健康状态:
Invoke-RestMethod "http://127.0.0.1:8080/api/v1/health" | ConvertTo-Json -Depth 5
预期返回 code=200 且 data.status=UP。启动日志中的 Flyway、数据库连接或消息队列错误必须在进入联调前处理。
测试与接口校验
后端源码目录下执行:
cd C:\Users\15642\Desktop\zhilai\mydreamjob-server
# 快速回归
mvn test
# 发布前完整验证(包含 clean、编译、测试和打包)
mvn clean verify
仓库根目录执行 OpenAPI 静态契约检查:
cd C:\Users\15642\Desktop\zhilai
python .\docs\verify_openapi.py
发布检查点至少应满足:测试无失败、OpenAPI 校验通过、运行时与静态契约一致、没有未经说明的数据库写入或敏感信息泄露。
接口文档与前端联调
正式接口入口:
- OpenAPI 契约
- 前端联调说明
- 后端开发路线图
- 岗位推荐
- 企业人才发现
- 企业人才邀约
- 候选评分与规则解释
- 评分公平性监测
- 消息撤回与会话一致性
- 统一求职进度接口
- 同岗位竞争力排名
- 举报与屏蔽
- 结构化面试评分
- 个人数据导出
- 账号注销
- 隐私设置
本地联调的 API Base URL 为:
http://127.0.0.1:8080/api/v1
如果使用 ngrok 等内网穿透工具,前端和 Apifox 的 Base URL 统一替换为隧道地址,例如:
https://<public-tunnel-domain>/api/v1
需要认证的接口使用 Authorization: Bearer <access-token>。测试 Token、短信验证码和内网穿透地址不要写入提交文件或公开文档。
开发约定
每个新模块按以下顺序交付:
- 核对产品需求、现有实体、权限和接口语义。
- 先完成独立设计并确认边界,再开始编码。
- 实现 DTO、Controller、Service、Repository 和必要迁移。
- 补齐单元测试、MockMvc 测试和 H2 持久化测试。
- 执行
mvn test、mvn clean verify和 OpenAPI 校验。 - 使用最新 JAR 进行 MySQL/Docker 黑盒验收。
- 通过验收后建立精确的 Git 检查点,再进入下一个模块。
提交前应使用精确文件清单执行 git add,避免使用 git add -A 将运行产物一并提交。共享接口或迁移文件发生冲突时,先同步基线并重新验证,不直接覆盖他人改动。
数据与安全边界
- 不提交
.env、Token、密码、私钥、日志、数据库转储、导出文件和临时验收产物。 - 不在审计日志、错误响应或导出文件中写入密码、JWT、验证码、手机号、邮箱等不必要的敏感信息。
- 测试和黑盒验收不得删除真实业务数据;需要构造数据时使用独立测试账号并记录影响范围。
- 未经明确授权,不启动或停止 Docker,不修改已验收接口语义,不修改历史 Flyway 迁移。
- 账号注销采用 30 天冷静期;业务数据保留,仅按既定策略处理用户 PII。
相关项目边界
“青核校园”React Native 项目位于:
C:\Users\15642\Desktop\青核\collegeCli
青核项目不属于本仓库,禁止将其源代码提交到职来仓库。