unis_crm/backend/README.md

70 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

2026-03-19 06:27:20 +00:00
# Backend
2026-03-20 08:39:07 +00:00
当前已经补齐首页所需的 Java 后端基础工程,并调整为常规 Spring Boot 单体项目目录结构,技术栈如下:
2026-03-19 06:27:20 +00:00
2026-03-20 08:39:07 +00:00
- Java 17
- Spring Boot 3.2.2
- MyBatis Plus 3.5.6
- PostgreSQL
- Redis
## 已实现内容
- 首页聚合接口:`GET /api/dashboard/home`
- 首页欢迎信息:姓名、职位、部门、入职天数
- 首页统计卡片
- 首页待办列表
- 首页最新动态
- 通用响应体与全局异常处理
## 目录结构
2026-03-19 06:27:20 +00:00
```text
backend/
2026-03-20 08:39:07 +00:00
├── pom.xml
└── src/main
├── java/com/unis/crm
│ ├── common
│ ├── controller
│ ├── dto
│ ├── mapper
│ ├── service
│ └── UnisCrmBackendApplication.java
└── resources
├── application.yml
└── mapper/dashboard
2026-03-19 06:27:20 +00:00
```
2026-03-20 08:39:07 +00:00
## 启动前准备
2026-03-27 09:05:41 +00:00
1. 初始化数据库:
2026-03-20 08:39:07 +00:00
```bash
2026-03-27 09:05:41 +00:00
psql -h 127.0.0.1 -U postgres -d nex_auth -f sql/init_full_pg17.sql
2026-03-20 08:39:07 +00:00
```
2026-03-27 09:05:41 +00:00
2. 如果是全新环境,先准备基础框架(`unisbase`)相关表与基础数据,再执行上面的 CRM 脚本。
3. 详细部署顺序见:
- [docs/deployment-guide.md](/Users/kangwenjing/Downloads/crm/unis_crm/docs/deployment-guide.md)
2026-03-20 08:39:07 +00:00
## 启动项目
```bash
cd backend
mvn spring-boot:run
```
2026-03-27 09:05:41 +00:00
默认启动在 `8080` 端口,供前端开发环境通过 Vite 代理访问。
2026-03-20 08:39:07 +00:00
## 首页接口
请求示例:
```bash
2026-03-27 09:05:41 +00:00
curl -H "X-User-Id: 1" "http://127.0.0.1:8080/api/dashboard/home"
2026-03-20 08:39:07 +00:00
```
首页接口只允许查询当前登录用户自己的数据,必须通过 `X-User-Id` 传入当前用户ID不支持指定其他用户查询。