208 lines
5.6 KiB
Markdown
208 lines
5.6 KiB
Markdown
# 平台更新内容功能说明
|
||
|
||
## 📋 功能概述
|
||
|
||
该平台更新内容功能用于在官网首页展示平台的近期更新记录，包括更新日期、标题和内容详情。
|
||
|
||
## 🗂️ 文件清单
|
||
|
||
### 后端文件
|
||
1. **模型**: `go/models/platform_upgrade.go`
|
||
- 定义平台更新记录的数据结构
|
||
|
||
2. **控制器**: `go/controllers/api_platform_upgrade.go`
|
||
- `/api/platform/upgrade/list` - 获取更新列表
|
||
- `/api/platform/upgrade/detail` - 获取单条详情
|
||
|
||
3. **路由**: `go/routers/api/api.go`
|
||
- 已注册 API 路由
|
||
|
||
### 前端文件
|
||
1. **官网首页组件**: `website/src/views/home/components/ScheduleSection.vue`
|
||
- 展示平台更新时间轴
|
||
- 自动从后端 API 获取数据
|
||
|
||
2. **管理平台页面**: `platform/src/views/platform/platformupgrade/index.vue`
|
||
- 更新内容的增删改查管理界面
|
||
|
||
### 数据库
|
||
1. **SQL 脚本**: `docs/sql/platform_upgrade.sql`
|
||
- 建表语句
|
||
- 示例数据
|
||
|
||
## 🚀 使用步骤
|
||
|
||
### 1. 执行 SQL 脚本
|
||
|
||
在数据库中执行以下 SQL 文件创建表结构：
|
||
|
||
```bash
|
||
# 路径：docs/sql/platform_upgrade.sql
|
||
```
|
||
|
||
该脚本会：
|
||
- 创建 `yz_platform_upgrade` 表
|
||
- 插入 3 条示例数据（可选）
|
||
|
||
**表结构说明**:
|
||
```sql
|
||
CREATE TABLE `yz_platform_upgrade` (
|
||
`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
|
||
`tenant_id` varchar(64) NOT NULL DEFAULT '', -- 租户 ID（空表示全局）
|
||
`update_date` varchar(20) NOT NULL DEFAULT '', -- 更新日期 YYYY-MM-DD
|
||
`title` varchar(255) NOT NULL DEFAULT '', -- 更新标题
|
||
`content` text, -- 更新内容（支持 HTML）
|
||
`sort` int(11) NOT NULL DEFAULT '0', -- 排序权重（越大越靠前）
|
||
`status` tinyint(4) NOT NULL DEFAULT '1', -- 状态：0-隐藏 1-显示
|
||
`create_user_id` varchar(64) NOT NULL DEFAULT '', -- 创建人 ID
|
||
`create_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
|
||
`update_time` datetime DEFAULT NULL,
|
||
`delete_time` datetime DEFAULT NULL, -- 软删除时间
|
||
PRIMARY KEY (`id`)
|
||
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
|
||
```
|
||
|
||
### 2. 重启后端服务
|
||
|
||
确保后端服务重新加载，注册新的路由：
|
||
|
||
```bash
|
||
cd go
|
||
# 如果是开发环境
|
||
bee run
|
||
|
||
# 如果是生产环境
|
||
./main
|
||
```
|
||
|
||
### 3. 配置菜单权限（可选）
|
||
|
||
如需在后台管理系统中访问"更新管理"页面，需要配置菜单权限：
|
||
|
||
**菜单配置**:
|
||
- 菜单名称：更新管理
|
||
- 路由地址：/platform/platformupgrade
|
||
- 组件路径：platform/platformupgrade
|
||
- 是否显示：是
|
||
- 排序：根据实际需要设置
|
||
|
||
### 4. 测试功能
|
||
|
||
#### 4.1 查看官网首页展示
|
||
|
||
访问官网首页，滚动到"近期平台更新内容"区域，应该能看到从数据库读取的更新记录。
|
||
|
||
#### 4.2 后台管理
|
||
|
||
访问 `http://localhost:端口/platform/platformupgrade`（具体端口根据实际情况），可以：
|
||
- 新增更新内容
|
||
- 编辑已有内容
|
||
- 删除更新记录
|
||
- 调整排序和显示状态
|
||
|
||
#### 4.3 API 接口测试
|
||
|
||
**获取更新列表**:
|
||
```bash
|
||
curl http://localhost:端口/api/platform/upgrade/list?limit=10
|
||
```
|
||
|
||
**获取单条详情**:
|
||
```bash
|
||
curl http://localhost:端口/api/platform/upgrade/detail?id=1
|
||
```
|
||
|
||
**预期响应**:
|
||
```json
|
||
{
|
||
"code": 200,
|
||
"msg": "success",
|
||
"data": [
|
||
{
|
||
"id": 1,
|
||
"update_date": "2026-09-18",
|
||
"title": "平台 V3.0 版本发布",
|
||
"content": "<h3>🎉 核心功能更新</h3>...",
|
||
"create_time": "2026-09-18 10:00:00"
|
||
}
|
||
]
|
||
}
|
||
```
|
||
|
||
## 📝 数据维护建议
|
||
|
||
### 添加新更新记录
|
||
|
||
1. 通过后台管理界面点击"新增更新内容"
|
||
2. 填写以下信息：
|
||
- **更新日期**: 选择发布日期
|
||
- **标题**: 简明扼要地描述更新主题
|
||
- **更新内容**: 详细描述更新内容，支持 HTML 格式
|
||
- **排序**: 数值越大越靠前显示
|
||
- **状态**: 选择显示或隐藏
|
||
|
||
### 更新内容格式建议
|
||
|
||
推荐使用 HTML 格式，示例：
|
||
|
||
```html
|
||
<h3>🎉 核心功能更新</h3>
|
||
<ul>
|
||
<li><strong>CRM 模块增强</strong>: 新增上下游项目金额拆分管理</li>
|
||
<li><strong>回款精细化管理</strong>: 支持多种回款周期类型</li>
|
||
</ul>
|
||
|
||
<h3>💡 体验优化</h3>
|
||
<ul>
|
||
<li>移动端全面适配</li>
|
||
<li>性能优化，加载速度提升 50%</li>
|
||
</ul>
|
||
```
|
||
|
||
### 删除记录
|
||
|
||
建议使用"隐藏"状态而非直接删除，保留历史记录便于追溯。如需彻底删除，请在后台管理中操作。
|
||
|
||
## 🔧 常见问题
|
||
|
||
### Q1: 官网首页没有显示更新内容？
|
||
|
||
**检查项**:
|
||
1. 确认数据库表已创建且包含数据
|
||
2. 确认 `status = 1`（显示状态）
|
||
3. 检查浏览器控制台是否有 API 请求错误
|
||
4. 确认后端服务已重启并正确注册路由
|
||
|
||
### Q2: 如何自定义显示数量？
|
||
|
||
修改 `ScheduleSection.vue` 中的 API 调用参数：
|
||
|
||
```javascript
|
||
const response = await fetch('/api/platform/upgrade/list?limit=20');
|
||
```
|
||
|
||
或在后端控制器的 `List()` 方法中调整默认值。
|
||
|
||
### Q3: 能否按租户隔离显示？
|
||
|
||
当前设计为全局显示（`tenant_id` 为空）。如需按租户隔离，可：
|
||
1. 在查询时增加租户过滤条件
|
||
2. 在前端传递租户 ID 参数
|
||
3. 修改控制器逻辑
|
||
|
||
## 📊 扩展功能建议
|
||
|
||
1. **版本对比**: 增加版本号字段，支持版本对比
|
||
2. **附件下载**: 支持上传更新相关的附件（如安装包）
|
||
3. **分类标签**: 增加功能分类（如 CRM/OA/ERP/CMS）
|
||
4. **统计功能**: 记录每条更新的阅读量、点赞数等
|
||
5. **推送通知**: 更新时通过邮件/短信通知用户
|
||
|
||
## 📞 技术支持
|
||
|
||
如有问题，请联系开发团队或查看项目文档。
|
||
|
||
---
|
||
|
||
**最后更新**: 2026-09-18
|