Files
niumalll/backend/CLEANUP_GUIDE.md

123 lines
3.1 KiB
Markdown
Raw Normal View History

# 活牛采购系统 - 后端文件清理指南
## 概述
本指南用于清理后端项目中不需要的文件和依赖以优化生产环境部署。根据系统需求我们将移除与Redis和RabbitMQ相关的文件和配置。
## 需要清理的文件和依赖
### 1. 移除Redis相关依赖
`package.json`文件中我们需要删除Redis相关的依赖
```javascript
// 移除前
"dependencies": {
// ...其他依赖
"redis": "^4.6.7",
// ...其他依赖
}
// 移除后
"dependencies": {
// ...其他依赖不包含redis
}
```
### 2. 移除Redis相关配置
在代码中我们需要删除任何与Redis相关的导入和使用
```bash
# 查找并删除代码中的Redis相关引用
# 在项目根目录下执行
find . -type f -name "*.js" | xargs grep -l "redis" | xargs sed -i '' '/redis/d'
```
### 3. 其他可能需要删除的文件
根据项目实际情况,以下是可能需要删除的文件:
- 测试文件和测试相关配置(如果不需要在生产环境中保留)
- 开发环境专用的配置文件
- 文档文件(如果不需要在生产环境中保留)
- 临时文件和日志文件
## 清理步骤
### 1. 删除Redis依赖
在本地项目目录中执行:
```bash
npm uninstall redis
```
### 2. 查找并清理Redis相关代码
使用以下命令查找所有包含Redis引用的文件
```bash
# Linux/Mac系统
grep -r "redis" . --include="*.js"
# Windows系统PowerShell
Get-ChildItem -Recurse -Include *.js | Select-String -Pattern "redis"
```
找到包含Redis引用的文件后手动编辑这些文件删除Redis相关的代码。
### 3. 删除其他不需要的文件
根据项目需求,删除不需要的文件:
```bash
# 删除测试目录(如果有)
rm -rf tests/
# 删除开发环境专用配置
rm -f .env.development
# 删除临时文件
rm -rf temp/
# 删除不必要的日志文件
rm -f logs/*.log
```
### 4. 更新.env文件
确保.env文件中不包含Redis相关配置
```ini
# 已在之前的步骤中更新,确保没有以下配置
# REDIS_HOST=localhost
# REDIS_PORT=6379
# REDIS_PASSWORD=
```
### 5. 更新models/index.js
确保数据库连接中没有Redis相关配置
```javascript
// 已更新确保没有Redis相关代码
```
### 6. 重新安装依赖
在清理完不必要的文件和依赖后,重新安装项目依赖:
```bash
rm -rf node_modules/
rm -f package-lock.json
npm install --production
```
## 生产环境部署前检查清单
在部署到生产环境前,请确保:
- [ ] Redis相关依赖已删除
- [ ] Redis相关配置已删除
- [ ] 没有使用RabbitMQ相关功能
- [ ] 数据库连接配置正确使用生产环境MySQL
- [ ] 端口配置为4330
- [ ] NODE_ENV设置为production
- [ ] Swagger文档功能在生产环境中保持启用
- [ ] PM2配置正确ecosystem.config.js
- [ ] Nginx配置正确包含SSL配置
## 注意事项
1. 在执行任何删除操作前,请确保已备份重要文件。
2. 清理完成后,请在测试环境中验证系统功能是否正常。
3. 如果在清理过程中遇到问题,请参考项目文档或联系技术支持。