# spring-ai-chat

**Repository Path**: baidumap/spring-ai-chat

## Basic Information

- **Project Name**: spring-ai-chat
- **Description**: Spring AI
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-05-03
- **Last Updated**: 2025-07-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: AI, SpringAI

## README

# spring-ai-chat

#### 介绍
Spring AI

#### 软件架构
软件架构说明
https://docs.spring.io/spring-ai/reference/index.html

#### 安装教程

如何在本地运行这个项目？    
需要两个条件：       
1、本地电脑的8080端口没有被占用      
2、需要申请一个DeepSeek或openAi的appKey     
具体详见：
https://mp.weixin.qq.com/s/Aw9TLj2Yx7z-HTrEbkCJ5g

配置spring.ai.openai.api-key的一个小技巧： 
通过环境变量配置。
配置 spring.ai.openai.api-key（或其他相关配置项）通过环境变量是一种安全且灵活的方式，可以避免将敏感信息直接写入配置文件。以下是在 Windows 和 Unix-like 系统（如 macOS 或 Linux）中配置环境变量的详细步骤：
1. Windows 系统
   方法 1：通过系统属性设置环境变量
   打开系统属性：
   右键点击“此电脑”或“我的电脑”，选择“属性”。
   在左侧菜单中选择“高级系统设置”。
   在弹出的“系统属性”窗口中，点击“环境变量”按钮。
   添加环境变量：
   在“环境变量”窗口中，选择“用户变量”或“系统变量”（建议选择“用户变量”，这样只对当前用户生效）。
   点击“新建”按钮。
   在“变量名”中输入：SPRING_AI_OPENAI_API_KEY（注意：环境变量的名称通常使用大写，且不能包含点号，因此这里将点号替换为下划线）。
   在“变量值”中输入你的 OpenAI API 密钥。
   点击“确定”保存。
   验证环境变量：
   打开命令提示符，输入以下命令：
```shell
   echo %SPRING_AI_OPENAI_API_KEY%
```
   如果正确配置，应该会显示你的 API 密钥。
   方法 2：通过命令行临时设置环境变量
   如果你只需要在当前终端会话中使用环境变量，可以通过命令行临时设置：
```shell
   set SPRING_AI_OPENAI_API_KEY=你的密钥
```
   这种方法只对当前终端会话有效，关闭终端后变量会失效。
2. Unix-like 系统（macOS 或 Linux）
   方法 1：通过终端临时设置环境变量
   在终端中运行以下命令：
```shell
   export SPRING_AI_OPENAI_API_KEY="你的密钥"
```
   这种方法只对当前终端会话有效，关闭终端后变量会失效。
   方法 2：将环境变量添加到配置文件
   为了使环境变量在每次启动终端时自动加载，可以将其添加到以下配置文件之一：
   .bashrc（适用于 bash shell）：
```shell
   nano ~/.bashrc
```
   .zshrc（适用于 zsh shell，macOS 默认使用 zsh）：
```shell
nano ~/.zshrc
```
   .bash_profile（适用于 bash shell，登录时加载）：
```shell
nano ~/.bash_profile
```
   在文件末尾添加以下内容：
```shell
   export SPRING_AI_OPENAI_API_KEY="你的密钥"
```
   保存并退出编辑器后，运行以下命令使变量生效：
```shell
   source ~/.bashrc  # 或 source ~/.zshrc 或 source ~/.bash_profile
```
   方法 3：通过系统级环境变量
   如果你希望为所有用户设置环境变量，可以将变量添加到系统级配置文件中：
   Linux：
   /etc/profile
   /etc/environment
   macOS：
   /etc/profile
   编辑文件并添加以下内容：
```shell
   export SPRING_AI_OPENAI_API_KEY="你的密钥"
```
   保存后，重新登录或重启系统以使变量生效。
3. 在 Spring Boot 应用中使用环境变量
   在 Spring Boot 应用中，你可以通过以下方式读取环境变量：
   使用 @Value 注解
```java
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class OpenAiConfig {
@Value("${SPRING_AI_OPENAI_API_KEY}")
private String apiKey;

    public String getApiKey() {
        return apiKey;
    }
}
```
使用 Environment 接口
```java
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;

@Component
public class OpenAiConfig {
@Autowired
private Environment environment;

    public String getApiKey() {
        return environment.getProperty("SPRING_AI_OPENAI_API_KEY");
    }
}
```
4. 验证环境变量是否生效
   无论在 Windows 还是 Unix-like 系统中，你都可以通过以下方式验证环境变量是否生效：
   在终端中验证
   bash
```shell
   echo $SPRING_AI_OPENAI_API_KEY  # Unix-like 系统
   echo %SPRING_AI_OPENAI_API_KEY%  # Windows 系统
```
5. 重启IDEA



#### 使用说明

1.  xxxx
2.  xxxx
3.  xxxx

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)