优化cursor使用形式，增加项目文档过程管理，方便cursor生成代码

2025-06-28 09:48:53 +08:00
1 parent 2f7e1a9c16
commit 65d2d71469
@@ -0,0 +1,220 @@
+# 中间件配置文档
+
+## 目录说明
+
+此目录用于存放项目使用的各种中间件配置文档和最佳实践。
+
+## 1. 数据库配置
+
+### MySQL配置
+- **mysql-config.md**：MySQL数据库配置和优化
+- **mysql-cluster.md**：MySQL集群部署方案
+- **mysql-backup.md**：MySQL备份和恢复策略
+- **mysql-monitor.md**：MySQL监控和性能调优
+
+### 多数据库支持
+- **oracle-config.md**：Oracle数据库配置
+- **postgresql-config.md**：PostgreSQL数据库配置
+- **sqlserver-config.md**：SQL Server数据库配置
+
+### 配置示例：
+```yaml
+# MySQL开发环境配置示例
+spring:
+  datasource:
+    dynamic:
+      primary: master
+      datasource:
+        master:
+          url: jdbc:mysql://localhost:3306/ruoyi?useUnicode=true&characterEncoding=utf8
+          username: root  
+          password: password
+          driver-class-name: com.mysql.cj.jdbc.Driver
+```
+
+## 2. Redis配置
+
+### Redis部署
+- **redis-standalone.md**：Redis单机部署配置
+- **redis-cluster.md**：Redis集群部署配置
+- **redis-sentinel.md**：Redis哨兵模式配置
+- **redis-optimize.md**：Redis性能优化
+
+### Redisson配置
+- **redisson-config.md**：Redisson客户端配置
+- **redisson-lock.md**：分布式锁配置
+- **redisson-cache.md**：缓存配置
+
+### 配置示例：
+```yaml
+# Redis配置示例
+spring:
+  data:
+    redis:
+      host: localhost
+      port: 6379
+      database: 0
+      password: password
+      timeout: 10s
+```
+
+## 3. 消息中间件配置
+
+### RabbitMQ配置
+- **rabbitmq-install.md**：RabbitMQ安装和配置
+- **rabbitmq-cluster.md**：RabbitMQ集群配置
+- **rabbitmq-monitor.md**：RabbitMQ监控配置
+
+### RocketMQ配置
+- **rocketmq-install.md**：RocketMQ安装和配置
+- **rocketmq-cluster.md**：RocketMQ集群配置
+
+### Kafka配置
+- **kafka-install.md**：Kafka安装和配置
+- **kafka-cluster.md**：Kafka集群配置
+
+## 4. 监控组件配置
+
+### Spring Boot Admin
+- **spring-boot-admin.md**：服务监控配置
+- **admin-security.md**：监控安全配置
+
+### Prometheus + Grafana
+- **prometheus-config.md**：Prometheus监控配置
+- **grafana-dashboard.md**：Grafana仪表板配置
+
+### ELK Stack
+- **elasticsearch-config.md**：Elasticsearch配置
+- **logstash-config.md**：Logstash日志收集配置
+- **kibana-config.md**：Kibana日志分析配置
+
+## 5. 反向代理和负载均衡
+
+### Nginx配置
+- **nginx-install.md**：Nginx安装和基础配置
+- **nginx-load-balance.md**：负载均衡配置
+- **nginx-ssl.md**：SSL证书配置
+- **nginx-cache.md**：静态资源缓存配置
+
+### 配置示例：
+```nginx
+# Nginx负载均衡配置示例
+upstream backend {
+    server 127.0.0.1:8080 weight=1;
+    server 127.0.0.1:8081 weight=1;
+}
+
+server {
+    listen 80;
+    server_name your-domain.com;
+    
+    location / {
+        proxy_pass http://backend;
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+    }
+}
+```
+
+## 6. 存储服务配置
+
+### MinIO配置
+- **minio-install.md**：MinIO安装和配置
+- **minio-cluster.md**：MinIO集群配置
+- **minio-backup.md**：MinIO备份策略
+
+### 其他存储
+- **aliyun-oss.md**：阿里云OSS配置
+- **qiniu-cloud.md**：七牛云存储配置
+- **tencent-cos.md**：腾讯云COS配置
+
+## 7. 短信和邮件服务
+
+### 短信服务配置
+- **aliyun-sms.md**：阿里云短信服务配置
+- **tencent-sms.md**：腾讯云短信服务配置
+- **sms4j-config.md**：短信融合包配置
+
+### 邮件服务配置
+- **email-config.md**：邮件服务配置
+- **email-template.md**：邮件模板配置
+
+## 8. 安全组件配置
+
+### Sa-Token配置
+- **satoken-config.md**：Sa-Token权限配置
+- **satoken-jwt.md**：JWT配置
+- **satoken-sso.md**：单点登录配置
+
+### 第三方认证
+- **oauth2-config.md**：OAuth2认证配置
+- **ldap-config.md**：LDAP认证配置
+
+## 环境配置
+
+### 开发环境
+- **dev-environment.md**：开发环境搭建指南
+- **docker-compose-dev.yml**：开发环境Docker配置
+
+### 测试环境  
+- **test-environment.md**：测试环境配置
+- **docker-compose-test.yml**：测试环境Docker配置
+
+### 生产环境
+- **prod-environment.md**：生产环境配置
+- **docker-compose-prod.yml**：生产环境Docker配置
+- **k8s-deployment.md**：Kubernetes部署配置
+
+## 配置管理规范
+
+### 配置原则
+1. **环境隔离**：不同环境使用不同配置
+2. **安全优先**：敏感信息加密存储
+3. **版本控制**：配置变更进行版本管理
+4. **监控告警**：关键配置项设置监控
+
+### 配置规范
+- 使用配置中心统一管理
+- 敏感信息不直接写在配置文件中
+- 配置变更需要审核流程
+- 定期备份配置文件
+
+### 密码管理
+- 数据库密码定期更换
+- Redis密码必须设置
+- 中间件默认密码必须修改
+- 生产环境密码复杂度要求
+
+## 性能调优
+
+### JVM调优
+- **jvm-config.md**：JVM参数配置和调优
+- **gc-config.md**：垃圾回收器配置
+
+### 数据库调优
+- 连接池参数优化
+- SQL语句性能优化
+- 索引设计优化
+
+### 缓存调优
+- Redis内存使用优化
+- 缓存过期策略优化
+- 缓存穿透防护
+
+## 故障排查
+
+### 常见问题
+- **common-issues.md**：常见问题和解决方案
+- **troubleshooting.md**：故障排查手册
+- **performance-issues.md**：性能问题排查
+
+### 日志分析
+- **log-analysis.md**：日志分析方法
+- **error-handling.md**：错误处理规范
+
+## 注意事项
+
+1. 所有中间件密码必须设置且定期更换
+2. 生产环境配置需要经过安全审核
+3. 配置变更需要备份和回滚方案
+4. 关键中间件需要设置监控和告警