# springAIChat

**Repository Path**: huhanrui/springAIChat

## Basic Information

- **Project Name**: springAIChat
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-16
- **Last Updated**: 2026-07-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Spring AI Chat Demo

基于 **Spring AI** + **OpenAI 协议** 构建的基础聊天 Demo，包含完整前后端实现，支持流式输出（SSE）。

## 技术栈

| 层级 | 技术 | 版本 |
|------|------|------|
| 后端框架 | Spring Boot | 3.2.5 |
| AI 框架 | Spring AI | 1.0.0 |
| 大模型接口 | OpenAI 兼容协议 | - |
| 前端 | 原生 HTML + JavaScript | - |
| JDK | Java | 17 |

## 功能特性

- ✅ **同步聊天接口**：`POST /api/chat`，一次性返回完整回复
- ✅ **流式聊天接口**：`GET /api/chat/stream`，基于 SSE 逐字输出
- ✅ **前端聊天界面**：开箱即用的聊天 UI，支持流式打字效果
- ✅ **OpenAI 协议兼容**：可接入任何兼容 OpenAI API 的大模型服务

## 项目结构

```
springAIChat/
├── src/main/java/com/xdap/springaichat/
│   ├── SpringAiChatApplication.java    # 启动类
│   └── controller/
│       └── ChatController.java         # 聊天接口（同步+流式）
├── src/main/resources/
│   ├── application.yml                 # 配置文件
│   └── static/
│       └── index.html                  # 前端聊天页面
└── pom.xml
```

## 快速开始

### 1. 环境要求

- JDK 17+
- Maven 3.6+
- 可用的 OpenAI 兼容 API Key（官方 / 第三方代理均可）

### 2. 配置 API 参数

修改 `src/main/resources/application.yml`：

```yaml
spring:
  ai:
    openai:
      api-key: sk-your-api-key-here      # 你的 API Key
      base-url: https://api.openai.com   # API 地址，国内可替换为代理地址
      chat:
        options:
          model: gpt-3.5-turbo           # 模型名称
          temperature: 0.7
```

也可通过环境变量配置：

```bash
export OPENAI_API_KEY=sk-xxx
export OPENAI_BASE_URL=https://api.openai.com
export OPENAI_CHAT_MODEL=gpt-3.5-turbo
```

### 3. 启动项目

```bash
mvn spring-boot:run
```

启动后访问：`http://localhost:8080`

## 接口说明

### 同步聊天

```bash
POST /api/chat
Content-Type: application/json

{
  "message": "你好"
}
```

响应：

```json
{
  "reply": "你好！有什么可以帮你的吗？"
}
```

### 流式聊天（SSE）

```bash
GET /api/chat/stream?message=你好
Accept: text/event-stream
```

以 `text/event-stream` 格式逐块返回回复内容。

## 扩展方向

- 接入多模型切换（GPT / Claude / 通义千问 / 文心一言等）
- 增加多轮对话上下文记忆（Chat Memory）
- 接入 RAG 检索增强生成
- 支持 Function Calling 函数调用
- 增加用户鉴权与会话管理

## License

MIT