# chatbot

**Repository Path**: wanquan9527/chatbot

## Basic Information

- **Project Name**: chatbot
- **Description**: 一个简单的客服机器人
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-13
- **Last Updated**: 2025-10-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Chatbot 项目

## 项目概述

本项目是一个基于 Go 语言开发的聊天机器人服务系统，提供智能问答、会话管理、知识库管理等功能。该系统采用模块化架构设计，包含多个独立但相互协作的服务模块，便于扩展和维护。

系统整体架构包括以下主要模块：

1. **chat-service**: 聊天机器人核心服务，处理用户消息并生成智能回复。
   - 功能：消息解析、意图识别、回复生成、会话管理。
   - 技术栈：Go、gRPC、NLP 模型集成。

2. **client-demo**: 客户端演示程序，用于测试和展示聊天机器人功能。
   - 功能：模拟用户输入、展示机器人回复、支持多平台。
   - 技术栈：Go、命令行交互。

3. **internal-api**: 内部 API 服务，提供与其他系统的集成接口。
   - 功能：RESTful API、数据同步、权限管理。
   - 技术栈：Go、Gin 框架。

4. **knowledge-base**: 知识库模块，存储和管理聊天机器人的知识数据。
   - 功能：知识存储、检索、更新、版本控制。
   - 技术栈：Go、SQLite 数据库。

5. **shared**: 共享模块，包含公共工具和库。
   - 功能：日志工具、配置管理、公共数据结构、数据库连接管理。
   - 技术栈：Go、通用工具库、GORM ORM框架。

## 系统架构

![系统架构图]()

各模块之间的关系：
- `chat-service` 作为前端服务，接收用户请求并通过调用其他服务提供回复
- `internal-api` 提供系统内部和外部系统的集成接口
- `knowledge-base` 存储和管理所有知识数据
- `client-demo` 提供一个简单的客户端演示
- `shared` 提供各模块共用的工具和配置

## 文件结构

```
.
├── .gitignore                    # Git 忽略文件配置
├── README.md                     # 项目说明文档
├── docker-compose.yml            # Docker 部署配置
├── go.mod                        # Go 模块依赖配置
├── go.sum                        # 依赖校验和
├── chat-service/                 # 聊天服务模块
│   ├── README.md                 # 聊天服务模块说明
│   ├── handler/                  # HTTP 处理器
│   ├── main.go                   # 服务入口
│   └── service/                  # 核心业务逻辑
├── client-demo/                  # 客户端演示模块
│   ├── README.md                 # 客户端演示模块说明
│   └── main.go                   # 客户端入口
├── internal-api/                 # 内部 API 服务模块
│   ├── README.md                 # API 服务模块说明
│   ├── handler/                  # API 处理器
│   ├── main.go                   # API 服务入口
│   ├── manager/                  # 业务管理器
│   ├── model/                    # 数据模型
│   └── service/                  # 业务服务
├── knowledge-base/               # 知识库模块
│   ├── README.md                 # 知识库模块说明
│   ├── handler/                  # 知识库处理器
│   ├── main.go                   # 知识库服务入口
│   ├── model/                    # 知识库数据模型
│   └── service/                  # 知识库服务
└── shared/                       # 共享模块
    ├── README.md                 # 共享模块说明
    ├── config/                   # 配置管理
    │   └── README.md             # 配置模块说明文档
    └── database/                 # 数据库连接管理
        ├── README.md             # 数据库模块说明文档
        ├── db.go                 # 数据库管理实现
        └── db_test.go            # 数据库管理测试
```

## 快速开始

### 前提条件

- 已安装 Go 1.24 或更高版本
- 已安装 Docker 和 Docker Compose
- 基本的命令行操作知识

### 使用 Docker 启动

1. 克隆项目：
   ```bash
   git clone <项目地址>
   cd customer-service-system
   ```

2. 启动所有服务：
   ```bash
   docker-compose up -d
   ```
   此命令会构建并启动所有服务容器，包括 knowledge-base、internal-api 和 chat-service。

3. 验证服务启动状态：
   ```bash
   docker-compose ps
   ```

4. 运行客户端演示：
   ```bash
   cd client-demo
   go run main.go
   ```

### 手动启动各服务

如果需要单独启动某个服务进行开发或测试，可以按照以下步骤操作：

1. 安装依赖：
   ```bash
   go mod download
   ```

2. 依次启动各服务：
   ```bash
   # 启动知识库服务
   cd knowledge-base
   go run main.go
   
   # 启动内部 API 服务
   cd ../internal-api
   go run main.go
   
   # 启动聊天服务
   cd ../chat-service
   go run main.go
   
   # 启动客户端演示
   cd ../client-demo
   go run main.go
   ```

## 环境变量配置

各服务支持通过环境变量进行配置，主要环境变量包括：

### knowledge-base
- `SERVICE_PORT`: 服务端口，默认 8001
- `DB_PATH`: 数据库文件路径，默认 knowledge.db

### internal-api
- `SERVICE_PORT`: 服务端口，默认 8002
- `DB_PATH`: 数据库文件路径，默认 internal_api.db
- `SCRIPT_DIR`: 脚本目录，默认 ./scripts
- `KNOWLEDGE_BASE_URL`: 知识库服务地址，默认 http://knowledge-base:8001

### chat-service
- `SERVICE_PORT`: 服务端口，默认 8000
- `KNOWLEDGE_BASE_URL`: 知识库服务地址，默认 http://knowledge-base:8001
- `INTERNAL_API_URL`: 内部 API 服务地址，默认 http://internal-api:8002

## 依赖管理

项目使用 Go Modules 管理依赖。主要依赖包括：

- [github.com/gin-gonic/gin](https://github.com/gin-gonic/gin): HTTP 框架
- [github.com/mattn/go-sqlite3](https://github.com/mattn/go-sqlite3): SQLite 数据库驱动
- [gorm.io/gorm](https://gorm.io/gorm): ORM 框架
- [gorm.io/driver/mysql](https://gorm.io/driver/mysql): MySQL 数据库驱动
- [github.com/stretchr/testify](https://github.com/stretchr/testify): 测试断言库

安装依赖：
```bash
go mod download
```

更新依赖：
```bash
go get -u
go mod tidy
```

## 开发指南

### 代码规范
- 遵循 Go 语言标准编码规范
- 所有公共函数和类型需要有适当的注释
- 代码提交前运行 `go fmt` 格式化代码

### 目录结构约定
- `handler`: 处理 HTTP 请求和响应
- `service`: 实现核心业务逻辑
- `model`: 定义数据模型和存储结构
- `manager`: 管理业务流程和多个服务的协作

## 测试

项目支持单元测试和集成测试。运行测试：
```bash
# 运行所有测试
go test ./...

# 运行特定模块的测试
cd <module-directory>
go test ./...
```

## 部署

### Docker 部署

项目提供了完整的 Docker 部署配置，使用以下命令进行部署：
```bash
docker-compose up -d --build
```

### 生产环境部署

对于生产环境，建议：
1. 使用专用的数据库服务（如 PostgreSQL）代替 SQLite
2. 配置适当的日志级别和日志存储
3. 设置反向代理（如 Nginx）处理 HTTPS 和负载均衡
4. 配置适当的监控和告警机制

## 常见问题

### 服务启动失败
- 检查端口是否被占用
- 检查环境变量配置是否正确
- 查看容器日志获取详细错误信息：`docker-compose logs <service-name>`

### 数据库连接问题
- 确保数据库文件路径正确且有写权限
- 检查数据库文件是否已损坏

## 贡献指南

欢迎提交 Pull Request 或 Issue。贡献代码前，请确保：

1. 代码符合项目规范
2. 添加了必要的测试用例
3. 运行测试确保所有测试通过
4. 更新了相关文档

## 许可证

[MIT License](LICENSE)